1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Multilingual
  7. \
  8. Page
  9. \
  10. Section
  11. \
  12. Section

Section

class Section extends Page (View source)

Traits

AssignableObjectTrait

Properties

protected $controller from  Page
protected $blocksAliasedFromMasterCollection from  Page
protected $cPointerOriginalID from  Page
$cPointerExternalLink from  Page
protected $cPointerExternalLinkNewWindow from  Page
protected $isMasterCollection from  Page
protected $cInheritPermissionsFromCID from  Page
protected $cIsSystemPage from  Page
protected $siteTreeID from  Page
$siteTree from  Page
protected Locale $locale

Methods

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

No description

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

No description

from  Page
CategoryInterface
getObjectAttributeCategory()

No description

from  Page
static Page
getByID(int $cID, int|string $cvID = 'RECENT')

Returns an instance of MultilingualSection for the given page ID.

__construct()

No description

from  Page
ItemInterface
getExporter()

No description

from  Page
populatePage($cInfo, $where, $cvID)

No description

from  Page
getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

from  Page
getPermissionObjectKeyCategoryHandle()

No description

getJSONObject()

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

from  Page
PageController
getPageController()

No description

from  Page
getPermissionObjectIdentifier()

No description

from  Page
bool
isEditMode()

Is the page in edit mode.

from  Page
int
getPackageID()

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

from  Page
string
getPackageHandle()

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

from  Page
bool
isArrangeMode()

Returns 1 if the page is in arrange mode.

from  Page
forceCheckIn()

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

from  Page
static 
forceCheckInForAllPages()

No description

from  Page
bool
isAdminArea()

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

from  Page
static 
getFromRequest(Request $request)

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

from  Page
processArrangement($area_id, $moved_block_id, $block_order)

No description

from  Page
bool
isCheckedOut()

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

from  Page
getCollectionCheckedOutUserName()

Gets the user that is editing the current page.

from  Page
bool
isCheckedOutByMe()

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

from  Page
bool
isGeneratedCollection()

Checks if the page is a single page.

from  Page
setPermissionsToOverride()

No description

from  Page
setChildPermissionsToOverride()

No description

from  Page
removePermissions($userOrGroup, $permissions = [])

No description

from  Page
static 
getDraftsParentPage(Site $site = null)

No description

from  Page
static 
getDrafts(Site $site)

No description

from  Page
isPageDraft()

No description

from  Page
static 
translatePermissionsXMLToKeys($node)

No description

from  Page
setController($controller)

No description

from  Page
getController() deprecated

No description

from  Page
assignPermissionSet($px)

No description

from  Page
int
addCollectionAlias(Collection $c)

Make an alias to a page.

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

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

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

Add a new external link.

from  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.

from  Page
string
getCollectionIcon()

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

from  Page
int
removeThisAlias()

Remove an external link/alias.

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

No description

from  Page
queueForDeletionSort($a, $b)

No description

from  Page
queueForDuplicationSort($a, $b)

No description

from  Page
queueForDeletion()

No description

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

No description

from  Page
queueForDuplication($destination, $includeParent = true)

No description

from  Page
export($pageNode) deprecated

No description

from  Page
int
getCollectionCheckedOutUserID()

Returns the uID for a page that is checked out.

from  Page
string
getCollectionPath()

Returns the path for the current page.

from  Page
getCollectionPathObject()

Returns the PagePath object for the current page.

from  Page
addAdditionalPagePath($cPath, $commit = true)

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

from  Page
setCanonicalPagePath($cPath, $isAutoGenerated = false)

Sets the canonical page path for a page.

from  Page
getPagePaths()

No description

from  Page
getAdditionalPagePaths()

No description

from  Page
clearPagePaths()

Clears all page paths for a page.

from  Page
string
getCollectionLink($appendBaseURL = false)

Returns full url for the current page.

from  Page
int|null
getSiteTreeID()

No description

from  Page
Site
getSite()

No description

from  Page
Tree|null
getSiteTreeObject()

No description

