Block
class Block extends ConcreteObject implements ObjectInterface (View source)
Properties
| $error | from ConcreteObject | ||
| protected | $cID | ||
| protected | $arHandle | ||
| protected | $c | ||
| protected | $issID | ||
| protected | $proxyBlock | ||
| protected | $cbRelationID | ||
| protected | $bActionCID | ||
| protected | $cacheSettings | ||
| protected | $cbOverrideBlockTypeCacheSettings | ||
| $a | |||
| protected | $bFilename |
Methods
No description
Returns a block.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Returns the block identifier (if available)
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
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.
No description
No description
No description
No description
No description
Move block to a new collection.
No description
No description
No description
No description
No description
No description
No description
No description
Removes a cached version of the block.
No description
No description
No description
Gets the date the block was added.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
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
getPermissionObjectIdentifier()
No description
getAreaHandle()
No description
getPermissionResponseClassName()
No description
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
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
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.
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
getBlockUpdateInformationAction()
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