class Page extends Collection implements ObjectInterface, AssignableObjectInterface, TreeInterface, SiteAggregateInterface (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

Properties

protected $controller
protected $blocksAliasedFromMasterCollection
protected $cPointerOriginalID
$cPointerExternalLink
protected $cPointerExternalLinkNewWindow
protected $isMasterCollection
protected $cInheritPermissionsFromCID
protected $cIsSystemPage
protected $siteTreeID
$siteTree

Methods

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

No description

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

No description

static Page
getByID(int $cID, string $version = 'RECENT')

No description

__construct()

No description

populatePage($cInfo, $where, $cvID)

No description

getJSONObject()

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

PageController
getPageController()

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
getPackageHandle()

Get the package handle for a page (page thats added by a package).

bool
isArrangeMode()

Returns 1 if the page is in arrange mode.

forceCheckIn()

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

bool
isAdminArea()

Checks if the page is a dashboard page, returns true if it is.

static 
getFromRequest(Request $request)

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

processArrangement($area_id, $moved_block_id, $block_order)

No description

bool
isCheckedOut()

checks if the page is checked out, if it is return true.

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

removePermissions($userOrGroup, $permissions = [])

No description

static 
getDrafts(Site $site)

No description

isPageDraft()

No description

static 
translatePermissionsXMLToKeys($node)

No description

setController($controller)

No description

getController() deprecated

No description

assignPermissionSet($px)

No description

int
addCollectionAlias(Collection $c)

Make an alias to a page.

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.

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
removeThisAlias()

Remove an external link/alias.

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

No description

queueForDeletionSort($a, $b)

No description

queueForDuplicationSort($a, $b)

No description

queueForDeletion()

No description

queueForDeletionRequest($queue = null, $includeThisPage = true)

No description

queueForDuplication($destination, $includeParent = true)

No description

export($pageNode, $includePublicDate = true)

No description

int
getCollectionCheckedOutUserID()

Returns the uID for a page that is checked out.

string
getCollectionPath()

Returns the path for the current page.

getCollectionPathObject()

Returns the PagePath object for the current page.

addAdditionalPagePath($cPath, $commit = true)

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

setCanonicalPagePath($cPath, $isAutoGenerated = false)

Sets the canonical page path for a page.

getPagePaths()

No description

getAdditionalPagePaths()

No description

clearPagePaths()

Clears all page paths for a page.

string
getCollectionLink($appendBaseURL = false)

Returns full url for the current page.

getSiteTreeID()

No description

getSite()

No description

getSiteTreeObject()

No description

static string
getCollectionPathFromID($cID)

Returns the path for a page from its cID.

int
getCollectionUserID()

Returns the uID for a page ownder.

string
getCollectionHandle()

Returns the page's handle.

getCollectionTypeName() deprecated

No description

getPageTypeName()

No description

getCollectionTypeID() deprecated

No description

int
getPageTypeID()

Returns the Collection Type ID.

getPageTypeObject()

No description

int
getPageTemplateID()

Returns the Page Template ID.

PageTemplate
getPageTemplateObject()

Returns the Page Template Object.

string
getPageTemplateHandle()

Returns the Page Template handle.

string
getPageTypeHandle()

Returns the Collection Type handle.

getCollectionTypeHandle()

No description

int
getCollectionThemeID()

Returns theme id for the collection.

bool
isBlockAliasedFromMasterCollection(Block $b)

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

getCollectionThemeObject()

Returns Collection's theme object.

string
getCollectionName()

Returns the page's name.

int
getCollectionPointerID()

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

string
getCollectionPointerExternalLink()

Returns link for the aliased page.

bool
openCollectionPointerExternalLinkInNewWindow()

Returns if the alias opens in a new window.

bool
isAlias()

Checks to see if the page is an alias.

bool
isExternalLink()

Checks if a page is an external link.

int
getCollectionPointerOriginalID()

Get the original cID of a page.

string
getCollectionFilename()

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

string
getCollectionDatePublic()

Gets the date a the current version was made public,.

DateTime|null
string
getCollectionDescription()

Get the description of a page.

int
getCollectionParentID()

Gets the cID of the page's parent.

static int
getCollectionParentIDFromChildID(int $cID)

Get the Parent cID from a page by using a cID.

array
getCollectionParentIDs()

Returns an array of this cParentID and aliased parentIDs.

bool
isMasterCollection()

Checks if a page is a page default.

string
overrideTemplatePermissions()

Gets the template permissions.

int
getCollectionDisplayOrder()

Gets the position of the page in the sitemap.

setTheme(PageTheme $pl)

Set the theme for a page using the page object.

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.

getPermissionsCollectionID()

No description

getCollectionInheritance()

No description

getMasterCollectionID()

Given the current page's template and page type, we return the master page.

getOriginalCollectionID()

No description

getNumChildren()

No description

getNumChildrenDirect()

No description

getFirstChild(string $sortColumn = 'cDisplayOrder asc')

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

getCollectionChildrenArray($oneLevelOnly = 0)

No description

getCollectionChildren()

Returns the immediate children of the current page.

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

No description

canMoveCopyTo($cobj)

No description

updateCollectionName($name)

No description

hasPageThemeCustomizations()

No description

resetCustomThemeStyles()

No description

setCustomStyleObject(Theme $pt, ValueList $valueList, $selectedPreset = false, CustomCssRecord $customCssRecord = null)

No description

getPageWrapperClass()

No description

writePageThemeCustomizations()

No description

static 
resetAllCustomStyles()

No description

update($data)

No description

clearPagePermissions()

No description

inheritPermissionsFromParent()

No description

rescanAreaPermissions()

No description

setOverrideTemplatePermissions($cOverrideTemplatePermissions)

No description

updatePermissionsCollectionID($cParentIDString, $npID)

No description

acquireAreaPermissions($permissionsCollectionID)

No description

acquirePagePermissions($permissionsCollectionID)

No description

__destruct()

No description

updateGroupsSubCollection($cParentIDString)

No description

addBlock($bt, $a, $data)

No description

getPageRelations()

No description

move($nc)

No description

duplicateAll($nc = null, $preserveUserID = false, Site $site = null)

No description

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

No description

duplicate($nc = null, $preserveUserID = false, TreeInterface $site = null)

No description

delete()

No description

moveToTrash()

No description

rescanChildrenDisplayOrder()

No description

isHomePage()

No description

getSiteHomePageID()

No description

getNextSubPageDisplayOrder()

No description

generatePagePath()

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

rescanCollectionPath()

Recalculates the canonical page path for the current page, based on its current version, URL slug, etc.

string
computeCanonicalPagePath()

For the curret page, return the text that will be used for that pages canonical path. This happens before any uniqueness checks get run.

updateDisplayOrder($do, $cID = 0)

No description

movePageDisplayOrderToTop()

No description

movePageDisplayOrderToBottom()

No description

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

No description

rescanSystemPageStatus()

Looks at the current page. If the site tree ID is 0, sets system page to true.

isInTrash()

No description

moveToRoot()

No description

deactivate()

No description

activate()

No description

isActive()

No description

setPageIndexScore($score)

No description

getPageIndexScore()

No description

getPageIndexContent()

No description

_associateMasterCollectionBlocks($newCID, $masterCID, $cAcquireComposerOutputControls)

No description

_associateMasterCollectionAttributes($newCID, $masterCID)

No description

static page
addHomePage(TreeInterface $siteTree = null)

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

page
add(Type $pt, array $data, $template = false)

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: "uID": User ID of the page's owner "pkgID": Package ID the page belongs to "cName": The name of the page "cHandle": The handle of the page as used in the path "cDatePublic": The date assigned to the page.

acquireAreaStylesFromDefaults(Template $template)

No description

getCustomStyleObject()

No description

getCollectionFullPageCaching()

No description

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

No description

static 
getCurrentPage()

No description

getTotalPageViews($date = null)

Returns the total number of page views for a specific page.

setPageDraftTargetParentPageID($cParentID)

No description

getPageStatistics($limit = 20)

Gets a pages statistics.

Details

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

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

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

No description

Parameters

string $path /path/to/page
string $version

ACTIVE or RECENT

TreeInterface $tree

Return Value

Page

static Page getByID(int $cID, string $version = 'RECENT')

No description

Parameters

int $cID

Collection ID of a page

string $version

ACTIVE or RECENT

Return Value

Page

__construct()

No description

protected populatePage($cInfo, $where, $cvID)

No description

Parameters

$cInfo
$where
$cvID

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

getJSONObject()

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

PageController getPageController()

No description

Return Value

PageController

getPermissionObjectIdentifier()

No description

bool isEditMode()

Is the page in edit mode.

Return Value

bool

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

string getPackageHandle()

Get the package handle for a page (page thats added by a package).

Return Value

string

bool isArrangeMode()

Returns 1 if the page is in arrange mode.

Return Value

bool

forceCheckIn()

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

bool isAdminArea()

Checks if the page is a dashboard page, returns true if it is.

Return Value

bool

static getFromRequest(Request $request)

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

Parameters

Request $request

processArrangement($area_id, $moved_block_id, $block_order)

No description

Parameters

$area_id
$moved_block_id
$block_order

bool isCheckedOut()

checks if the page is checked out, if it is return true.

Return Value

bool

getCollectionCheckedOutUserName()

Gets the user that is editing the current page.

$return string $name.

bool isCheckedOutByMe()

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

Return Value

bool

bool isGeneratedCollection()

Checks if the page is a single page.

Return Value

bool

setPermissionsToOverride()

No description

setChildPermissionsToOverride()

No description

removePermissions($userOrGroup, $permissions = [])

No description

Parameters

$userOrGroup
$permissions

static getDrafts(Site $site)

No description

Parameters

Site $site

isPageDraft()

No description

static private translatePermissionsXMLToKeys($node)

No description

Parameters

$node

setController($controller)

No description

Parameters

$controller

getController() deprecated

deprecated

No description

private assignPermissionSet($px)

No description

Parameters

$px

int addCollectionAlias(Collection $c)

Make an alias to a page.

Parameters

Collection $c

Return Value

int $newCID

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

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

Add a new external link.

Parameters

string $cName
string $cLink
bool $newWindow

Return Value

int $newCID

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

string getCollectionIcon()

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

Return Value

string

$icon Path to the icon

int removeThisAlias()

Remove an external link/alias.

Return Value

int

$cIDRedir cID for the original page if the page was an alias

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

No description

Parameters

$pages
$pageRow
$cParentID
$level
$includeThisPage

queueForDeletionSort($a, $b)

No description

Parameters

$a
$b

queueForDuplicationSort($a, $b)

No description

Parameters

$a
$b

queueForDeletion()

No description

queueForDeletionRequest($queue = null, $includeThisPage = true)

No description

Parameters

$queue
$includeThisPage

queueForDuplication($destination, $includeParent = true)

No description

Parameters

$destination
$includeParent

export($pageNode, $includePublicDate = true)

No description

Parameters

$pageNode
$includePublicDate

int getCollectionCheckedOutUserID()

Returns the uID for a page that is checked out.

Return Value

int

string getCollectionPath()

Returns the path for the current page.

Return Value

string

getCollectionPathObject()

Returns the PagePath object for the current page.

addAdditionalPagePath($cPath, $commit = true)

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

Parameters

$cPath
$commit

setCanonicalPagePath($cPath, $isAutoGenerated = false)

Sets the canonical page path for a page.

Parameters

$cPath
$isAutoGenerated

getPagePaths()

No description

getAdditionalPagePaths()

No description

clearPagePaths()

Clears all page paths for a page.

Returns full url for the current page.

Parameters

$appendBaseURL

Return Value

string

getSiteTreeID()

No description

Site getSite()

No description

Return Value

Site

Tree getSiteTreeObject()

No description

Return Value

Tree

static string getCollectionPathFromID($cID)

Returns the path for a page from its cID.

Parameters

$cID

Return Value

string $path

int getCollectionUserID()

Returns the uID for a page ownder.

Return Value

int

string getCollectionHandle()

Returns the page's handle.

Return Value

string

getCollectionTypeName() deprecated

deprecated

No description

getPageTypeName()

No description

getCollectionTypeID() deprecated

deprecated

No description

int getPageTypeID()

Returns the Collection Type ID.

Return Value

int

getPageTypeObject()

No description

int getPageTemplateID()

Returns the Page Template ID.

Return Value

int

PageTemplate getPageTemplateObject()

Returns the Page Template Object.

Return Value

PageTemplate

string getPageTemplateHandle()

Returns the Page Template handle.

Return Value

string

string getPageTypeHandle()

Returns the Collection Type handle.

Return Value

string

getCollectionTypeHandle()

No description

int getCollectionThemeID()

Returns theme id for the collection.

Return Value

int

bool isBlockAliasedFromMasterCollection(Block $b)

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

Parameters

Block $b

Return Value

bool

Theme getCollectionThemeObject()

Returns Collection's theme object.

Return Value

Theme

string getCollectionName()

Returns the page's name.

Return Value

string

int getCollectionPointerID()

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

Return Value

int

Returns link for the aliased page.

Return Value

string

bool openCollectionPointerExternalLinkInNewWindow()

Returns if the alias opens in a new window.

Return Value

bool

bool isAlias()

Checks to see if the page is an alias.

Return Value

bool

Checks if a page is an external link.

Return Value

bool

int getCollectionPointerOriginalID()

Get the original cID of a page.

Return Value

int

string getCollectionFilename()

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

Return Value

string

string getCollectionDatePublic()

Gets the date a the current version was made public,.

Return Value

string

date formated like: 2009-01-01 00:00:00

DateTime|null getCollectionDatePublicObject()

No description

Return Value

DateTime|null

Returns the \DateTime instance (or null if the current version doesn't have public date)

string getCollectionDescription()

Get the description of a page.

Return Value

string

int getCollectionParentID()

Gets the cID of the page's parent.

Return Value

int

static int getCollectionParentIDFromChildID(int $cID)

Get the Parent cID from a page by using a cID.

Parameters

int $cID

Return Value

int

array getCollectionParentIDs()

Returns an array of this cParentID and aliased parentIDs.

Return Value

array $cID

bool isMasterCollection()

Checks if a page is a page default.

Return Value

bool

string overrideTemplatePermissions()

Gets the template permissions.

Return Value

string

int getCollectionDisplayOrder()

Gets the position of the page in the sitemap.

Return Value

int

setTheme(PageTheme $pl)

Set the theme for a page using the page object.

Parameters

PageTheme $pl

setPageType(Type $type = null)

Set the theme for a page using the page object.

Parameters

Type $type

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.

getPermissionsCollectionID()

No description

getCollectionInheritance()

No description

getParentPermissionsCollectionID()

No description

getPermissionsCollectionObject()

No description

getMasterCollectionID()

Given the current page's template and page type, we return the master page.

getOriginalCollectionID()

No description

getNumChildren()

No description

getNumChildrenDirect()

No description

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

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

Parameters

string $sortColumn

Return Value

Page

getCollectionChildrenArray($oneLevelOnly = 0)

No description

Parameters

$oneLevelOnly

getCollectionChildren()

Returns the immediate children of the current page.

protected _getNumChildren($cID, $oneLevelOnly = 0, $sortColumn = 'cDisplayOrder asc')

No description

Parameters

$cID
$oneLevelOnly
$sortColumn

canMoveCopyTo($cobj)

No description

Parameters

$cobj

updateCollectionName($name)

No description

Parameters

$name

hasPageThemeCustomizations()

No description

resetCustomThemeStyles()

No description

setCustomStyleObject(Theme $pt, ValueList $valueList, $selectedPreset = false, CustomCssRecord $customCssRecord = null)

No description

Parameters

Theme $pt
ValueList $valueList
$selectedPreset
CustomCssRecord $customCssRecord

getPageWrapperClass()

No description

writePageThemeCustomizations()

No description

static resetAllCustomStyles()

No description

update($data)

No description

Parameters

$data

clearPagePermissions()

No description

inheritPermissionsFromParent()

No description

inheritPermissionsFromDefaults()

No description

setPermissionsToManualOverride()

No description

rescanAreaPermissions()

No description

setOverrideTemplatePermissions($cOverrideTemplatePermissions)

No description

Parameters

$cOverrideTemplatePermissions

updatePermissionsCollectionID($cParentIDString, $npID)

No description

Parameters

$cParentIDString
$npID

acquireAreaPermissions($permissionsCollectionID)

No description

Parameters

$permissionsCollectionID

acquirePagePermissions($permissionsCollectionID)

No description

Parameters

$permissionsCollectionID

__destruct()

No description

updateGroupsSubCollection($cParentIDString)

No description

Parameters

$cParentIDString

addBlock($bt, $a, $data)

No description

Parameters

$bt
$a
$data

getPageRelations()

No description

move($nc)

No description

Parameters

$nc

duplicateAll($nc = null, $preserveUserID = false, Site $site = null)

No description

Parameters

$nc
$preserveUserID
Site $site

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

No description

Parameters

$cParent
$cNewParent
$preserveUserID
Site $site

duplicate($nc = null, $preserveUserID = false, TreeInterface $site = null)

No description

Parameters

$nc
$preserveUserID
TreeInterface $site

delete()

No description

moveToTrash()

No description

rescanChildrenDisplayOrder()

No description

isHomePage()

No description

getSiteHomePageID()

No description

getAutoGeneratedPagePathObject()

No description

getNextSubPageDisplayOrder()

No description

generatePagePath()

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

rescanCollectionPath()

Recalculates the canonical page path for the current page, based on its current version, URL slug, etc.

.

protected string computeCanonicalPagePath()

For the curret page, return the text that will be used for that pages canonical path. This happens before any uniqueness checks get run.

Return Value

string

updateDisplayOrder($do, $cID = 0)

No description

Parameters

$do
$cID

movePageDisplayOrderToTop()

No description

movePageDisplayOrderToBottom()

No description

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

No description

Parameters

Page $c
$position

rescanSystemPageStatus()

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.

isInTrash()

No description

moveToRoot()

No description

deactivate()

No description

activate()

No description

isActive()

No description

setPageIndexScore($score)

No description

Parameters

$score

getPageIndexScore()

No description

getPageIndexContent()

No description

protected _associateMasterCollectionBlocks($newCID, $masterCID, $cAcquireComposerOutputControls)

No description

Parameters

$newCID
$masterCID
$cAcquireComposerOutputControls

protected _associateMasterCollectionAttributes($newCID, $masterCID)

No description

Parameters

$newCID
$masterCID

static page addHomePage(TreeInterface $siteTree = null)

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

Parameters

TreeInterface $siteTree

Return Value

page

page add(Type $pt, array $data, $template = false)

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: "uID": User ID of the page's owner "pkgID": Package ID the page belongs to "cName": The name of the page "cHandle": The handle of the page as used in the path "cDatePublic": The date assigned to the page.

Parameters

Type $pt
array $data
$template

Return Value

page

protected acquireAreaStylesFromDefaults(Template $template)

No description

Parameters

Template $template

getCustomStyleObject()

No description

getCollectionFullPageCaching()

No description

getCollectionFullPageCachingLifetime()

No description

getCollectionFullPageCachingLifetimeCustomValue()

No description

getCollectionFullPageCachingLifetimeValue()

No description

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

No description

Parameters

$data
TreeInterface $parent

static getCurrentPage()

No description

getTotalPageViews($date = null)

Returns the total number of page views for a specific page.

Parameters

$date

getPageDraftTargetParentPageID()

No description

setPageDraftTargetParentPageID($cParentID)

No description

Parameters

$cParentID

getPageStatistics($limit = 20)

Gets a pages statistics.

Parameters

$limit