from  Page
static string
getCollectionPathFromID($cID)

Returns the path for a page from its cID.

from  Page
int
getCollectionUserID()

Returns the uID for a page ownder.

from  Page
string
getCollectionHandle()

Returns the page's handle.

from  Page
getCollectionTypeName() deprecated

No description

from  Page
getPageTypeName()

No description

from  Page
getCollectionTypeID() deprecated

No description

from  Page
int
getPageTypeID()

Returns the Collection Type ID.

from  Page
getPageTypeObject()

No description

from  Page
int
getPageTemplateID()

Returns the Page Template ID.

from  Page
PageTemplate
getPageTemplateObject()

Returns the Page Template Object.

from  Page
string
getPageTemplateHandle()

Returns the Page Template handle.

from  Page
string
getPageTypeHandle()

Returns the Collection Type handle.

from  Page
getCollectionTypeHandle()

No description

from  Page
int
getCollectionThemeID()

Returns theme id for the collection.

from  Page
bool
isBlockAliasedFromMasterCollection(Block $b)

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

from  Page
Theme
getCollectionThemeObject()

Returns Collection's theme object.

from  Page
string
getCollectionName()

Returns the page's name.

from  Page
int
getCollectionPointerID()

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

from  Page
string
getCollectionPointerExternalLink()

Returns link for the aliased page.

from  Page
bool
openCollectionPointerExternalLinkInNewWindow()

Returns if the alias opens in a new window.

from  Page
bool
isAlias()

Checks to see if the page is an alias.

from  Page
bool
isExternalLink()

Checks if a page is an external link.

from  Page
int
getCollectionPointerOriginalID()

Get the original cID of a page.

from  Page
string
getCollectionFilename()

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

from  Page
string
getCollectionDatePublic()

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

from  Page
DateTime|null
getCollectionDatePublicObject()

No description

from  Page
string
getCollectionDescription()

Get the description of a page.

from  Page
int
getCollectionParentID()

Gets the cID of the page's parent.

from  Page
static int
getCollectionParentIDFromChildID(int $cID)

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

from  Page
array
getCollectionParentIDs()

Returns an array of this cParentID and aliased parentIDs.

from  Page
bool
isMasterCollection()

Checks if a page is a page default.

from  Page
string
overrideTemplatePermissions()

Gets the template permissions.

from  Page
int
getCollectionDisplayOrder()

Gets the position of the page in the sitemap.

from  Page
setTheme(PageTheme $pl)

Set the theme for a page using the page object.

from  Page
setPageType(Type $type = null)

Set the theme for a page using the page object.

from  Page
setPermissionsInheritanceToTemplate()

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

from  Page
setPermissionsInheritanceToOverride()

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

from  Page
getPermissionsCollectionID()

No description

from  Page
getCollectionInheritance()

No description

from  Page
getParentPermissionsCollectionID()

No description

from  Page
getPermissionsCollectionObject()

No description

from  Page
getMasterCollectionID()

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

from  Page
getOriginalCollectionID()

No description

from  Page
getNumChildren()

No description

from  Page
getNumChildrenDirect()

No description

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

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

from  Page
getCollectionChildrenArray($oneLevelOnly = 0)

No description

from  Page
getCollectionChildren()

Returns the immediate children of the current page.

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

No description

from  Page
canMoveCopyTo($cobj)

No description

from  Page
updateCollectionName($name)

No description

from  Page
hasPageThemeCustomizations()

No description

from  Page
resetCustomThemeStyles()

No description

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

No description

from  Page
getPageWrapperClass()

No description

from  Page
writePageThemeCustomizations()

No description

from  Page
static 
resetAllCustomStyles()

No description

from  Page
update($data)

No description

from  Page
clearPagePermissions()

No description

from  Page
inheritPermissionsFromParent()

No description

from  Page
inheritPermissionsFromDefaults()

No description

from  Page
setPermissionsToManualOverride()

No description

from  Page
rescanAreaPermissions()

No description

