Docs For Class Area

Description

An area object is used within templates to mark certain portions of pages as editable and containers of dynamic content

author: Andrew Embler <andrew@concrete5.org>
copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
license: MIT License

Object
   |
   --Area

Variable Summary

mixed $areaBlocksArray

mixed $arHandle

mixed $arID

mixed $attributes

mixed $c

mixed $cID

mixed $customTemplateArray

mixed $enclosingEnd

mixed $enclosingStart

mixed $firstRunBlockTypeHandle

mixed $maximumBlocks

mixed $ratingThreshold

mixed $showControls

mixed $totalBlocks

Method Summary

Area Area ( $arHandle)

void __destruct ()

void areaAcceptsBlocks ()

void disableControls ()

void display ( &$c, [ $alternateBlockArray = null])

void get ( &$c, $arHandle)

void getAddBlockTypes ( &$c, &$ap)

void getAreaBlocksArray ( &$c)

void getAreaCollectionInheritID ()

void getAreaCollectionObject ()

void getAreaHandle ()

void getAreaID ()

void getAreaLayouts ( $c)

void getAreaUpdateAction ([ $task = 'update'], [ $alternateHandler = null])

void getAttribute ( $attr)

void getCollectionID ()

void getCustomTemplates ()

void getHandleList ()

void getMaximumBlocks ()

void getOrCreate ( &$c, $arHandle)

void getTotalBlocksInArea ([Page $c = false])

void overrideCollectionPermissions ()

void rescanAreaPermissionsChain ()

void rescanSubAreaPermissions ([ $cIDToCheck = null])

void rescanSubAreaPermissionsMasterCollection ( $masterCollection)

void revertToPagePermissions ()

void setAttribute ( $attr, $val)

void setBlockLimit ( $num)

void setBlockWrapperEnd ( $html)

void setBlockWrapperStart ( $html)

void setCustomTemplate ( $btHandle, $temp)

void update ()

Variables

mixed $areaBlocksArray (line 44)

access: public

mixed $arHandle (line 26)

access: public

mixed $arID (line 26)

access: public

mixed $attributes = array() (line 36)

access: public

mixed $c (line 27)

access: public

mixed $cID (line 26)

access: public

mixed $customTemplateArray = array() (line 32)

access: public

mixed $enclosingEnd = '' (line 39)

access: public

mixed $enclosingStart = '' (line 38)

access: public

mixed $firstRunBlockTypeHandle (line 33)

access: public

mixed $maximumBlocks = -1 (line 31)

access: public

mixed $ratingThreshold = 0 (line 34)

access: public

mixed $showControls = true (line 35)

access: public

mixed $totalBlocks = 0 (line 43)

access: public

Methods

Constructor Area (line 51)

Area Area ( $arHandle)

$arHandle

Destructor __destruct (line 242)

access: public

void __destruct ()

areaAcceptsBlocks (line 99)

void areaAcceptsBlocks ()

disableControls (line 95)

void disableControls ()

display (line 331)

void display ( &$c, [ $alternateBlockArray = null])

&$c
$alternateBlockArray

get (line 118)

void get ( &$c, $arHandle)

&$c
$arHandle

getAddBlockTypes (line 193)

void getAddBlockTypes ( &$c, &$ap)

&$c
&$ap

getAreaBlocksArray (line 173)

void getAreaBlocksArray ( &$c)

&$c

getAreaCollectionInheritID (line 78)

void getAreaCollectionInheritID ()

getAreaCollectionObject (line 60)

void getAreaCollectionObject ()

getAreaHandle (line 62)

void getAreaHandle ()

getAreaID (line 61)

void getAreaID ()

getAreaLayouts (line 428)

Load all layout grid objects for a collection

void getAreaLayouts ( $c)

$c

getAreaUpdateAction (line 105)

void getAreaUpdateAction ([ $task = 'update'], [ $alternateHandler = null])

$task
$alternateHandler

getAttribute (line 91)

void getAttribute ( $attr)

$attr

getCollectionID (line 59)

void getCollectionID ()

getCustomTemplates (line 63)

void getCustomTemplates ()

getHandleList (line 202)

access: public

void getHandleList ()

getMaximumBlocks (line 103)

void getMaximumBlocks ()

getOrCreate (line 146)

void getOrCreate ( &$c, $arHandle)

&$c
$arHandle

getTotalBlocksInArea (line 70)

Returns the total number of blocks in an area.

void getTotalBlocksInArea ([Page $c = false])

Page $c: must be passed if the display() method has not been run on the area object yet.

overrideCollectionPermissions (line 77)

void overrideCollectionPermissions ()

rescanAreaPermissionsChain (line 246)

void rescanAreaPermissionsChain ()

rescanSubAreaPermissions (line 297)

void rescanSubAreaPermissions ([ $cIDToCheck = null])

$cIDToCheck

rescanSubAreaPermissionsMasterCollection (line 316)

void rescanSubAreaPermissionsMasterCollection ( $masterCollection)

$masterCollection

revertToPagePermissions (line 215)

void revertToPagePermissions ()

setAttribute (line 87)

void setAttribute ( $attr, $val)

$attr
$val

setBlockLimit (line 83)

Sets the total number of blocks an area allows. Does not limit by type.

access: public

void setBlockLimit ( $num)

$num

setBlockWrapperEnd (line 480)

Set HTML that automatically prints after any blocks contained within the area

void setBlockWrapperEnd ( $html)

$html

setBlockWrapperStart (line 473)

Specify HTML to automatically print before blocks contained within the area

void setBlockWrapperStart ( $html)

$html

setCustomTemplate (line 64)

void setCustomTemplate ( $btHandle, $temp)

$btHandle
$temp

update (line 484)

void update ()