Class Collection

Description
Description | Descendents | Vars (details) | Methods (details)

A generic object that holds blocks and maps them to areas.

Located in /models/collection.php (line 25) 

Object
   |
   --Collection
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class Page The page object in Concrete encapsulates all the functionality used by a typical page and their contents including blocks, page metadata, page permissions.
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
mixed $attributes
mixed $cID
Method Summary
Description | Descendants | Vars (details) | Methods (details)
static void getByHandle ( $handle)
static Collection getByID (int $cID, [mixed $version = 'RECENT'])
void __destruct ()
void add ( $data)
void addAreaLayout ( $area,  $layout, [ $addToPosition = 'bottom'])
void addAttribute ( $ak,  $value)
void addBlock ( $bt,  $a,  $data)
void clearAttribute ( $ak)
void clearCollectionAttributes ([ $retainAKIDs = array()])
void delete ()
void deleteAreaLayout ( $area,  $layout, [ $deleteBlocks = 0])
void duplicate ()
void getArea ( $arHandle)
void getAreaCustomStyleRule ( $area)
void getAttribute ( $akHandle)
void getAttributeValueObject ( $ak, [ $createIfNotFound = false])
void getBlocks ([ $arHandle = false])
void getCollectionAreaDisplayOrder ( $arHandle, [ $ignoreVersions = false])
void getCollectionAttributeValue ( $ak)
void getCollectionDateAdded ([ $mask = null], [ $type = 'system'])
void getCollectionDateLastModified ([ $mask = null], [ $type = "system"])
void getCollectionHandle ()
void getCollectionID ()
void getCollectionTypeID ()
void getSetCollectionAttributes ()
void getVersionID ()
void getVersionObject ()
void getVersionToModify ()
void hasAliasedContent ()
void loadVersionObject ([ $cvID = "ACTIVE"])
void markModified ()
void outputCustomStyleHeaderItems ([ $return = false])
void refreshCache ()
void reindex ([ $index = false])
void rescanDisplayOrder ( $areaName)
void resetAreaCustomStyle ( $area)
void setAreaCustomStyle ( $area,  $csr)
void setAttribute ( $ak,  $value)
void updateAreaLayoutId ([ $cvalID = 0], [ $newLayoutId = 0])
void _cloneVersion ( $versionComments)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $attributes = array() (line 28)
  • access: protected
mixed $cID (line 27)
  • access: public
Methods
Description | Descendents | Vars (details) Methods (details)
static getByHandle (line 596)
  • access: public
void getByHandle ( $handle)
  • $handle
static getByID (line 576)
  • access: public
Collection getByID (int $cID, [mixed $version = 'RECENT'])
  • int $cID
  • mixed $version: 'RECENT'|'ACTIVE'|version id
Redefined in descendants as:
Destructor __destruct (line 322)
  • access: public
void __destruct ()
Redefined in descendants as:
add (line 723)
  • access: public
void add ( $data)
  • $data
Redefined in descendants as:
  • Page::add() : Adds a new page of a certain type, using a passed associate array to setup value. $data may contain any or all of the following:
  • SinglePage::add()
addAreaLayout (line 451)
  • access: public
void addAreaLayout ( $area,  $layout, [ $addToPosition = 'bottom'])
  • $area
  • $layout
  • $addToPosition
addAttribute (line 236)
void addAttribute ( $ak,  $value)
  • $ak
  • $value
addBlock (line 692)
  • access: public
void addBlock ( $bt,  $a,  $data)
  • $bt
  • $a
  • $data
clearAttribute (line 215)
  • access: public
void clearAttribute ( $ak)
  • $ak
clearCollectionAttributes (line 138)
  • access: public
void clearCollectionAttributes ([ $retainAKIDs = array()])
  • $retainAKIDs
delete (line 765)
  • access: public
void delete ()
Redefined in descendants as:
deleteAreaLayout (line 523)
  • access: public
void deleteAreaLayout ( $area,  $layout, [ $deleteBlocks = 0])
  • $area
  • $layout
  • $deleteBlocks
duplicate (line 787)
  • access: public
void duplicate ()
Redefined in descendants as:
getArea (line 242)
void getArea ( $arHandle)
  • $arHandle
getAreaCustomStyleRule (line 414)
  • access: public
void getAreaCustomStyleRule ( $area)
  • $area
getAttribute (line 121)
  • access: public
void getAttribute ( $akHandle)
  • $akHandle
getAttributeValueObject (line 175)
  • access: public
void getAttributeValueObject ( $ak, [ $createIfNotFound = false])
  • $ak
  • $createIfNotFound
getBlocks (line 643)
  • access: public
void getBlocks ([ $arHandle = false])
  • $arHandle
getCollectionAreaDisplayOrder (line 326)
void getCollectionAreaDisplayOrder ( $arHandle, [ $ignoreVersions = false])
  • $arHandle
  • $ignoreVersions
getCollectionAttributeValue (line 127)
  • access: public
void getCollectionAttributeValue ( $ak)
  • $ak
getCollectionDateAdded (line 302)
void getCollectionDateAdded ([ $mask = null], [ $type = 'system'])
  • $mask
  • $type
getCollectionDateLastModified (line 280)
void getCollectionDateLastModified ([ $mask = null], [ $type = "system"])
  • $mask
  • $type
getCollectionHandle (line 298)
void getCollectionHandle ()
Redefined in descendants as:
getCollectionID (line 276)
void getCollectionID ()
getCollectionTypeID (line 542)
void getCollectionTypeID ()
Redefined in descendants as:
getSetCollectionAttributes (line 226)
  • access: public
void getSetCollectionAttributes ()
getVersionID (line 317)
void getVersionID ()
getVersionObject (line 294)
void getVersionObject ()
getVersionToModify (line 38)
void getVersionToModify ()
hasAliasedContent (line 248)
void hasAliasedContent ()
loadVersionObject (line 31)
void loadVersionObject ([ $cvID = "ACTIVE"])
  • $cvID
markModified (line 753)
  • access: public
void markModified ()
outputCustomStyleHeaderItems (line 362)

Retrieves all custom style rules that should be inserted into the header on a page, whether they are defined in areas

or blocks

  • access: public
void outputCustomStyleHeaderItems ([ $return = false])
  • $return
refreshCache (line 625)
  • access: public
void refreshCache ()
reindex (line 153)
  • access: public
void reindex ([ $index = false])
  • $index
rescanDisplayOrder (line 547)
  • access: public
void rescanDisplayOrder ( $areaName)
  • $areaName
resetAreaCustomStyle (line 431)
  • access: public
void resetAreaCustomStyle ( $area)
  • $area
setAreaCustomStyle (line 441)
  • access: public
void setAreaCustomStyle ( $area,  $csr)
  • $area
  • $csr
setAttribute (line 204)
  • access: public
void setAttribute ( $ak,  $value)
  • $ak
  • $value
updateAreaLayoutId (line 511)
  • access: public
void updateAreaLayoutId ([ $cvalID = 0], [ $newLayoutId = 0])
  • $cvalID
  • $newLayoutId
_cloneVersion (line 56)
void _cloneVersion ( $versionComments)
  • $versionComments

Documentation generated on Thu, 15 Sep 2011 16:36:19 -0700 by phpDocumentor 1.4.1