from  Page
setOverrideTemplatePermissions($cOverrideTemplatePermissions)

No description

from  Page
updatePermissionsCollectionID($cParentIDString, $npID)

No description

from  Page
acquireAreaPermissions($permissionsCollectionID)

No description

from  Page
acquirePagePermissions($permissionsCollectionID)

No description

from  Page
__destruct()

No description

from  Page
updateGroupsSubCollection($cParentIDString)

No description

from  Page
Block
addBlock(BlockType $bt, Area $a, array $data)

Adds a block to the page.

from  Page
getPageRelations()

No description

from  Page
move($nc)

No description

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

No description

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

No description

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

No description

from  Page
delete()

No description

from  Page
moveToTrash()

No description

from  Page
rescanChildrenDisplayOrder()

No description

from  Page
isHomePage()

No description

from  Page
int|null
getSiteHomePageID()

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

from  Page
bool
isLocaleHomePage()

Is this page the homepage of a site tree?

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

Get the ID of the home page.

from  Page
getAutoGeneratedPagePathObject()

No description

from  Page
getNextSubPageDisplayOrder()

No description

from  Page
generatePagePath()

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

from  Page
rescanCollectionPath()

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

from  Page
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.

from  Page
updateDisplayOrder($do, $cID = 0)

No description

from  Page
movePageDisplayOrderToTop()

No description

from  Page
movePageDisplayOrderToBottom()

No description

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

No description

from  Page
rescanSystemPageStatus()

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

from  Page
isInTrash()

No description

from  Page
moveToRoot()

No description

from  Page
deactivate()

No description

from  Page
setPageToDraft()

No description

from  Page
activate()

No description

from  Page
isActive()

No description

from  Page
setPageIndexScore($score)

No description

from  Page
getPageIndexScore()

No description

from  Page
getPageIndexContent()

No description

from  Page
_associateMasterCollectionBlocks($newCID, $masterCID, $cAcquireComposerOutputControls)

No description

from  Page
_associateMasterCollectionAttributes($newCID, $masterCID)

No description

from  Page
static page
addHomePage(TreeInterface $siteTree = null)

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

from  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.

from  Page
acquireAreaStylesFromDefaults(Template $template)

No description

from  Page
getCustomStyleObject()

No description

from  Page
getCollectionFullPageCaching()

No description

from  Page
getCollectionFullPageCachingLifetime()

No description

from  Page
getCollectionFullPageCachingLifetimeCustomValue()

No description

from  Page
getCollectionFullPageCachingLifetimeValue()

No description

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

No description

from  Page
static 
getCurrentPage()

No description

from  Page
getPageDraftTargetParentPageID()

No description

from  Page
setPageDraftTargetParentPageID($cParentID)

No description

from  Page
static 
isMultilingualSection($cID)

No description

static 
getLocaleFromHomePageID($cID)

No description

setLocale($locale)

No description

static Section
getBySectionOfSite(Page $page)

No description

getLanguageText($locale = null)

No description

getLanguage()

No description

getIcon()

No description

getCountry()

No description

int
getNumberOfPluralForms()

Returns the number of plural forms.

string
getPluralsRule()

Returns the rule to determine which plural we should use (in gettext notation).

array
getPluralsCases()

Returns the plural cases for the language; array keys are the case name, array values are some examples for that case.

static 
getIDList(Site $site = null)

No description

static 
getList(Site $site = null)

No description

static 
getRelatedCollectionIDForLocale($cID, $locale)

No description

static 
getMultilingualPageRelationID($cID)

No description

static 
isAssigned($page)

No description

static 
getCollectionIDForLocale($mpRelationID, $locale)

No description

static 
registerDuplicate($newPage, $oldPage)

No description

static Section|false
getByLanguage(string $language, Site $site = null)

No description

static Section|false
getByLocale($locale, Site $site = null)

No description

static Section
getCurrentSection()

Gets the MultilingualSection object for the current section of the site.

static 
getByLocaleOrLanguage($locale)

No description

getLocaleObject()

