This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_Block

A block object is a generic bit of content added to a collection. All blocks of any type share certain bits of metadata and the block object takes care of setting these.

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_Block

Direct known subclasses

Block

Package: Blocks
Category: Concrete
Copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Andrew Embler andrew@concrete5.org
Located at core/models/block.php

Methods summary

public static
# populateManually( $blockInfo, $c, $a )
public
public static
# getByID( $bID, $c = null, $a = null )
public static
# getByName( $globalBlockName )

Returns a global block

public
# setProxyBlock( $block )
public
public
# display( $view = 'view', $args = array() )
public
# isAlias( $c = null )
public
public
# isGlobal( )
public
public
public
public
# setBlockCachedOutput( $content, $lifetime, $area )
public
# inc( $file )
public
public
public
protected
public
public
public
public
public
public
# passThruBlock( $method )
public
public
public
public
# update( $data )
public
# isActive( )
public
public
# activate( )
public
public
public
# updateBlockName( $name, $force = 0 )
public
# alias( $c )
public
# move( $nc, $area )

Moves a block onto a new page and into a new area. Does not change any data about the block otherwise

public
# duplicate( $nc )
public
public
public
# resetBlockCustomStyle( $updateAll = false )
public
public
# setBlockCustomStyle( $csr, $updateAll = false )
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public string
# getBlockDateAdded( string $type = 'system' )

Gets the date the block was added if user is specified, returns in the current user's timezone

public
public
public
# setBlockActionCollectionID( $bActionCID )
public integer|false
# getBlockActionCollectionID( )
public
public
public
public
public
public
public
public
public
# delete( $forceDelete = false )
public
# deleteBlock( $forceDelete = false )
public
# setOriginalBlockID( $originalBID )
public
public
public
public
# setCustomTemplate( $template )
public
# setName( $name )
public
public
# refreshCache( )

Removes a cached version of the block

public
public
# export( $node, $exportType = 'full' )
public
public

Properties summary

public $cID
#
public $arHandle
#
public $c
#
protected $csrID
#
protected boolean $proxyBlock
# false
protected boolean $bIncludeInComposerIsSet
# false

Properties inherited from Concrete5_Library_Object

$error