Collection

The collection ID

the collection version ('RECENT' for the most recent version, 'ACTIVE' for the currently published version, a falsy value to not load the collection version, or an integer to retrieve a specific version ID)

If the collection is not found, you'll get an empty Collection instance

the collection handle

return NULL if $handle is the handle of an existing page

returns the number of reindexed pages

{

@var int|null $cID The ID of the collection to create (if unspecified or NULL: database autoincrement value)
@var string $handle The collection handle (default: NULL)
@var string $name The collection name (default: empty string)
@var string $cDescription The collection description (default: NULL)
@var string $cDatePublic The collection publish date/time in format 'YYYY-MM-DD hh:mm:ss' (default: now)
@var bool $cvIsApproved Is the collection version approved (default: true)
@var bool $cvIsNew Is the collection to be considered "new"? (default: true if $cvIsApproved is false, false if $cvIsApproved is true)
@var int|null $pThemeID The collection theme ID (default: NULL)
@var int|null $pTemplateID The collection template ID (default: NULL)
@var int|null $uID The ID of the collection author (default: NULL)

}

2017-12-31 23:59:59

2017-12-31 23:59:59

{

@var int|null $cID The ID of the collection to create (if unspecified or NULL: database autoincrement value)
@var string $handle The collection handle (default: NULL)
@var string $name The collection name (default: empty string)
@var string $cDescription The collection description (default: NULL)
@var string $cDatePublic The collection publish date/time in format 'YYYY-MM-DD hh:mm:ss' (default: now)
@var bool $cvIsApproved Is the collection version approved (default: true)
@var bool $cvIsNew Is the collection to be considered "new"? (default: true if $cvIsApproved is false, false if $cvIsApproved is true)
@var int|null $pTemplateID The collection template ID (default: NULL)
@var int|null $uID The ID of the collection author (default: NULL)

}

the collection version ('RECENT' for the most recent version, 'ACTIVE' for the currently published version, or an integer to retrieve a specific version ID)

Example: 'Version 2'

the IndexedSearch instance that indexes the collection content (if falsy: we'll create a new instance of it)

Set to true to always reindex the collection immediately (otherwise we'll look at the concrete.page.search.always_reindex configuration key)

Return false if the collection can't be indexed, NULL otherwise

the attribute key (or its handle)

an attribute value object, or the data needed by the attribute controller to create the attribute value object

the attribute key (or its handle)

makes The format of the attribute value

When you need the raw attribute value or object, use this:
<code>
$c = Page::getCurrentPage();
$attributeValue = $c->getAttribute('attribute_handle');
</code>

If you need the formatted output supported by some attribute, use this:
<code>
$c = Page::getCurrentPage();
$attributeValue = $c->getAttribute('attribute_handle', 'display');
</code>

An attribute type like "date" will then return the date in the correct format just like other attributes will show you a nicely formatted output and not just a simple value or object.

the attribute key (or its handle)

a list of attribute key IDs to keep (their values won't be deleted)

the attribute key (or its handle)

the handle of the area

the area for which you want the custom styles

Set to true to retrieve a CustomStyle even if the area does not define any custom style

return NULL if the area does not have any custom style and $force is false, a CustomStyle instance otherwise

set to true to return the HTML that defines the styles, false to add it to the current View instance

the collection that has been modified

return false if the other collection is already associated to this collection, NULL otherwise

If a global area is modified inside this collection, you need to call $page->relateVersionEdits($globalArea)

The handle if the area (or falsy to get all the blocks in the collection)

The handle if the area (or falsy to get all the blocks in the collection version)

Return a list of arrays, each one is a dictionary like ['bID' => , 'arHandle' => ]

the type of block to be added

the area instance (or its handle) to which the block should be added to

The data of the block. This data depends on the specific block type. Common values are: 'uID' to specify the ID of the author (if not specified: we'll use the current user), 'bName' to specify the block name.

The handle of the area

Set to true to ignore the collection version

the handle of the area to be processed

the comments to be associated to the new Version

set to true to create a Version without any blocks/area styles, false to clone them too