No description

getLocale()

No description

static 
getDefaultSection(Site $site = null)

No description

static 
unregisterPage($page)

No description

static 
registerPage($page)

No description

static 
registerMove($page, $oldParent, $newParent)

No description

static 
relatePage($oldPage, $newPage, $locale)

No description

isDefaultMultilingualSection(Site $site = null)

No description

static 
ignorePageRelation($page, $locale)

No description

int|null
getTranslatedPageID($page)

Receives a page in a different language tree, and tries to return the corresponding page in the current language tree.

Translations
getSectionInterfaceTranslations(bool $untranslatedFirst = false)

Loads the translations of this multilingual section.

Details

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

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

in Page at line 83
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

in Page at line 109
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

at line 73
static Page getByID(int $cID, int|string $cvID = 'RECENT')

Returns an instance of MultilingualSection for the given page ID.

Parameters

int $cID

Collection ID of a page
int|string $cvID

Return Value

Page

in Page at line 143
__construct()

No description

in Page at line 148
ItemInterface getExporter()

No description

Return Value

ItemInterface

in Page at line 153
protected populatePage($cInfo, $where, $cvID)

No description

Parameters

$cInfo
$where
$cvID

at line 54
getPermissionResponseClassName()

No description

in Page at line 213
getPermissionAssignmentClassName()

No description

at line 59
getPermissionObjectKeyCategoryHandle()

No description

in Page at line 226
getJSONObject()

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

in Page at line 242
PageController getPageController()

No description

Return Value

PageController

in Page at line 274
getPermissionObjectIdentifier()

No description

in Page at line 292
bool isEditMode()

Is the page in edit mode.

Return Value

bool

in Page at line 309
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

in Page at line 319
string getPackageHandle()

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

Return Value

string

in Page at line 333
bool isArrangeMode()

Returns 1 if the page is in arrange mode.

Return Value

bool

in Page at line 341
forceCheckIn()

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

in Page at line 354
static private forceCheckInForAllPages()

No description

in Page at line 366
bool isAdminArea()

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

Return Value

bool

in Page at line 381
static getFromRequest(Request $request)

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

Parameters

Request $request

in Page at line 443
processArrangement($area_id, $moved_block_id, $block_order)

No description

Parameters

$area_id
$moved_block_id
$block_order

in Page at line 476
bool isCheckedOut()

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

Return Value

bool

in Page at line 516
getCollectionCheckedOutUserName()

Gets the user that is editing the current page.

$return string $name.

in Page at line 537
bool isCheckedOutByMe()

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

Return Value

bool

in Page at line 549
bool isGeneratedCollection()

Checks if the page is a single page.

Return Value

bool

in Page at line 555
setPermissionsToOverride()

No description

in Page at line 562
setChildPermissionsToOverride()

No description

in Page at line 569
removePermissions($userOrGroup, $permissions = [])

No description

Parameters

$userOrGroup
$permissions

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

No description

Parameters

Site $site

in Page at line 608
static getDrafts(Site $site)

No description

Parameters

Site $site

in Page at line 624
isPageDraft()

No description

in Page at line 633
static private translatePermissionsXMLToKeys($node)

No description

Parameters

$node

in Page at line 664
setController($controller)

No description

Parameters

$controller

in Page at line 672
getController() deprecated

deprecated

No description

in Page at line 680
private assignPermissionSet($px)

No description

Parameters

$px

in Page at line 716
int addCollectionAlias(Collection $c)

Make an alias to a page.

Parameters

Collection $c

Return Value

int $newCID

in Page at line 767
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

in Page at line 791
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

in Page at line 845
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

in Page at line 855
string getCollectionIcon()

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

Return Value

string

$icon Path to the icon

in Page at line 900
int removeThisAlias()

Remove an external link/alias.

Return Value

int

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

in Page at line 929
populateRecursivePages($pages, $pageRow, $cParentID, $level, $includeThisPage = true)

No description

Parameters

$pages
$pageRow
$cParentID
$level
$includeThisPage

