class Block extends Object implements ObjectInterface (View source)

Properties

$error from Object
protected $cID
protected $arHandle
protected $c
protected $issID
protected $proxyBlock
protected $cbRelationID
protected $bActionCID
protected $cacheSettings
protected $cbOverrideBlockTypeCacheSettings
$a
protected $bFilename

Methods

loadError($error)

No description

from Object
isError()

No description

from Object
getError()

No description

from Object
setPropertiesFromArray($arr)

No description

from Object
static 
camelcase($file)

No description

from Object
static 
uncamelcase($string)

No description

from Object
static 
populateManually($blockInfo, $c, $a)

No description

static 
getByName($blockName)

Returns a block.

static 
getByID($bID, $c = null, $a = null)

No description

getBlockRelationID()

No description

getBlockTypeID()

No description

getAreaHandle()

No description

getProxyBlock()

No description

setProxyBlock($block)

No description

display($view = 'view')

No description

isGlobal()

No description

getBlockCachedRecord()

No description

getBlockCachedOutput($area)

No description

isBlockInStack()

No description

getBlockCollectionObject()

No description

getOriginalCollection()

No description

int|null
getBlockID()

Returns the block identifier (if available)

setBlockCachedOutput($content, $lifetime, $area)

No description

inc($file)

No description

getBlockPath()

No description

getPackageID()

No description

getPackageHandle()

No description

getBlockTypeHandle()

No description

revertToAreaPermissions()

No description

loadNewCollection($c)

No description

setBlockAreaObject($a)

No description

disableBlockVersioning()

No description

getNumChildren()

No description

getController()

No description

getInstance()

No description

getBlockTypeObject()

No description

getCollectionList()

No description

update($data)

No description

refreshBlockOutputCache()

No description

getBlockCollectionID()

No description

isActive()

No description

deactivate()

No description

activate()

No description

queueForDefaultsAliasing($addBlock, $queue)

No description

queueForDefaultsUpdate($data, $queue, $includeThisBlock = true)

No description

alias($c)

No description

overrideAreaPermissions()

No description

enableBlockContainer()

No description

getBlockCacheSettingsObject()

No description

cacheBlockOutput()

No description

disableBlockContainer()

Called by the scrapbook proxy block, this disables the original block container for the current request, because the scrapbook block takes care of rendering the container.

cacheBlockOutputOnPost()

No description

getBlockOutputCacheLifetime()

No description

getCustomStyleSetID()

No description

getBlockAreaObject()

No description

bool
move(Collection $collection, Area $area)

Move block to a new collection.

duplicate($nc, $isCopyFromMasterCollectionPropagation = false)

No description

getCustomStyle($force = false)

No description

resetBlockContainerSettings()

No description

setCustomContainerSettings($enableBlockContainer)

No description

resetCustomCacheSettings()

No description

setCustomCacheSettings($enabled, $enabledOnPost, $enabledForRegistered, $lifetime)

No description

setCustomStyleSet(StyleSet $set)

No description

resetCustomStyle()

No description

__destruct()

No description

refreshCache()

Removes a cached version of the block.

setBlockCollectionObject($c)

No description

getBlockTypeName()

No description

getBlockUserID()

No description

string
getBlockDateAdded()

Gets the date the block was added.

getBlockDateLastModified()

No description

setBlockActionCollectionID($bActionCID)

No description

getBlockEditAction()

No description

_getBlockAction()

No description

int|false
getBlockActionCollectionID()

No description

getBlockUpdateCssAction()

No description

isEditable()

No description

delete($forceDelete = false)

No description

deleteBlock($forceDelete = false)

No description

isAlias($c = null)

No description

setOriginalBlockID($originalBID)

No description

moveBlockToDisplayOrderPosition($afterBlock)

No description

getBlockDisplayOrder()

No description

setAbsoluteBlockDisplayOrder($do)

No description

doOverrideAreaPermissions()

No description

setCustomTemplate($template)

No description

updateBlockInformation($data)

No description

setName($name)

No description

refreshCacheAll()

No description

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

No description

isAliasOfMasterCollection()

No description

getBlockName()

No description

getBlockFilename()

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

static populateManually($blockInfo, $c, $a)

Parameters

$blockInfo
$c
$a

static getByName($blockName)

Returns a block.

Parameters

$blockName

