SubArea
class SubArea extends Area (View source)
Constants
| AREA_SUB_DELIMITER |
|
Properties
| $error | from ConcreteObject | ||
| int | $cID | from Area | |
| int | $arID | from Area | |
| string | $arHandle | from Area | |
| Page | $c | from Area | |
| int | $maximumBlocks | limits the number of blocks in the area. |
from Area |
| protected bool | $showControls | from Area | |
| string | $enclosingStart | from Area | |
| string | $enclosingEnd | from Area | |
| Block[] | $areaBlocksArray | Array of Blocks within the current area. |
from Area |
| protected bool | $arIsLoaded | from Area | |
| protected bool | $arUseGridContainer | from Area | |
| protected string | $arDisplayName | from Area | |
| protected int | $arGridMaximumColumns | from Area | |
| protected bool | $arOverrideCollectionPermissions | from Area | |
| protected int | $arInheritPermissionsFromAreaOnCID | from Area | |
| protected array | $arCustomTemplates | from Area | |
| protected Block | $parentBlock |
Methods
No description
Returns the amount of actual blocks in the area, does not exclude core blocks or layouts, does not recurse.
check if the area has permissions that override the page's permissions.
Sets the total number of blocks an area allows. Does not limit by type.
Gets the Area object for the given page and area handle.
Get all of the blocks within the current area for a given page.
This function removes all permissions records for the current Area and sets it to inherit from the Page permissions.
Rescans the current Area's permissions ensuring that it's inheriting permissions properly up the chain.
works a lot like rescanAreaPermissionsChain() but it works down. This is typically only called when we update an area to have specific permissions, and all areas that are on pagesbelow it with the same handle, etc... should now inherit from it.
similar to rescanSubAreaPermissions, but for those who have setup their pages to inherit master collection permissions.
displays the Area in the page ex: $a = new Area('Main'); $a->display($c);.
Specify HTML to automatically print before blocks contained within the area.
Set HTML that automatically prints after any blocks contained within the area.
Sets a custom block template for blocks of a type specified by the btHandle Note, these can be stacked. For example $a->setCustomTemplate('image', 'banner'); $a->setCustomTemplate('content', 'masthead_content');.
returns an array of custom templates defined for this Area object.
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
in
Area at line 108
setAreaDisplayName(string $arDisplayName)
No description
in
Area at line 118
bool
showControls()
Returns whether or not controls are to be displayed.
in
Area at line 132
forceControlsToDisplay()
Force enables controls to show.
in
Area at line 140
setAreaGridMaximumColumns(int $cspan)
No description
in
Area at line 150
int|null
getAreaGridMaximumColumns()
No description
in
Area at line 175
final
enableGridContainer()
Enable Grid containers.
in
Area at line 183
bool
isGridContainerEnabled()
No description
in
Area at line 191
string
getAreaDisplayName()
No description
__construct($arHandle, string $arParentHandle, int $arParentID)
No description
in
Area at line 216
getPermissionObjectIdentifier()
No description
in
Area at line 224
getPermissionResponseClassName()
No description
in
Area at line 232
getPermissionAssignmentClassName()
No description
in
Area at line 240
getPermissionObjectKeyCategoryHandle()
No description
in
Area at line 250
int
getCollectionID()
returns the Collection's cID.
in
Area at line 262
Page
getAreaCollectionObject()
returns the Collection object for the current Area.
in
Area at line 272
bool
isGlobalArea()
whether or not it's a global area.
in
Area at line 282
int
getAreaID()
returns the arID of the current area.
in
Area at line 292
string
getAreaHandle()
returns the handle for the current area.
in
Area at line 303
int
getTotalBlocksInArea(Page $c = false)
Returns the total number of blocks in an area.
in
Area at line 344
int
getTotalBlocksInAreaEditMode()
Returns the amount of actual blocks in the area, does not exclude core blocks or layouts, does not recurse.
in
Area at line 358
bool
overrideCollectionPermissions()
check if the area has permissions that override the page's permissions.
in
Area at line 366
int
getAreaCollectionInheritID()
No description
in
Area at line 376
setBlockLimit(int $num)
Sets the total number of blocks an area allows. Does not limit by type.
in
Area at line 384
disableControls()
disables controls for the current area.
in
Area at line 394
int
getMaximumBlocks()
gets the maximum allowed number of blocks, -1 if unlimited.
in
Area at line 402
refreshCache(Page $c)
No description
in
Area at line 417
final static Area
get(Page $c, string $arHandle)
Gets the Area object for the given page and area handle.
Area
create(Page $c, string $arHandle)
No description
in
Area at line 488
static string
getAreaHandleFromID($arID)
No description
in
Area at line 512
Block[]
getAreaBlocksArray(Page|bool $c = false)
Get all of the blocks within the current area for a given page.
in
Area at line 529
static array
getHandleList()
Gets a list of all areas.
in
Area at line 549
static Area[]
getListOnPage(Page $c)
No description
in
Area at line 577
revertToPagePermissions()
This function removes all permissions records for the current Area and sets it to inherit from the Page permissions.
in
Area at line 603
__destruct()
No description
in
Area at line 613
bool
rescanAreaPermissionsChain()
Rescans the current Area's permissions ensuring that it's inheriting permissions properly up the chain.
in
Area at line 687
rescanSubAreaPermissions(int $cIDToCheck = null)
works a lot like rescanAreaPermissionsChain() but it works down. This is typically only called when we update an area to have specific permissions, and all areas that are on pagesbelow it with the same handle, etc... should now inherit from it.
in
Area at line 723
bool
rescanSubAreaPermissionsMasterCollection(Page $masterCollection)
similar to rescanSubAreaPermissions, but for those who have setup their pages to inherit master collection permissions.
in
Area at line 748
static Area
getOrCreate(Page $c, string $arHandle)
No description
in
Area at line 762
load(Page $c)
No description
in
Area at line 787
protected Block[]
getAreaBlocks()
No description
in
Area at line 813
bool
display(Page $c = false, Block[] $alternateBlockArray = null)
displays the Area in the page ex: $a = new Area('Main'); $a->display($c);.
export(SimpleXMLElement $p, Page $page)
No description
in
Area at line 897
setBlockWrapperStart(string $html)
Specify HTML to automatically print before blocks contained within the area.
in
Area at line 907
setBlockWrapperEnd(string $html)
Set HTML that automatically prints after any blocks contained within the area.
in
Area at line 912
overridePagePermissions()
No description
in
Area at line 952
setCustomTemplate(string $btHandle, string $view)
Sets a custom block template for blocks of a type specified by the btHandle Note, these can be stacked. For example $a->setCustomTemplate('image', 'banner'); $a->setCustomTemplate('content', 'masthead_content');.
array
getAreaCustomTemplates($include_parent_templates = true)
returns an array of custom templates defined for this Area object.
setSubAreaBlockObject(Block $block)
No description
bool|Area|mixed|null
getSubAreaParentPermissionsObject()
No description
Block
getSubAreaBlockObject()
No description
int
getAreaParentID()
No description
delete()
No description