in Page at line 953
queueForDeletionSort($a, $b)

No description

Parameters

$a
$b

in Page at line 965
queueForDuplicationSort($a, $b)

No description

Parameters

$a
$b

in Page at line 989
queueForDeletion()

No description

in Page at line 1007
queueForDeletionRequest($queue = null, $includeThisPage = true)

No description

Parameters

$queue
$includeThisPage

in Page at line 1022
queueForDuplication($destination, $includeParent = true)

No description

Parameters

$destination
$includeParent

in Page at line 1039
export($pageNode) deprecated

deprecated

No description

Parameters

$pageNode

in Page at line 1050
int getCollectionCheckedOutUserID()

Returns the uID for a page that is checked out.

Return Value

int

in Page at line 1060
string getCollectionPath()

Returns the path for the current page.

Return Value

string

in Page at line 1068
getCollectionPathObject()

Returns the PagePath object for the current page.

in Page at line 1082
addAdditionalPagePath($cPath, $commit = true)

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

Parameters

$cPath
$commit

in Page at line 1099
setCanonicalPagePath($cPath, $isAutoGenerated = false)

Sets the canonical page path for a page.

Parameters

$cPath
$isAutoGenerated

in Page at line 1116
getPagePaths()

No description

in Page at line 1125
getAdditionalPagePaths()

No description

in Page at line 1137
clearPagePaths()

Clears all page paths for a page.

Returns full url for the current page.

Parameters

$appendBaseURL

Return Value

string

in Page at line 1157
int|null getSiteTreeID()

No description

Return Value

int|null

in Page at line 1162
Site getSite()

No description

Return Value

Site

in Page at line 1175
Tree|null getSiteTreeObject()

No description

Return Value

Tree|null

See also

TreeInterface::getSiteTreeObject

in Page at line 1191
static string getCollectionPathFromID($cID)

Returns the path for a page from its cID.

Parameters

$cID

Return Value

string $path

in Page at line 1204
int getCollectionUserID()

Returns the uID for a page ownder.

Return Value

int

in Page at line 1214
string getCollectionHandle()

Returns the page's handle.

Return Value

string

in Page at line 1222
getCollectionTypeName() deprecated

deprecated

No description

in Page at line 1227
getPageTypeName()

No description

in Page at line 1240
getCollectionTypeID() deprecated

deprecated

No description

in Page at line 1250
int getPageTypeID()

Returns the Collection Type ID.

Return Value

int

in Page at line 1255
getPageTypeObject()

No description

in Page at line 1265
int getPageTemplateID()

Returns the Page Template ID.

Return Value

int

in Page at line 1275
PageTemplate getPageTemplateObject()

Returns the Page Template Object.

Return Value

PageTemplate

in Page at line 1285
string getPageTemplateHandle()

Returns the Page Template handle.

Return Value

string

in Page at line 1300
string getPageTypeHandle()

Returns the Collection Type handle.

Return Value

string

in Page at line 1316
getCollectionTypeHandle()

No description

in Page at line 1326
int getCollectionThemeID()

Returns theme id for the collection.

Return Value

int

in Page at line 1341
bool isBlockAliasedFromMasterCollection(Block $b)

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

Parameters

Block $b

Return Value

bool

in Page at line 1371
Theme getCollectionThemeObject()

Returns Collection's theme object.

Return Value

Theme

in Page at line 1405
string getCollectionName()

Returns the page's name.

Return Value

string

in Page at line 1419
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

in Page at line 1439
bool openCollectionPointerExternalLinkInNewWindow()

Returns if the alias opens in a new window.

Return Value

bool

in Page at line 1449
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

in Page at line 1469
int getCollectionPointerOriginalID()

Get the original cID of a page.

Return Value

int

in Page at line 1479
string getCollectionFilename()

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

Return Value

string

in Page at line 1489
string getCollectionDatePublic()

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

Return Value

string

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

in Page at line 1497
DateTime|null getCollectionDatePublicObject()

No description