static getByID($bID, $c = null, $a = null)

Parameters

$bID
$c
$a

getBlockRelationID()

getBlockTypeID()

getPermissionObjectIdentifier()

getAreaHandle()

getPermissionResponseClassName()

getPermissionAssignmentClassName()

getPermissionObjectKeyCategoryHandle()

getProxyBlock()

setProxyBlock($block)

Parameters

$block

display($view = 'view')

Parameters

$view

isGlobal()

getBlockCachedRecord()

getBlockCachedOutput($area)

Parameters

$area

isBlockInStack()

getBlockCollectionObject()

getOriginalCollection()

int|null getBlockID()

Returns the block identifier (if available)

Return Value

int|null

setBlockCachedOutput($content, $lifetime, $area)

Parameters

$content
$lifetime
$area

inc($file)

Parameters

$file

getBlockPath()

getPackageID()

getPackageHandle()

getBlockTypeHandle()

revertToAreaPermissions()

loadNewCollection($c)

Parameters

$c

setBlockAreaObject($a)

Parameters

$a

disableBlockVersioning()

getNumChildren()

getController()

getInstance()

getBlockTypeObject()

getCollectionList()

update($data)

Parameters

$data

refreshBlockOutputCache()

getBlockCollectionID()

isActive()

deactivate()

activate()

queueForDefaultsAliasing($addBlock, $queue)

Parameters

$addBlock
$queue

queueForDefaultsUpdate($data, $queue, $includeThisBlock = true)

Parameters

$data
$queue
$includeThisBlock

alias($c)

Parameters

$c

overrideAreaPermissions()

overrideBlockTypeCacheSettings()

enableBlockContainer()

ignorePageThemeGridFrameworkContainer()

overrideBlockTypeContainerSettings()

getBlockCacheSettingsObject()

cacheBlockOutput()

disableBlockContainer()

Called by the scrapbook proxy block, this disables the original block container for the current request, because the scrapbook block takes care of rendering the container.

cacheBlockOutputOnPost()

cacheBlockOutputForRegisteredUsers()

getBlockOutputCacheLifetime()

getCustomStyleSetID()

getBlockAreaObject()

bool move(Collection $collection, Area $area)

Move block to a new collection.

Parameters

Collection $collection
Area $area

Return Value

bool

duplicate($nc, $isCopyFromMasterCollectionPropagation = false)

Parameters

$nc
$isCopyFromMasterCollectionPropagation

getCustomStyle($force = false)

Parameters

$force

resetBlockContainerSettings()

setCustomContainerSettings($enableBlockContainer)

Parameters

$enableBlockContainer

resetCustomCacheSettings()

setCustomCacheSettings($enabled, $enabledOnPost, $enabledForRegistered, $lifetime)

Parameters

$enabled
$enabledOnPost
$enabledForRegistered
$lifetime

setCustomStyleSet(StyleSet $set)

Parameters

StyleSet $set

resetCustomStyle()

__destruct()

refreshCache()

Removes a cached version of the block.

setBlockCollectionObject($c)

Parameters

$c

getBlockTypeName()

getBlockUserID()

string getBlockDateAdded()

Gets the date the block was added.

Return Value

string date formated like: 2009-01-01 00:00:00

getBlockDateLastModified()

setBlockActionCollectionID($bActionCID)

Parameters

$bActionCID

getBlockEditAction()

_getBlockAction()

int|false getBlockActionCollectionID()

Return Value

int|false The block action collection id or false if not found

getBlockUpdateInformationAction()

getBlockUpdateCssAction()

isEditable()

delete($forceDelete = false)

Parameters

$forceDelete

deleteBlock($forceDelete = false)

Parameters

$forceDelete

isAlias($c = null)

Parameters

$c

setOriginalBlockID($originalBID)

Parameters

$originalBID

moveBlockToDisplayOrderPosition($afterBlock)

Parameters

$afterBlock

getBlockDisplayOrder()

setAbsoluteBlockDisplayOrder($do)

Parameters

$do

doOverrideAreaPermissions()

setCustomTemplate($template)

Parameters

$template

updateBlockInformation($data)

Parameters

$data

setName($name)

Parameters

$name

refreshCacheAll()

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

Parameters

$node
$exportType

isAliasOfMasterCollection()

getBlockName()

getBlockFilename()