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)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

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

No description

Parameters

$blockInfo
$c
$a

static getByName($blockName)

Returns a block.

Parameters

$blockName

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

No description

Parameters

$bID
$c
$a

getBlockRelationID()

No description

getBlockTypeID()

No description

getPermissionObjectIdentifier()

No description

getAreaHandle()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

getProxyBlock()

No description

setProxyBlock($block)

No description

Parameters

$block

display($view = 'view')

No description

Parameters

$view

isGlobal()

No description

getBlockCachedRecord()

No description

getBlockCachedOutput($area)

No description

Parameters

$area

isBlockInStack()

No description

getBlockCollectionObject()

No description

getOriginalCollection()

No description

int|null getBlockID()

Returns the block identifier (if available)

Return Value

int|null

setBlockCachedOutput($content, $lifetime, $area)

No description

Parameters

$content
$lifetime
$area

inc($file)

No description

Parameters

$file

getBlockPath()

No description

getPackageID()

No description

getPackageHandle()

No description

getBlockTypeHandle()

No description

revertToAreaPermissions()

No description

loadNewCollection($c)

No description

Parameters

$c

setBlockAreaObject($a)

No description

Parameters

$a

disableBlockVersioning()

No description

getNumChildren()

No description

getController()

No description

getInstance()

No description

getBlockTypeObject()

No description

getCollectionList()

No description

update($data)

No description

Parameters

$data

refreshBlockOutputCache()

No description

getBlockCollectionID()

No description

isActive()

No description

deactivate()

No description

activate()

No description

queueForDefaultsAliasing($addBlock, $queue)

No description

Parameters

$addBlock
$queue

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

No description

Parameters

$data
$queue
$includeThisBlock

alias($c)

No description

Parameters

$c

overrideAreaPermissions()

No description

overrideBlockTypeCacheSettings()

No description

enableBlockContainer()

No description

ignorePageThemeGridFrameworkContainer()

No description

overrideBlockTypeContainerSettings()

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

cacheBlockOutputForRegisteredUsers()

No description

getBlockOutputCacheLifetime()

No description

getCustomStyleSetID()

No description

getBlockAreaObject()

No description

bool move(Collection $collection, Area $area)

Move block to a new collection.

Parameters

Collection $collection
Area $area

Return Value

bool

duplicate($nc, $isCopyFromMasterCollectionPropagation = false)

No description

Parameters

$nc
$isCopyFromMasterCollectionPropagation

getCustomStyle($force = false)

No description

Parameters

$force

resetBlockContainerSettings()

No description

setCustomContainerSettings($enableBlockContainer)

No description

Parameters

$enableBlockContainer

resetCustomCacheSettings()

No description

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

No description

Parameters

$enabled
$enabledOnPost
$enabledForRegistered
$lifetime

setCustomStyleSet(StyleSet $set)

No description

Parameters

StyleSet $set

resetCustomStyle()

No description

__destruct()

No description

refreshCache()

Removes a cached version of the block.

setBlockCollectionObject($c)

No description

Parameters

$c

getBlockTypeName()

No description

getBlockUserID()

No description

string getBlockDateAdded()

Gets the date the block was added.

Return Value

string

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

getBlockDateLastModified()

No description

setBlockActionCollectionID($bActionCID)

No description

Parameters

$bActionCID

getBlockEditAction()

No description

_getBlockAction()

No description

int|false getBlockActionCollectionID()

No description

Return Value

int|false

The block action collection id or false if not found

getBlockUpdateInformationAction()

No description

getBlockUpdateCssAction()

No description

isEditable()

No description

delete($forceDelete = false)

No description

Parameters

$forceDelete

deleteBlock($forceDelete = false)

No description

Parameters

$forceDelete

isAlias($c = null)

No description

Parameters

$c

setOriginalBlockID($originalBID)

No description

Parameters

$originalBID

moveBlockToDisplayOrderPosition($afterBlock)

No description

Parameters

$afterBlock

getBlockDisplayOrder()

No description

setAbsoluteBlockDisplayOrder($do)

No description

Parameters

$do

doOverrideAreaPermissions()

No description

setCustomTemplate($template)

No description

Parameters

$template

updateBlockInformation($data)

No description

Parameters

$data

setName($name)

No description

Parameters

$name

refreshCacheAll()

No description

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

No description

Parameters

$node
$exportType

isAliasOfMasterCollection()

No description

getBlockName()

No description

getBlockFilename()

No description