Return Value

DateTime|null

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

in Page at line 1507
string getCollectionDescription()

Get the description of a page.

Return Value

string

in Page at line 1517
int getCollectionParentID()

Gets the cID of the page's parent.

Return Value

int

in Page at line 1531
static int getCollectionParentIDFromChildID(int $cID)

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

Parameters

int $cID

Return Value

int

in Page at line 1545
array getCollectionParentIDs()

Returns an array of this cParentID and aliased parentIDs.

Return Value

array $cID

in Page at line 1562
bool isMasterCollection()

Checks if a page is a page default.

Return Value

bool

in Page at line 1572
string overrideTemplatePermissions()

Gets the template permissions.

Return Value

string

in Page at line 1582
int getCollectionDisplayOrder()

Gets the position of the page in the sitemap.

Return Value

int

in Page at line 1592
setTheme(PageTheme $pl)

Set the theme for a page using the page object.

Parameters

PageTheme $pl

in Page at line 1603
setPageType(Type $type = null)

Set the theme for a page using the page object.

Parameters

Type $type

in Page at line 1617
setPermissionsInheritanceToTemplate()

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

in Page at line 1628
setPermissionsInheritanceToOverride()

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

in Page at line 1636
getPermissionsCollectionID()

No description

in Page at line 1641
getCollectionInheritance()

No description

in Page at line 1646
getParentPermissionsCollectionID()

No description

in Page at line 1661
getPermissionsCollectionObject()

No description

in Page at line 1669
getMasterCollectionID()

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

in Page at line 1684
getOriginalCollectionID()

No description

in Page at line 1692
getNumChildren()

No description

in Page at line 1697
getNumChildrenDirect()

No description

in Page at line 1717
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

in Page at line 1728
getCollectionChildrenArray($oneLevelOnly = 0)

No description

Parameters

$oneLevelOnly

in Page at line 1739
getCollectionChildren()

Returns the immediate children of the current page.

in Page at line 1757
protected _getNumChildren($cID, $oneLevelOnly = 0, $sortColumn = 'cDisplayOrder asc')

No description

Parameters

$cID
$oneLevelOnly
$sortColumn

in Page at line 1774
canMoveCopyTo($cobj)

No description

Parameters

$cobj

in Page at line 1783
updateCollectionName($name)

No description

Parameters

$name

in Page at line 1806
hasPageThemeCustomizations()

No description

in Page at line 1815
resetCustomThemeStyles()

No description

in Page at line 1822
setCustomStyleObject(Theme $pt, ValueList $valueList, $selectedPreset = false, CustomCssRecord $customCssRecord = null)

No description

Parameters

Theme $pt
ValueList $valueList
$selectedPreset
CustomCssRecord $customCssRecord

in Page at line 1855
getPageWrapperClass()

No description

in Page at line 1877
writePageThemeCustomizations()

No description

in Page at line 1898
static resetAllCustomStyles()

No description

in Page at line 1905
update($data)

No description

Parameters

$data

in Page at line 2060
clearPagePermissions()

No description

in Page at line 2067
inheritPermissionsFromParent()

No description

in Page at line 2081
inheritPermissionsFromDefaults()

No description

in Page at line 2101
setPermissionsToManualOverride()

No description

in Page at line 2119
rescanAreaPermissions()

No description

in Page at line 2129
setOverrideTemplatePermissions($cOverrideTemplatePermissions)

No description

Parameters

$cOverrideTemplatePermissions

in Page at line 2138
updatePermissionsCollectionID($cParentIDString, $npID)

No description

Parameters

$cParentIDString
$npID

in Page at line 2157
acquireAreaPermissions($permissionsCollectionID)

No description

Parameters

$permissionsCollectionID

in Page at line 2186
acquirePagePermissions($permissionsCollectionID)

No description

Parameters

$permissionsCollectionID

in Page at line 2203
__destruct()

No description

in Page at line 2208
updateGroupsSubCollection($cParentIDString)

No description

Parameters

$cParentIDString

