1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Page
  7. \
  8. Page

Page

class Page extends Collection implements CategoryMemberInterface, ObjectInterface, ObjectInterface, AssignableObjectInterface, TreeInterface, SiteAggregateInterface, ExportableInterface (View source)

The page object in Concrete encapsulates all the functionality used by a typical page and their contents including blocks, page metadata, page permissions.

Traits

AssignableObjectTrait

Properties

$error from  ConcreteObject
int|null deprecated $cID

The collection ID.

 from  Collection
protected Version|null $vObj

The collection version object.

 from  Collection
protected string|null $cHandle

The collection handle.

 from  Collection
protected string|null $cDateAdded

The date/time when the collection has been created.

 from  Collection
protected string|null $cDateModified

The date/time when the collection was last modified.

 from  Collection
protected array $attributes from  Collection
Tree|null deprecated $siteTree
protected PageController|null $controller

The page controller.
protected int[]|null $blocksAliasedFromMasterCollection

The list of block IDs that are alias.
int|null $cCheckedOutUID

The user id of the user that has checked out the page.
protected int|null $cPointerOriginalID

The original cID of a page (if it's a page alias).
protected int|null $cPointerOriginalSiteTreeID

The original siteTreeID of a page (if it's a page alias).
$cPointerExternalLink

The link for the aliased page.
protected bool|int|null $cPointerExternalLinkNewWindow

Should the alias link to be opened in a new window?
protected bool|int|null $isMasterCollection

Is this page a page default?
protected int|null $cInheritPermissionsFromCID

The ID of the page from which this page inherits permissions from.
protected bool $cIsSystemPage

Is this a system page?
protected int|null $siteTreeID

The site tree ID.
int|null deprecated $pkgID
string|false|null deprecated $pkgHandle
int|null deprecated $cPointerID
int|bool|null deprecated $cIsDraft
int|bool|null deprecated $cIsActive
string|null deprecated $cFilename
int|null deprecated $ptID
int|null deprecated $cDisplayOrder
string|null deprecated $cInheritPermissionsFrom
bool|int|null deprecated $cOverrideTemplatePermissions
int|bool|null deprecated $cIsTemplate
int|null deprecated $uID
string|null deprecated $cPath
int|null deprecated $cParentID
int|null deprecated $cChildren
int|null deprecated $cCacheFullPageContent
private string|null $customAliasName

The custom name of the alias page.
private string|null $aliasHandle

The handle of the alias page
protected bool|null $hasCustomSummaryTemplateCollection

Whether this page has a custom summary template collection assigned to it. If null/false, then we just use any that are found to fit the criteria.
protected $cCacheFullPageContentOverrideLifetime
protected $cCacheFullPageContentLifetimeCustom

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
__destruct()

Destruct the class instance.

from  Collection
static Collection
getByID(int $cID, string|int|false $version = 'RECENT')

Get a collection by ID.

static Collection|null
getByHandle(string $handle)

Get a Collection by handle (provided that it's not a Page handle).

from  Collection
static int
reindexPendingPages()

(Re)Index all the collections that are marked as to be (re)indexed.

from  Collection
static Collection
createCollection(array $data)

Create a new Collection instance.

from  Collection
int|null
getCollectionID()

Get the collection ID.

from  Collection
string|null
getCollectionHandle()

Get the collection handle.

string|null
getCollectionDateLastModified()

Get the date/time when the collection was last modified.

from  Collection
string|null
getCollectionDateAdded()

Get the date/time when the collection has been created.

from  Collection
int
getVersionID()

Get the ID of the currently loaded version.

from  Collection
Version|null
getVersionObject()

Get the currently loaded version object.

from  Collection
Collection
addCollection(array $data)

Create a new Collection instance, using the same theme as this instance (if it's a Page instance).

from  Collection
loadVersionObject(string|int $cvID = 'ACTIVE')

Load a specific collection version (you can retrieve it with the getVersionObject() method).

from  Collection
$this|Page
getVersionToModify()

Get the Collection instance to be modified (this instance if it's a new or master Collection, a clone otherwise).

from  Collection
string
getNextVersionComments()

Get the automatic comment for the next collection version.

from  Collection
reindex($doReindexImmediately = true)

No description

from  Collection
PageValue
setAttribute(string|CollectionKey $ak, AbstractValue|mixed $value, bool $doReindexImmediately = true)

Set the attribute value for the currently loaded collection version.

from  Collection
mixed|null
getAttribute(string|CollectionKey $akHandle, string|false $displayMode = false)

Return the value of the attribute with the handle $akHandle of the currently loaded version (if it's loaded).

from  Collection
PageValue|null
getAttributeValueObject(string|CollectionKey $akHandle, bool $createIfNotExists = false)

Return the attribute value object with the handle $akHandle of the currently loaded version (if it's loaded).

from  Collection
clearCollectionAttributes(int[] $retainAKIDs = [])

Delete the values of the attributes associated to the currently loaded collection version.

from  Collection
clearAttribute(string|CollectionKey $ak, bool $doReindexImmediately = true)

Delete the value of a specific attribute key associated to the currently loaded collection version.

from  Collection
PageKey[]
getSetCollectionAttributes()

Get the list of attribute keys for which the currently loaded collection version has values.

from  Collection
Area|null
getArea(string $arHandle)

Get an existing area associated to this collection.

from  Collection
bool
hasAliasedContent()

Does this collection contain blocks that are aliased in other pages?

from  Collection
CustomStyle|null
getAreaCustomStyle(Area $area, bool $force = false)

Get the custom style of an area in the currently loaded collection version.

from  Collection
setCustomStyleSet(Area $area, StyleSet $set)

Set the custom style of an area in the currently loaded collection version.

from  Collection
resetAreaCustomStyle(Area $area)

Delete all the custom styles of an area of the currently loaded collection version.

from  Collection
string|null
outputCustomStyleHeaderItems(bool $return = false)

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

from  Collection
null|false
relateVersionEdits(Collection $oc)

Associate the edits of another collection to this collection.

from  Collection
int|false
getPageTypeID()

Returns the ID of the page/collection type.

refreshCache()

Empty the collection-related cache.

from  Collection
Block[]
getGlobalBlocks()

Get the blocks contained in all the global areas in this collection.

from  Collection
array
getGlobalBlockIDs()

Get the IDs for blocks contained in all the global areas in this collection.

from  Collection
Stack[]
getGlobalStacksForCollection()

Get all the global stacks loaded in this collection.

from  Collection
Block[]
getBlocks(string|false $arHandle = false)

List the blocks in the currently loaded collection version (or in a specific area within it).

from  Collection
array
getBlockIDs(string|false $arHandle = false)

List the block IDs and the associated area handles in the currently loaded collection version (or in a specific area within it).

from  Collection
Block
addBlock(BlockType $bt, string|Area $a, array $data)

Add a new block to a specific area of the currently loaded collection version.

int
getCollectionAreaDisplayOrder(string $arHandle, bool $ignoreVersions = false)

Get the next value of the display order (to be used when adding new blocks to an area).

from  Collection
rescanDisplayOrder(string $arHandle)

Fix the display order properties for all the blocks within the collection/area.

from  Collection
void
rescanDisplayOrderFromBlock(Block $block, string $arHandle, int $fromDisplay = null)

Fix the display order properties for all the blocks after this block in this area.

from  Collection
markModified()

Update the last edit date/time.

from  Collection
delete()

Delete this collection, and all its versions, contents and attributes.

Collection
duplicateCollection()

Create a clone of this collection, and all its versions, contents and attributes.

from  Collection
Page
cloneVersion(string|null $versionComments, bool $createEmpty = false)

Clone the currently loaded version and returns a Page instance containing the new version.

from  Collection
PageValue|null
getAttributeValue(string|CollectionKey $ak) deprecated

No description

from  Collection
mixed|null
getCollectionAttributeValue(string|CollectionKey $akHandle) deprecated

No description

from  Collection
getCollectionTypeID() deprecated

No description

assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

from  AssignableObjectTrait
__construct()

Initialize collection until we populate it.

static Page
getByPath(string $path, string $version = 'RECENT', TreeInterface $tree = null)

Get a page given its path.

CategoryInterface
getObjectAttributeCategory()

No description

ItemInterface
getExporter()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

string
getSummaryCategoryHandle()

No description

getSummaryIdentifier()

No description

stdClass
getJSONObject()

Return a representation of the Page object as something easily serializable.

PageController
getPageController()

Get the page controller.

getPermissionObjectIdentifier()

No description

bool
isEditMode()

Is the page in edit mode?

int
getPackageID()

Get the package ID for a page (page thats added by a package) (returns 0 if its not in a package).

string|null
getPackageHandle()

Get the handle the the package that added this page.

false
isArrangeMode() deprecated

No description

forceCheckIn()

Forces the page to be checked in if its checked out.

static 
forceCheckInForAllPages()

No description

bool
isAdminArea()

Is this a dashboard page?

static Page
getFromRequest(Request $request)

Uses a Request object to determine which page to load. Queries by path and then by cID.

processArrangement(int $area_id, int $moved_block_id, int[] $block_order)

Persist the data associated to a block when it has been moved around in the page.

bool|null
isCheckedOut()

Is the page checked out?

string
getCollectionCheckedOutUserName()

Gets the user that is editing the current page.

bool
isCheckedOutByMe()

Checks if the page is checked out by the current user.

bool
isGeneratedCollection()

Checks if the page is a single page.

setPermissionsToOverride()

No description

setChildPermissionsToOverride()

No description

removePermissions(Group|Group[]|User|UserInfo|User $userOrGroup, string[] $permissions = [])

Remove specific permission keys for a specific access entity (user, group, group combination).

static Page
getDraftsParentPage(Site $site = null)

Get the drafts parent page for a specific site.

static Page[]
getDrafts(Site $site)

Get the list of draft pages in a specific site.

bool
isPageDraft()

Is this a draft page?

setController(PageController|null $controller)

Set the page controller.

PageController
getController() deprecated

No description

assignPermissionSet(SimpleXMLElement $px)

This is the legacy function that is called just by xml. We pass these values in as though they were the old ones.

array
getSummaryTemplates()

No description

CustomPageTemplateCollection
getCustomPageSummaryTemplateCollection()

No description

bool
hasCustomSummaryTemplates()

No description

array
getCustomSelectedSummaryTemplates()

No description

int
addCollectionAlias(mixed $c)

Make an alias to a page.

void
updateCollectionAlias(array $data)

Update the alias details.

updateCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)

Update the name, link, and to open in a new window for an external link.

int
addCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)

Add a new external link as a child of this page.

bool
isSystemPage()

Returns true if a page is a system page. A system page is either a page that is outside the site tree (has a site tree ID of 0) or a page that is in the site tree, but whose parent starts at 0. That means its a root level page. Why do we need this separate boolean then? Because we need to easily be able to filter all pages by whether they're a system page even if we don't necessarily know where their starting page is.

string
getCollectionIcon()

Gets the icon for a page (also fires the on_page_get_icon event).

int|null
removeThisAlias()

Remove an external link/alias.

array
populateRecursivePages(array $pages, array $pageRow, int $cParentID, int $level, bool $includeThisPage = true)

Create an array containing data about child pages.

static int
queueForDeletionSort(array $a, array $b)

Sort a list of pages, so that the order is correct for the deletion.

static int
queueForDuplicationSort(array $a, array $b)

Sort a list of pages, so that the order is correct for the duplication.

export(SimpleXMLElement $pageNode) deprecated

No description

int|null
getCollectionCheckedOutUserID()

Get the uID for a page that is checked out (if any).

string
getCollectionPath()

Get the path of this page.

PagePath|null
getCollectionPathObject()

Returns the PagePath object for the current page.

PagePath
addAdditionalPagePath(string $cPath, bool $commit = true)

Add a non-canonical page path to the current page.

setCanonicalPagePath(string $cPath, bool $isAutoGenerated = false)

Set the canonical page path for a page.

PagePath[]
getPagePaths()

Get all the page paths of this page.

PagePath[]
getAdditionalPagePaths()

Get all the non-canonical page paths of this page.

clearPagePaths()

Clears all page paths for a page.

string
getCollectionLink()

Returns full url for the current page.

int|null
getSiteTreeID()

No description

Site
getSite()

No description

Tree|null
getSiteTreeObject()

No description

static 
getCollectionPathFromID(mixed $cID)

Returns the path for a page from its cID.

int|null
getCollectionUserID()

Get the uID of the page author (if any).

string|null
getCollectionTypeName() deprecated

No description

string|null
getPageTypeName()

Get the display name of the page type (if available).

Type|null
getPageTypeObject()

Get the page type object.

int
getPageTemplateID()

Get the Page Template ID.

Template|null
getPageTemplateObject()

Get the Page Template Object (if available).

string|false
getPageTemplateHandle()

Get the handle of the Page Template (if available).

string|false
getPageTypeHandle()

Get the handle of the Page Type (if available).

string|false
getCollectionTypeHandle() deprecated

No description

int|null
getCollectionThemeID()

Get the theme ID for the collection (if available).

bool
isBlockAliasedFromMasterCollection(Block $b)

Check if a block is an alias from a page default.

Theme
getCollectionThemeObject()

Get the collection's theme object.

string
getCollectionName()

Get the page name.

string|null
getCustomAliasName()

Get the custom name of the alias page.

string|null
getAliasHandle()

Get the handle of the alias page

int
getCollectionPointerID()

Get the collection ID for the aliased page (returns 0 unless used on an actual alias).

string|null
getCollectionPointerExternalLink()

Get the link for the aliased page.

bool|int|null
openCollectionPointerExternalLinkInNewWindow()

Should the alias link to be opened in a new window?

bool
isAliasPage()

Is this page an alias page of another page?

bool
isAliasPageOrExternalLink()

Is this page an alias page or an external link?

bool
isAlias() deprecated

No description

bool
isExternalLink()

Is this page an external link?

int
getCollectionPointerOriginalID()

Get the original cID of a page (if it's a page alias).

string
getCollectionFilename()

Get the file name of a page (single pages).

string
getCollectionDatePublic()

Get the date/time when the current version was made public (or a falsy value if the current version doesn't have public date).

DateTime|null
getCollectionDatePublicObject()

Get the date/time when the current version was made public (or NULL value if the current version doesn't have public date).

string
getCollectionDescription()

Get the description of a page.

int|null
getCollectionParentID()

Ges the cID of the parent page.

static int|null
getCollectionParentIDFromChildID(int $cID)

Get the parent cID of a page given its cID.

int[]
getCollectionParentIDs()

Get an array containint this cParentID and aliased parentIDs.

bool|int|null
isMasterCollection()

Is this page a page default?

bool|int|null
overrideTemplatePermissions()

Are template permissions overriden?

int|null
getCollectionDisplayOrder()

Get the position of the page in the sitemap, relative to its parent page.

setTheme(Theme $pl)

Set the theme of this page.

setThemeSkin(SkinInterface $skin)

Set the theme skin of this page.

setPageType(Type $type = null)

Set the theme for a page using the page object.

setPermissionsInheritanceToTemplate()

Set the permissions of sub-collections added beneath this permissions to inherit from the template.

setPermissionsInheritanceToOverride()

Set the permissions of sub-collections added beneath this permissions to inherit from the parent.

int|null
getPermissionsCollectionID()

Get the ID of the page from which this page inherits permissions from.

string|null
getCollectionInheritance()

Where permissions should be inherited from? 'PARENT' or 'TEMPLATE' or 'OVERRIDE'.

int|null
getParentPermissionsCollectionID()

Get the ID of the page from which the parent page page inherits permissions from.

Page
getPermissionsCollectionObject()

Get the page from which this page inherits permissions from.

int
getMasterCollectionID()

Get the master page of this page, given its page template and page type.

int|null
getOriginalCollectionID()

Get the ID of the original collection.

int|null
getNumChildren()

Get the number of child pages.

int
getNumChildrenDirect()

Get the number of child pages (direct children only).

Page|false
getFirstChild(string $sortColumn = 'cDisplayOrder asc')

Get the first child of the current page, or null if there is no child.

int[]
getCollectionChildrenArray(bool $oneLevelOnly = 0)

Get the list of child page IDs, sorted by their display order.

Page[]
getCollectionChildren()

Get the immediate children of the this page.

bool
canMoveCopyTo(Collection $cobj)

Check if a collection is this page itself or one of its sub-pages.

updateCollectionName(string $name)

Update the collection name.

bool
hasPageThemeCustomizations()

Does this page have theme customizations?

string
getPageWrapperClass()

Get the CSS class to be used to wrap the whole page contents.

update(array $data)

Update the data of this page.

clearPagePermissions()

Clear all the page permissions.

inheritPermissionsFromParent()

Set this page permissions to be inherited from its parent page.

inheritPermissionsFromDefaults()

Set this page permissions to be inherited from its parent type defaults.

setPermissionsToManualOverride()

Set this page permissions to be manually specified.

rescanAreaPermissions()

Rescan the page areas ensuring that they are inheriting permissions properly.

setOverrideTemplatePermissions(bool|int $cOverrideTemplatePermissions)

Are template permissions overriden?

updatePermissionsCollectionID(int|string $cParentIDString, mixed $npID)

Set the child pages of a list of parent pages to inherit permissions from the specified page (provided that they previouly had the same inheritance page as this page).

acquireAreaPermissions(int $permissionsCollectionID)

Acquire the area permissions, copying them from the inherited ones.

acquirePagePermissions(int $permissionsCollectionID)

Acquire the page permissions, copying them from the inherited ones.

updateGroupsSubCollection(int|string $cParentIDString) deprecated

No description

SiblingRelation[]
getPageRelations()

Get the relations of this page.

move(mixed $nc)

Move this page under a new parent page.

Page
duplicateAll(null|mixed $nc = null, bool $preserveUserID = false, Site $site = null)

Duplicate this page and all its child pages and return the new Page created.

Page
duplicate(null|mixed $nc = null, bool $preserveUserID = false, TreeInterface $site = null)

Duplicate this page and return the new Page created.

moveToTrash()

Move this page and all its child pages to the trash.

rescanChildrenDisplayOrder()

Regenerate the display order of the child pages.

bool
isHomePage()

Is this the homepage for the site tree this page belongs to?

int|null
getSiteHomePageID()

Get the ID of the homepage for the site tree this page belongs to.

bool
isLocaleHomePage() deprecated

No description

static int|null
getHomePageID(Page|int $page = null)

Get the ID of the home page.

PagePath
getAutoGeneratedPagePathObject()

Get a new PagePath object with the computed canonical page path.

int
getNextSubPageDisplayOrder()

Get the next available display order of child pages.

string
generatePagePath()

Get the URL-slug-based path to the current page (including any suffixes) in a string format. Does so in real time.

rescanCollectionPath()

Recalculate the canonical page path for the current page and its sub-pages, based on its current version, URL slug, etc.

updateDisplayOrder(int $displayOrder, int|null $cID = 0)

Set a new display order for this page (or for another page given its ID).

movePageDisplayOrderToTop()

Make this page the first child of its parent.

movePageDisplayOrderToBottom()

Make this page the first child of its parent.

movePageDisplayOrderToSibling(Page $c, string $position = 'before')

Move this page before of after another page.

rescanSystemPageStatus()

Recalculate the "is a system page" state.

bool
isInTrash()

Is this page in the trash?

moveToRoot()

Make this page child of nothing, thus moving it to the root level.

deactivate()

Mark this page as non active.

setPageToDraft()

Mark this page as non draft.

activate()

Mark this page as active.

bool
isActive()

Is this page marked as active?

setPageIndexScore(float $score)

Set the page index score (used by a PageList for instance).

float
getPageIndexScore()

Get the page index score (as set by a PageList for instance).

string
getPageIndexContent()

Get the indexed content of this page.

static Page
addHomePage(TreeInterface $siteTree = null)

Add the home page to the system. Typically used only by the installation program.

Page
add(mixed $pt, array $data, mixed $template = false)

Add a new page, child of this page.

CustomStyle|null
getCustomStyleObject()

Get the custom style for the currently loaded page version (if any).

int|null
getCollectionFullPageCaching()

Get the full-page cache flag (-1: use global setting; 0: no; 1: yes - NULL if page is not loaded).

string|null
getCollectionFullPageCachingLifetime()

Get the full-page cache lifetime criteria ('default': use default lifetime; 'forever': no expiration; 'custom': custom lifetime value - see getCollectionFullPageCachingLifetimeCustomValue(); other: use the default lifetime - NULL if page is not loaded).

int|null
getCollectionFullPageCachingLifetimeCustomValue()

Get the full-page cache custom lifetime in minutes (to be used if getCollectionFullPageCachingLifetime() is 'custom').

int
getCollectionFullPageCachingLifetimeValue()

Get the actual full-page cache lifespan (in seconds).

static Page
addStatic(array $data, TreeInterface $parent = null)

Create a new page.

static Page|null
getCurrentPage()

Get the currently requested page.

int
getPageDraftTargetParentPageID()

Get the ID of the draft parent page ID.

setPageDraftTargetParentPageID(int $cParentID)

Set the ID of the draft parent page ID.

populatePage(mixed $cInfo, string $where, string|int $cvID)

Read the data from the database.

_getNumChildren(int $cID, bool $oneLevelOnly = 0, string $sortColumn = 'cDisplayOrder asc')

Populate the childrenCIDArray property (called by the getCollectionChildrenArray() method).

_duplicateAll(mixed $cParent, mixed $cNewParent, bool $preserveUserID = false, Site $site = null)

Duplicate all the child pages of a specific page which has already have been duplicated.

getPageSkin()

No description

string
computeCanonicalPagePath()

Get the canonical path string of this page .

_associateMasterCollectionBlocks(int $newCID, mixed $masterCID, bool $cAcquireComposerOutputControls)

Duplicate the master collection blocks/permissions to a newly created page.

_associateMasterCollectionAttributes(int $newCID, mixed $masterCID)

Duplicate the master collection attributes to a newly created page.

acquireAreaStylesFromDefaults(Template $template)

Copy the area styles from a page template.

static string[]
translatePermissionsXMLToKeys(SimpleXMLElement $node)

No description

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

in Collection at line 89
__destruct()

Destruct the class instance.

at line 364
static Collection getByID(int $cID, string|int|false $version = 'RECENT')

Get a collection by ID.

Parameters

int $cID

The collection ID
string|int|false $version

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

Return Value

Collection

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

in Collection at line 136
static Collection|null getByHandle(string $handle)

Get a Collection by handle (provided that it's not a Page handle).

If there's there's no collection with the specified handle, a new Collection will be created.

Parameters

string $handle

the collection handle

Return Value

Collection|null

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

in Collection at line 174
static int reindexPendingPages()

(Re)Index all the collections that are marked as to be (re)indexed.

Return Value

int

returns the number of reindexed pages

in Collection at line 216
static Collection createCollection(array $data)

Create a new Collection instance.

Parameters

array $data

{

@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)

}

Return Value

Collection

in Collection at line 301
int|null getCollectionID()

Get the collection ID.

Return Value

int|null

at line 1609
string|null getCollectionHandle()

Get the collection handle.

Return Value

string|null

in Collection at line 323
string|null getCollectionDateLastModified()

Get the date/time when the collection was last modified.

Return Value

string|null

Examples

2017-12-31 23:59:59

in Collection at line 335
string|null getCollectionDateAdded()

Get the date/time when the collection has been created.

Return Value

string|null

Examples

2017-12-31 23:59:59

in Collection at line 345
int getVersionID()

Get the ID of the currently loaded version.

Return Value

int

in Collection at line 355
Version|null getVersionObject()

Get the currently loaded version object.

Return Value

Version|null

in Collection at line 378
Collection addCollection(array $data)

Create a new Collection instance, using the same theme as this instance (if it's a Page instance).

Parameters

array $data

{

@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)

}

Return Value

Collection

in Collection at line 393
loadVersionObject(string|int $cvID = 'ACTIVE')

Load a specific collection version (you can retrieve it with the getVersionObject() method).

Parameters

string|int $cvID

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

in Collection at line 403
$this|Page getVersionToModify()

Get the Collection instance to be modified (this instance if it's a new or master Collection, a clone otherwise).

Return Value

$this|Page

in Collection at line 420
string getNextVersionComments()

Get the automatic comment for the next collection version.

Return Value

string

Example: 'Version 2'

in Collection at line 428
reindex($doReindexImmediately = true)

No description

Parameters

$doReindexImmediately

in Collection at line 453
PageValue setAttribute(string|CollectionKey $ak, AbstractValue|mixed $value, bool $doReindexImmediately = true)

Set the attribute value for the currently loaded collection version.

Parameters

string|CollectionKey $ak

the attribute key (or its handle)
AbstractValue|mixed $value

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

Return Value

PageValue

in Collection at line 478
mixed|null getAttribute(string|CollectionKey $akHandle, string|false $displayMode = false)

Return the value of the attribute with the handle $akHandle of the currently loaded version (if it's loaded).

Parameters

string|CollectionKey $akHandle

the attribute key (or its handle)
string|false $displayMode

makes The format of the attribute value

Return Value

mixed|null

Examples

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.

in Collection at line 493
PageValue|null getAttributeValueObject(string|CollectionKey $akHandle, bool $createIfNotExists = false)

Return the attribute value object with the handle $akHandle of the currently loaded version (if it's loaded).

Parameters

string|CollectionKey $akHandle

the attribute key (or its handle)
bool $createIfNotExists

Return Value

PageValue|null

in Collection at line 505
clearCollectionAttributes(int[] $retainAKIDs = [])

Delete the values of the attributes associated to the currently loaded collection version.

Parameters

int[] $retainAKIDs

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

in Collection at line 540
clearAttribute(string|CollectionKey $ak, bool $doReindexImmediately = true)

Delete the value of a specific attribute key associated to the currently loaded collection version.

Parameters

string|CollectionKey $ak

the attribute key (or its handle)
bool $doReindexImmediately

in Collection at line 550
PageKey[] getSetCollectionAttributes()

Get the list of attribute keys for which the currently loaded collection version has values.

Return Value

PageKey[]

in Collection at line 569
Area|null getArea(string $arHandle)

Get an existing area associated to this collection.

Parameters

string $arHandle

the handle of the area

Return Value

Area|null

in Collection at line 579
bool hasAliasedContent()

Does this collection contain blocks that are aliased in other pages?

Return Value

bool

in Collection at line 624
CustomStyle|null getAreaCustomStyle(Area $area, bool $force = false)

Get the custom style of an area in the currently loaded collection version.

Parameters

Area $area

the area for which you want the custom styles
bool $force

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

Return Value

CustomStyle|null

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

in Collection at line 649
setCustomStyleSet(Area $area, StyleSet $set)

Set the custom style of an area in the currently loaded collection version.

Parameters

Area $area
StyleSet $set

in Collection at line 691
resetAreaCustomStyle(Area $area)

Delete all the custom styles of an area of the currently loaded collection version.

Parameters

Area $area

in Collection at line 714
string|null outputCustomStyleHeaderItems(bool $return = false)

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

Parameters

bool $return

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

Return Value

string|null

in Collection at line 855
null|false relateVersionEdits(Collection $oc)

Associate the edits of another collection to this collection.

Parameters

Collection $oc

the collection that has been modified

Return Value

null|false

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

Examples

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

at line 1655
int|false getPageTypeID()

Returns the ID of the page/collection type.

Return Value

int|false

in Collection at line 898
refreshCache()

Empty the collection-related cache.

in Collection at line 908
Block[] getGlobalBlocks()

Get the blocks contained in all the global areas in this collection.

Return Value

Block[]

in Collection at line 926
array getGlobalBlockIDs()

Get the IDs for blocks contained in all the global areas in this collection.

Return Value

array

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

in Collection at line 944
protected Stack[] getGlobalStacksForCollection()

Get all the global stacks loaded in this collection.

Return Value

Stack[]

in Collection at line 986
Block[] getBlocks(string|false $arHandle = false)

List the blocks in the currently loaded collection version (or in a specific area within it).

Parameters

string|false $arHandle

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

Return Value

Block[]

in Collection at line 1010
array getBlockIDs(string|false $arHandle = false)

List the block IDs and the associated area handles in the currently loaded collection version (or in a specific area within it).

Parameters

string|false $arHandle

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

Return Value

array

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

at line 2785
Block addBlock(BlockType $bt, string|Area $a, array $data)

Add a new block to a specific area of the currently loaded collection version.

Parameters

BlockType $bt

the type of block to be added
string|Area $a

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

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.

Return Value

Block

in Collection at line 1137
int getCollectionAreaDisplayOrder(string $arHandle, bool $ignoreVersions = false)

Get the next value of the display order (to be used when adding new blocks to an area).

Parameters

string $arHandle

The handle of the area
bool $ignoreVersions

Set to true to ignore the collection version

Return Value

int

in Collection at line 1187
rescanDisplayOrder(string $arHandle)

Fix the display order properties for all the blocks within the collection/area.

Parameters

string $arHandle

the handle of the area to be processed

in Collection at line 1241
void rescanDisplayOrderFromBlock(Block $block, string $arHandle, int $fromDisplay = null)

Fix the display order properties for all the blocks after this block in this area.

This is useful for forcing a certain block order.

Parameters

Block $block

the block to begin the display order rescan from
string $arHandle

the handle of the area to be processed
int $fromDisplay

an optional integer to override the starting number, i.e start from 0 even though our block is 8

Return Value

void

Exceptions

Exception
BindingResolutionException

in Collection at line 1298
markModified()

Update the last edit date/time.

at line 2982
delete()

Delete this collection, and all its versions, contents and attributes.

in Collection at line 1365
Collection duplicateCollection()

Create a clone of this collection, and all its versions, contents and attributes.

Return Value

Collection

in Collection at line 1383
Page cloneVersion(string|null $versionComments, bool $createEmpty = false)

Clone the currently loaded version and returns a Page instance containing the new version.

Parameters

string|null $versionComments

the comments to be associated to the new Version
bool $createEmpty

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

Return Value

Page

in Collection at line 1403
PageValue|null getAttributeValue(string|CollectionKey $ak) deprecated

deprecated Use of getAttributeValueObject()

No description

Parameters

string|CollectionKey $ak

Return Value

PageValue|null

in Collection at line 1415
mixed|null getCollectionAttributeValue(string|CollectionKey $akHandle) deprecated

deprecated use the getAttribute() method

No description

Parameters

string|CollectionKey $akHandle

Return Value

mixed|null

at line 1645
getCollectionTypeID() deprecated

deprecated use the getPageTypeID() method

No description

in AssignableObjectTrait at line 14
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

at line 302
__construct()

Initialize collection until we populate it.

at line 316
static Page getByPath(string $path, string $version = 'RECENT', TreeInterface $tree = null)

Get a page given its path.

Parameters

string $path

the page path (example: /path/to/page)
string $version

the page version ('RECENT' for the most recent version, 'ACTIVE' for the currently published version, 'SCHEDULED' for the currently scheduled version, or an integer to retrieve a specific version ID)
TreeInterface $tree

Return Value

Page

at line 349
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

See also

ObjectInterface::getObjectAttributeCategory

at line 393
ItemInterface getExporter()

No description

Return Value

ItemInterface

See also

ExportableInterface::getExporter

at line 403
getPermissionResponseClassName()

No description

See also

ObjectInterface::getPermissionResponseClassName

at line 413
getPermissionAssignmentClassName()

No description

See also

ObjectInterface::getPermissionAssignmentClassName

at line 423
getPermissionObjectKeyCategoryHandle()

No description

See also

ObjectInterface::getPermissionObjectKeyCategoryHandle

at line 433
string getSummaryCategoryHandle()

No description

Return Value

string

See also

\Concrete\Core\Summary\Template\Category\CategoryMemberInterface::getSummaryCategoryHandle()

at line 441
getSummaryIdentifier()

No description

at line 451
stdClass getJSONObject()

Return a representation of the Page object as something easily serializable.

Return Value

stdClass

at line 478
PageController getPageController()

Get the page controller.

Return Value

PageController

at line 519
getPermissionObjectIdentifier()

No description

See also

ObjectInterface::getPermissionObjectIdentifier

at line 537
bool isEditMode()

Is the page in edit mode?

Return Value

bool

at line 554
int getPackageID()

Get the package ID for a page (page thats added by a package) (returns 0 if its not in a package).

Return Value

int

at line 564
string|null getPackageHandle()

Get the handle the the package that added this page.

Return Value

string|null

at line 578
false isArrangeMode() deprecated

deprecated There's no more an "Arrange Mode"

No description

Return Value

false

at line 586
forceCheckIn()

Forces the page to be checked in if its checked out.

at line 598
static private forceCheckInForAllPages()

No description

at line 610
bool isAdminArea()

Is this a dashboard page?

Return Value

bool

at line 628
static Page getFromRequest(Request $request)

Uses a Request object to determine which page to load. Queries by path and then by cID.

Parameters

Request $request

Return Value

Page

at line 697
processArrangement(int $area_id, int $moved_block_id, int[] $block_order)

Persist the data associated to a block when it has been moved around in the page.

Parameters

int $area_id

The ID of the area where the block resides after the arrangment
int $moved_block_id

The ID of the moved block
int[] $block_order

The IDs of all the blocks in the area, ordered by their display order

at line 730
bool|null isCheckedOut()

Is the page checked out?

Return Value

bool|null

returns NULL if the page does not exist, a boolean otherwise

at line 769
string getCollectionCheckedOutUserName()

Gets the user that is editing the current page.

Return Value

string

at line 790
bool isCheckedOutByMe()

Checks if the page is checked out by the current user.

Return Value

bool

at line 806
bool isGeneratedCollection()

Checks if the page is a single page.

Generated collections are collections without templates, that have special cFilename attributes .

Return Value

bool

at line 816
setPermissionsToOverride()

No description

See also

AssignableObjectInterface::setPermissionsToOverride

at line 828
setChildPermissionsToOverride()

No description

See also

AssignableObjectInterface::setChildPermissionsToOverride

at line 841
removePermissions(Group|Group[]|User|UserInfo|User $userOrGroup, string[] $permissions = [])

Remove specific permission keys for a specific access entity (user, group, group combination).

Parameters

Group|Group[]|User|UserInfo|User $userOrGroup

A list of groups for a group combination, or a group or a user
string[] $permissions

the handles of page permission keys to be removed

at line 879
static Page getDraftsParentPage(Site $site = null)

Get the drafts parent page for a specific site.

Parameters

Site $site

If not specified, we'll use the default site

Return Value

Page

at line 895
static Page[] getDrafts(Site $site)

Get the list of draft pages in a specific site.

Parameters

Site $site

Return Value

Page[]

at line 916
bool isPageDraft()

Is this a draft page?

Return Value

bool

at line 930
setController(PageController|null $controller)

Set the page controller.

Parameters

PageController|null $controller

at line 940
PageController getController() deprecated

deprecated use the getPageController() method

No description

Return Value

PageController

at line 952
private assignPermissionSet(SimpleXMLElement $px)

This is the legacy function that is called just by xml. We pass these values in as though they were the old ones.

Parameters

SimpleXMLElement $px

at line 980
array getSummaryTemplates()

No description

Return Value

array

at line 991
protected CustomPageTemplateCollection getCustomPageSummaryTemplateCollection()

No description

Return Value

CustomPageTemplateCollection

at line 999
bool hasCustomSummaryTemplates()

No description

Return Value

bool

at line 1007
array getCustomSelectedSummaryTemplates()

No description

Return Value

array

at line 1028
int addCollectionAlias(mixed $c)

Make an alias to a page.

Parameters

mixed $c

Return Value

int

The ID of the new collection

at line 1086
void updateCollectionAlias(array $data)

Update the alias details.

Parameters

array $data

Supported keys:

  • string ```customAliasName``` empty string to use the name of the aliased page
  • string ```aliasHandle``` the URL slug of the alias

Return Value

void

at line 1139
updateCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)

Update the name, link, and to open in a new window for an external link.

Parameters

string $cName
string $cLink
bool $newWindow

at line 1163
int addCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)

Add a new external link as a child of this page.

Parameters

string $cName
string $cLink
bool $newWindow

Return Value

int

The ID of the new collection

at line 1216
bool isSystemPage()

Returns true if a page is a system page. A system page is either a page that is outside the site tree (has a site tree ID of 0) or a page that is in the site tree, but whose parent starts at 0. That means its a root level page. Why do we need this separate boolean then? Because we need to easily be able to filter all pages by whether they're a system page even if we don't necessarily know where their starting page is.

Return Value

bool

at line 1226
string getCollectionIcon()

Gets the icon for a page (also fires the on_page_get_icon event).

Return Value

string

The path to the icon

at line 1271
int|null removeThisAlias()

Remove an external link/alias.

Return Value

int|null

cID of the original page if the page was an alias

at line 1319
array populateRecursivePages(array $pages, array $pageRow, int $cParentID, int $level, bool $includeThisPage = true)

Create an array containing data about child pages.

Parameters

array $pages

the previously loaded data
array $pageRow

The data of current parent page (it must contain cID and optionally cDisplayOrder)
int $cParentID

The parent page ID
int $level

The current depth level
bool $includeThisPage

Should $pageRow itself be added to the resulting array?

Return Value

array

Every array item contains the following keys: {

@var int $cID @var int $cDisplayOrder @var int $cParentID @var int $level @var int $total }

at line 1351
static int queueForDeletionSort(array $a, array $b)

Sort a list of pages, so that the order is correct for the deletion.

Parameters

array $a
array $b

Return Value

int

at line 1371
static int queueForDuplicationSort(array $a, array $b)

Sort a list of pages, so that the order is correct for the duplication.

Parameters

array $a
array $b

Return Value

int

at line 1402
export(SimpleXMLElement $pageNode) deprecated

deprecated use the \Concrete\Core\Page\Exporter class

No description

Parameters

SimpleXMLElement $pageNode

See also

Page::getExporter

at line 1413
int|null getCollectionCheckedOutUserID()

Get the uID for a page that is checked out (if any).

Return Value

int|null

at line 1423
string getCollectionPath()

Get the path of this page.

Return Value

string

at line 1433
PagePath|null getCollectionPathObject()

Returns the PagePath object for the current page.

Return Value

PagePath|null

at line 1452
PagePath addAdditionalPagePath(string $cPath, bool $commit = true)

Add a non-canonical page path to the current page.

Parameters

string $cPath
bool $commit

Should the new PagePath instance be persisted?

Return Value

PagePath

at line 1472
setCanonicalPagePath(string $cPath, bool $isAutoGenerated = false)

Set the canonical page path for a page.

Parameters

string $cPath
bool $isAutoGenerated

is the page path generated from URL slugs?

at line 1494
PagePath[] getPagePaths()

Get all the page paths of this page.

Return Value

PagePath[]

at line 1508
PagePath[] getAdditionalPagePaths()

Get all the non-canonical page paths of this page.

Return Value

PagePath[]

at line 1520
clearPagePaths()

Clears all page paths for a page.

Returns full url for the current page.

Return Value

string

at line 1545
int|null getSiteTreeID()

No description

Return Value

int|null

See also

TreeInterface::getSiteTreeID

at line 1555
Site getSite()

No description

Return Value

Site

See also

SiteAggregateInterface::getSite

at line 1568
Tree|null getSiteTreeObject()

No description

Return Value

Tree|null

See also

TreeInterface::getSiteTreeObject

at line 1586
static getCollectionPathFromID(mixed $cID)

Returns the path for a page from its cID.

Parameters

mixed $cID

at line 1599
int|null getCollectionUserID()

Get the uID of the page author (if any).

Return Value

int|null

at line 1622
string|null getCollectionTypeName() deprecated

deprecated use the getPageTypeName() method

No description

Return Value

string|null

at line 1632
string|null getPageTypeName()

Get the display name of the page type (if available).

Return Value

string|null

at line 1665
Type|null getPageTypeObject()

Get the page type object.

Return Value

Type|null

at line 1675
int getPageTemplateID()

Get the Page Template ID.

Return Value

int

at line 1688
Template|null getPageTemplateObject()

Get the Page Template Object (if available).

Return Value

Template|null

at line 1698
string|false getPageTemplateHandle()

Get the handle of the Page Template (if available).

Return Value

string|false

at line 1713
string|false getPageTypeHandle()

Get the handle of the Page Type (if available).

Return Value

string|false

at line 1734
string|false getCollectionTypeHandle() deprecated

deprecated use the getPageTypeHandle() method

No description

Return Value

string|false

at line 1744
int|null getCollectionThemeID()

Get the theme ID for the collection (if available).

Return Value

int|null

at line 1759
bool isBlockAliasedFromMasterCollection(Block $b)

Check if a block is an alias from a page default.

Parameters

Block $b

Return Value

bool

at line 1789
Theme getCollectionThemeObject()

Get the collection's theme object.

Return Value

Theme

at line 1825
string getCollectionName()

Get the page name.

Return Value

string

at line 1844
string|null getCustomAliasName()

Get the custom name of the alias page.

Return Value

string|null

NULL if the page is not an alias, empty string if we should use the name of the aliased page, the custom alias name otherwise.

at line 1854
string|null getAliasHandle()

Get the handle of the alias page

Return Value

string|null

NULL if the page is not an alias, the alias handle otherwise

at line 1864
int getCollectionPointerID()

Get the collection ID for the aliased page (returns 0 unless used on an actual alias).

Return Value

int

Get the link for the aliased page.

Return Value

string|null

at line 1884
bool|int|null openCollectionPointerExternalLinkInNewWindow()

Should the alias link to be opened in a new window?

Return Value

bool|int|null

at line 1896
bool isAliasPage()

Since: concrete5 8.5.0a2

Is this page an alias page of another page?

Return Value

bool
Since: concrete5 8.5.0a2

Is this page an alias page or an external link?

Return Value

bool

at line 1918
bool isAlias() deprecated

deprecated This method has been replaced with isAliasPageOrExternalLink() in concrete5 8.5.0a2 (same syntax and same result)

No description

Return Value

bool

Is this page an external link?

Return Value

bool

at line 1938
int getCollectionPointerOriginalID()

Get the original cID of a page (if it's a page alias).

Return Value

int

at line 1948
string getCollectionFilename()

Get the file name of a page (single pages).

Return Value

string

at line 1960
string getCollectionDatePublic()

Get the date/time when the current version was made public (or a falsy value if the current version doesn't have public date).

Return Value

string

Examples

2009-01-01 00:00:00

at line 1973
DateTime|null getCollectionDatePublicObject()

Get the date/time when the current version was made public (or NULL value if the current version doesn't have public date).

Return Value

DateTime|null

at line 1983
string getCollectionDescription()

Get the description of a page.

Return Value

string

at line 1996
int|null getCollectionParentID()

Ges the cID of the parent page.

Return Value

int|null

at line 2008
static int|null getCollectionParentIDFromChildID(int $cID)

Get the parent cID of a page given its cID.

Parameters

int $cID

Return Value

int|null

at line 2022
int[] getCollectionParentIDs()

Get an array containint this cParentID and aliased parentIDs.

Return Value

int[]

at line 2039
bool|int|null isMasterCollection()

Is this page a page default?

Return Value

bool|int|null

at line 2049
bool|int|null overrideTemplatePermissions()

Are template permissions overriden?

Return Value

bool|int|null

at line 2059
int|null getCollectionDisplayOrder()

Get the position of the page in the sitemap, relative to its parent page.

Return Value

int|null

at line 2069
setTheme(Theme $pl)

Set the theme of this page.

Parameters

Theme $pl

at line 2081
setThemeSkin(SkinInterface $skin)

Set the theme skin of this page.

Parameters

SkinInterface $skin

at line 2092
setPageType(Type $type = null)

Set the theme for a page using the page object.

Parameters

Type $type

at line 2106
setPermissionsInheritanceToTemplate()

Set the permissions of sub-collections added beneath this permissions to inherit from the template.

at line 2117
setPermissionsInheritanceToOverride()

Set the permissions of sub-collections added beneath this permissions to inherit from the parent.

at line 2130
int|null getPermissionsCollectionID()

Get the ID of the page from which this page inherits permissions from.

Return Value

int|null

at line 2140
string|null getCollectionInheritance()

Where permissions should be inherited from? 'PARENT' or 'TEMPLATE' or 'OVERRIDE'.

Return Value

string|null

at line 2150
int|null getParentPermissionsCollectionID()

Get the ID of the page from which the parent page page inherits permissions from.

Return Value

int|null

at line 2170
Page getPermissionsCollectionObject()

Get the page from which this page inherits permissions from.

Return Value

Page

at line 2180
int getMasterCollectionID()

Get the master page of this page, given its page template and page type.

Return Value

int

returns 0 if not found

at line 2200
int|null getOriginalCollectionID()

Get the ID of the original collection.

Return Value

int|null

at line 2213
int|null getNumChildren()

Get the number of child pages.

Return Value

int|null

at line 2223
int getNumChildrenDirect()

Get the number of child pages (direct children only).

Return Value

int

at line 2243
Page|false getFirstChild(string $sortColumn = 'cDisplayOrder asc')

Get the first child of the current page, or null if there is no child.

Parameters

string $sortColumn

the ORDER BY clause

Return Value

Page|false

at line 2279
int[] getCollectionChildrenArray(bool $oneLevelOnly = 0)

Get the list of child page IDs, sorted by their display order.

Parameters

bool $oneLevelOnly

set to true to return only the direct children, false for all the child pages

Return Value

int[]

at line 2292
Page[] getCollectionChildren()

Get the immediate children of the this page.

Return Value

Page[]

at line 2317
bool canMoveCopyTo(Collection $cobj)

Check if a collection is this page itself or one of its sub-pages.

Parameters

Collection $cobj

Return Value

bool

at line 2330
updateCollectionName(string $name)

Update the collection name.

Parameters

string $name

at line 2357
bool hasPageThemeCustomizations()

Does this page have theme customizations?

Return Value

bool

at line 2371
string getPageWrapperClass()

Get the CSS class to be used to wrap the whole page contents.

Return Value

string

at line 2422
update(array $data)

Update the data of this page.

Parameters

array $data

Recognized keys are {

@var string $cHandle
@var string $cName
@var string $cDescription
@var string $cDatePublic
@var int $ptID
@var int $pTemplateID
@var int $uID
@var string $$cFilename
@var int $cCacheFullPageContent -1: use the default settings; 0: no; 1: yes
@var int $cCacheFullPageContentLifetimeCustom
@var string $cCacheFullPageContentOverrideLifetime

}

at line 2575
clearPagePermissions()

Clear all the page permissions.

at line 2585
inheritPermissionsFromParent()

Set this page permissions to be inherited from its parent page.

at line 2602
inheritPermissionsFromDefaults()

Set this page permissions to be inherited from its parent type defaults.

at line 2625
setPermissionsToManualOverride()

Set this page permissions to be manually specified.

at line 2646
rescanAreaPermissions()

Rescan the page areas ensuring that they are inheriting permissions properly.

at line 2661
setOverrideTemplatePermissions(bool|int $cOverrideTemplatePermissions)

Are template permissions overriden?

Parameters

bool|int $cOverrideTemplatePermissions

at line 2677
updatePermissionsCollectionID(int|string $cParentIDString, mixed $npID)

Set the child pages of a list of parent pages to inherit permissions from the specified page (provided that they previouly had the same inheritance page as this page).

Parameters

int|string $cParentIDString

A comma-separeted list of parent page IDs
mixed $npID

at line 2701
acquireAreaPermissions(int $permissionsCollectionID)

Acquire the area permissions, copying them from the inherited ones.

Parameters

int $permissionsCollectionID

the ID of the collection from which the page previously inherited permissions from

at line 2735
acquirePagePermissions(int $permissionsCollectionID)

Acquire the page permissions, copying them from the inherited ones.

Parameters

int $permissionsCollectionID

the ID of the collection from which the page previously inherited permissions from

at line 2757
updateGroupsSubCollection(int|string $cParentIDString) deprecated

deprecated is this function still useful? There's no reference to it in the core

No description

Parameters

int|string $cParentIDString

at line 2833
SiblingRelation[] getPageRelations()

Get the relations of this page.

Return Value

SiblingRelation[]

at line 2857
move(mixed $nc)

Move this page under a new parent page.

Parameters

mixed $nc

at line 2948
Page duplicateAll(null|mixed $nc = null, bool $preserveUserID = false, Site $site = null)

Duplicate this page and all its child pages and return the new Page created.

Parameters

null|mixed $nc
bool $preserveUserID

Set to true to preserve the original page author IDs
Site $site

the destination site (used if $toParentPage is NULL)

Return Value

Page

at line 2966
Page duplicate(null|mixed $nc = null, bool $preserveUserID = false, TreeInterface $site = null)

Duplicate this page and return the new Page created.

Parameters

null|mixed $nc
bool $preserveUserID

Set to true to preserve the original page author IDs
TreeInterface $site

the destination site (used if $toParentPage is NULL)

Return Value

Page

at line 3066
moveToTrash()

Move this page and all its child pages to the trash.

at line 3103
rescanChildrenDisplayOrder()

Regenerate the display order of the child pages.

at line 3124
bool isHomePage()

Is this the homepage for the site tree this page belongs to?

Return Value

bool

at line 3134
int|null getSiteHomePageID()

Get the ID of the homepage for the site tree this page belongs to.

Return Value

int|null

Returns NULL if there's no default locale

at line 3144
bool isLocaleHomePage() deprecated

deprecated use the isHomePage() method

No description

Return Value

bool

at line 3156
static int|null getHomePageID(Page|int $page = null)

Get the ID of the home page.

Parameters

Page|int $page

the page (or its ID) for which you want the home (if not specified, we'll use the default locale site tree)

Return Value

int|null

returns NULL if $page is null (or it doesn't have a SiteTree associated) and if there's no default locale

at line 3198
PagePath getAutoGeneratedPagePathObject()

Get a new PagePath object with the computed canonical page path.

Return Value

PagePath

at line 3214
int getNextSubPageDisplayOrder()

Get the next available display order of child pages.

Return Value

int

at line 3227
string generatePagePath()

Get the URL-slug-based path to the current page (including any suffixes) in a string format. Does so in real time.

Return Value

string

at line 3271
rescanCollectionPath()

Recalculate the canonical page path for the current page and its sub-pages, based on its current version, URL slug, etc.

at line 3305
updateDisplayOrder(int $displayOrder, int|null $cID = 0)

Set a new display order for this page (or for another page given its ID).

Parameters

int $displayOrder
int|null $cID

The page ID to set the display order for (if empty, we'll use this page)

at line 3348
movePageDisplayOrderToTop()

Make this page the first child of its parent.

at line 3367
movePageDisplayOrderToBottom()

Make this page the first child of its parent.

at line 3384
movePageDisplayOrderToSibling(Page $c, string $position = 'before')

Move this page before of after another page.

Parameters

Page $c
string $position

'before' or 'after'

at line 3414
rescanSystemPageStatus()

Recalculate the "is a system page" state.

Looks at the current page. If the site tree ID is 0, sets system page to true. If the site tree is not user, looks at where the page falls in the hierarchy. If it's inside a page at the top level that has 0 as its parent, then it is considered a system page.

at line 3454
bool isInTrash()

Is this page in the trash?

Return Value

bool

at line 3462
moveToRoot()

Make this page child of nothing, thus moving it to the root level.

at line 3473
deactivate()

Mark this page as non active.

at line 3482
setPageToDraft()

Mark this page as non draft.

at line 3492
activate()

Mark this page as active.

at line 3503
bool isActive()

Is this page marked as active?

Return Value

bool

at line 3516
setPageIndexScore(float $score)

Set the page index score (used by a PageList for instance).

Parameters

float $score

at line 3526
float getPageIndexScore()

Get the page index score (as set by a PageList for instance).

Return Value

float

at line 3536
string getPageIndexContent()

Get the indexed content of this page.

Return Value

string

at line 3550
static Page addHomePage(TreeInterface $siteTree = null)

Add the home page to the system. Typically used only by the installation program.

Parameters

TreeInterface $siteTree

Return Value

Page

at line 3613
Page add(mixed $pt, array $data, mixed $template = false)

Add a new page, child of this page.

Parameters

mixed $pt
array $data

Supported keys: {

@var int|null $uID The ID of the page author (if unspecified or NULL: current user)
@var int|null $pkgID the ID of the package that creates this page
@var string $cName The page name
@var string $name (used if cName is not specified)
@var int|null $cID The ID of the page to create (if unspecified or NULL: database autoincrement value)
@var int|bool $cIsActive Is the page to be considered as active?
@var int|bool $cIsDraft Is the page to be considered as draft?
@var string $cHandle The page handle
@var string $cDescription The page description (default: NULL)
@var string $cDatePublic The page publish date/time in format 'YYYY-MM-DD hh:mm:ss' (default: now)
@var bool $cvIsApproved Is the page version approved (default: true)
@var bool $cvIsNew Is the page to be considered "new"? (default: true if $cvIsApproved is false, false if $cvIsApproved is true)
@var bool $cAcquireComposerOutputControls

}
mixed $template

Return Value

Page

at line 3783
CustomStyle|null getCustomStyleObject()

Get the custom style for the currently loaded page version (if any).

Return Value

CustomStyle|null

at line 3803
int|null getCollectionFullPageCaching()

Get the full-page cache flag (-1: use global setting; 0: no; 1: yes - NULL if page is not loaded).

Return Value

int|null

at line 3813
string|null getCollectionFullPageCachingLifetime()

Get the full-page cache lifetime criteria ('default': use default lifetime; 'forever': no expiration; 'custom': custom lifetime value - see getCollectionFullPageCachingLifetimeCustomValue(); other: use the default lifetime - NULL if page is not loaded).

Return Value

string|null

at line 3823
int|null getCollectionFullPageCachingLifetimeCustomValue()

Get the full-page cache custom lifetime in minutes (to be used if getCollectionFullPageCachingLifetime() is 'custom').

Return Value

int|null

returns NULL if page is not loaded

at line 3833
int getCollectionFullPageCachingLifetimeValue()

Get the actual full-page cache lifespan (in seconds).

Return Value

int

at line 3942
static Page addStatic(array $data, TreeInterface $parent = null)

Create a new page.

Parameters

array $data

The data to be used to create the page. See Collection::createCollection() for the supported keys, plus 'pkgID' and 'filename'.
TreeInterface $parent

the parent page (or the site) that will contain the new page

Return Value

Page

See also

Collection::createCollection

at line 4000
static Page|null getCurrentPage()

Get the currently requested page.

Return Value

Page|null

at line 4013
int getPageDraftTargetParentPageID()

Get the ID of the draft parent page ID.

Return Value

int

at line 4025
setPageDraftTargetParentPageID(int $cParentID)

Set the ID of the draft parent page ID.

Parameters

int $cParentID

at line 4045
protected populatePage(mixed $cInfo, string $where, string|int $cvID)

Read the data from the database.

Parameters

mixed $cInfo

The argument of the $where condition
string $where

The SQL 'WHERE' part
string|int $cvID

at line 4096
protected _getNumChildren(int $cID, bool $oneLevelOnly = 0, string $sortColumn = 'cDisplayOrder asc')

Populate the childrenCIDArray property (called by the getCollectionChildrenArray() method).

Parameters

int $cID
bool $oneLevelOnly
string $sortColumn

at line 4123
protected _duplicateAll(mixed $cParent, mixed $cNewParent, bool $preserveUserID = false, Site $site = null)

Duplicate all the child pages of a specific page which has already have been duplicated.

Parameters

mixed $cParent
mixed $cNewParent
bool $preserveUserID

Set to true to preserve the original page author IDs
Site $site

the destination site

at line 4143
getPageSkin()

No description

at line 4171
protected string computeCanonicalPagePath()

Get the canonical path string of this page .

This happens before any uniqueness checks get run.

Return Value

string

at line 4208
protected _associateMasterCollectionBlocks(int $newCID, mixed $masterCID, bool $cAcquireComposerOutputControls)

Duplicate the master collection blocks/permissions to a newly created page.

Parameters

int $newCID

the ID of the newly created page
mixed $masterCID
bool $cAcquireComposerOutputControls

at line 4249
protected _associateMasterCollectionAttributes(int $newCID, mixed $masterCID)

Duplicate the master collection attributes to a newly created page.

Parameters

int $newCID

the ID of the newly created page
mixed $masterCID

at line 4269
protected acquireAreaStylesFromDefaults(Template $template)

Copy the area styles from a page template.

Parameters

Template $template

at line 4301
static private string[] translatePermissionsXMLToKeys(SimpleXMLElement $node)

No description

Parameters

SimpleXMLElement $node

Return Value

string[]