in Page at line 2236
Block addBlock(BlockType $bt, Area $a, array $data)

Adds a block to the page.

Parameters

BlockType $bt

The type of block to be added.
Area $a

The area the block will appear.
array $data

An array of settings for the block.

Return Value

Block

in Page at line 2279
getPageRelations()

No description

in Page at line 2296
move($nc)

No description

Parameters

$nc

in Page at line 2377
duplicateAll($nc = null, $preserveUserID = false, Site $site = null)

No description

Parameters

$nc
$preserveUserID
Site $site

in Page at line 2385
protected _duplicateAll($cParent, $cNewParent, $preserveUserID = false, Site $site = null)

No description

Parameters

$cParent
$cNewParent
$preserveUserID
Site $site

in Page at line 2405
duplicate($nc = null, $preserveUserID = false, TreeInterface $site = null)

No description

Parameters

$nc
$preserveUserID
TreeInterface $site

in Page at line 2514
delete()

No description

in Page at line 2589
moveToTrash()

No description

in Page at line 2617
rescanChildrenDisplayOrder()

No description

in Page at line 2633
isHomePage()

No description

in Page at line 2643
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

in Page at line 2653
bool isLocaleHomePage()

Is this page the homepage of a site tree?

Return Value

bool

in Page at line 2665
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.

in Page at line 2689
getAutoGeneratedPagePathObject()

No description

in Page at line 2700
getNextSubPageDisplayOrder()

No description

in Page at line 2711
generatePagePath()

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

in Page at line 2755
rescanCollectionPath()

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

.

in Page at line 2785
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

in Page at line 2812
updateDisplayOrder($do, $cID = 0)

No description

Parameters

$do
$cID

in Page at line 2822
movePageDisplayOrderToTop()

No description

in Page at line 2838
movePageDisplayOrderToBottom()

No description

in Page at line 2848
movePageDisplayOrderToSibling(Page $c, $position = 'before')

No description

Parameters

Page $c
$position

in Page at line 2876
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.

in Page at line 2911
isInTrash()

No description

in Page at line 2916
moveToRoot()

No description

in Page at line 2924
deactivate()

No description

in Page at line 2930
setPageToDraft()

No description

in Page at line 2937
activate()

No description

in Page at line 2943
isActive()

No description

in Page at line 2948
setPageIndexScore($score)

No description

Parameters

$score

in Page at line 2953
getPageIndexScore()

No description

in Page at line 2958
getPageIndexContent()

No description

in Page at line 2965
protected _associateMasterCollectionBlocks($newCID, $masterCID, $cAcquireComposerOutputControls)

No description

Parameters

$newCID
$masterCID
$cAcquireComposerOutputControls

in Page at line 3000
protected _associateMasterCollectionAttributes($newCID, $masterCID)

No description

Parameters

$newCID
$masterCID

in Page at line 3019
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

in Page at line 3062
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

in Page at line 3210
protected acquireAreaStylesFromDefaults(Template $template)

No description

Parameters

Template $template

in Page at line 3237
getCustomStyleObject()

No description

in Page at line 3252
getCollectionFullPageCaching()

No description

in Page at line 3257
getCollectionFullPageCachingLifetime()

No description

in Page at line 3262
getCollectionFullPageCachingLifetimeCustomValue()

No description

in Page at line 3267
getCollectionFullPageCachingLifetimeValue()

No description

in Page at line 3293
static addStatic($data, TreeInterface $parent = null)

No description

Parameters

$data
TreeInterface $parent

in Page at line 3350
static getCurrentPage()

No description

in Page at line 3358
getPageDraftTargetParentPageID()

No description

in Page at line 3365
setPageDraftTargetParentPageID($cParentID)

No description

Parameters

$cParentID

at line 19
static isMultilingualSection($cID)

No description

Parameters

$cID

at line 32
static protected getLocaleFromHomePageID($cID)

No description

Parameters

$cID

at line 44
protected setLocale($locale)

No description

Parameters

$locale

at line 91
static Section getBySectionOfSite(Page $page)

No description

Parameters

Page $page

Return Value

Section

at line 132
getLanguageText($locale = null)

No description

Parameters

$locale

at line 137
getLanguage()

No description

at line 142
getIcon()

No description

at line 147
getCountry()

No description

at line 162
int getNumberOfPluralForms()

Returns the number of plural forms.

Return Value

int

Examples

For Japanese: returns 1
 
For English: returns 2
 
For French: returns 2
 
For Russian returns 3

at line 177
string getPluralsRule()

Returns the rule to determine which plural we should use (in gettext notation).

Return Value

string

Examples

For Japanese: returns '0'
 
For English: returns 'n != 1'
 
For French: returns 'n > 1'
 
For Russian returns '(n % 10 == 1 && n % 100 != 11) ? 0 : ((n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 12 || n % 100 > 14)) ? 1 : 2)'

at line 200
array getPluralsCases()

Returns the plural cases for the language; array keys are the case name, array values are some examples for that case.

Return Value

array

Examples

For Japanese: returns
'other' => '0~15, 100, 1000, 10000, 100000, 1000000, …'
 
For English: returns
'one' => '1',
'other' => '0, 2~16, 100, 1000, 10000, 100000, 1000000, …'
 
For French: returns
'one' => '0, 1',
'other' => '2~17, 100, 1000, 10000, 100000, 1000000, …'
 
For Russian returns
'one' => '1, 21, 31, 41, 51, 61, 71, 81, 101, 1001, …',
'few' => '2~4, 22~24, 32~34, 42~44, 52~54, 62, 102, 1002, …',
'other' => '0, 5~19, 100, 1000, 10000, 100000, 1000000, …',

at line 205
static getIDList(Site $site = null)

No description

Parameters

Site $site

at line 229
static getList(Site $site = null)

No description

Parameters

Site $site

at line 245
static getRelatedCollectionIDForLocale($cID, $locale)

No description

Parameters

$cID
$locale

at line 258
static getMultilingualPageRelationID($cID)

No description

Parameters

$cID

at line 270
static isAssigned($page)

No description

Parameters

$page

at line 278
static getCollectionIDForLocale($mpRelationID, $locale)

No description

Parameters

$mpRelationID
$locale

at line 290
static registerDuplicate($newPage, $oldPage)

No description

Parameters

$newPage
$oldPage

at line 359
static Section|false getByLanguage(string $language, Site $site = null)

No description

Parameters

string $language
Site $site

Return Value

Section|false

at line 387
static Section|false getByLocale($locale, Site $site = null)

No description

Parameters

$locale
Site $site

Return Value

Section|false

at line 419
static Section getCurrentSection()

Gets the MultilingualSection object for the current section of the site.

Return Value

Section

at line 432
static getByLocaleOrLanguage($locale)

No description

Parameters

$locale

at line 447
getLocaleObject()

No description

at line 452
getLocale()

No description

at line 458
static getDefaultSection(Site $site = null)

No description

Parameters

Site $site

at line 469
static unregisterPage($page)

No description

Parameters

$page

at line 478
static registerPage($page)

No description

Parameters

$page

at line 516
static registerMove($page, $oldParent, $newParent)

No description

Parameters

$page
$oldParent
$newParent

at line 561
static relatePage($oldPage, $newPage, $locale)

No description

Parameters

$oldPage
$newPage
$locale

at line 582
isDefaultMultilingualSection(Site $site = null)

No description

Parameters

Site $site

at line 592
static ignorePageRelation($page, $locale)

No description

Parameters

$page
$locale

at line 612
int|null getTranslatedPageID($page)

Receives a page in a different language tree, and tries to return the corresponding page in the current language tree.

Parameters

$page

Return Value

int|null

at line 635
Translations getSectionInterfaceTranslations(bool $untranslatedFirst = false)

Loads the translations of this multilingual section.

Parameters

bool $untranslatedFirst

Set to true to have untranslated strings first

Return Value

Translations