Section
class Section extends Page (View source)
Traits
Properties
| protected PageController|null | $controller | The page controller. |
from Page |
| protected int[]|null | $blocksAliasedFromMasterCollection | The list of block IDs that are alias. |
from Page |
| protected int|null | $cPointerOriginalID | The original cID of a page (if it's a page alias). |
from Page |
| protected int|null | $cPointerOriginalSiteTreeID | The original siteTreeID of a page (if it's a page alias). |
from Page |
| protected string|null | $cPointerExternalLink | The link for the aliased page. |
from Page |
| protected bool|int|null | $cPointerExternalLinkNewWindow | Should the alias link to be opened in a new window? |
from Page |
| protected bool|int|null | $isMasterCollection | Is this page a page default? |
from Page |
| protected int|null | $cInheritPermissionsFromCID | The ID of the page from which this page inherits permissions from. |
from Page |
| protected bool | $cIsSystemPage | Is this a system page? |
from Page |
| protected int|null | $siteTreeID | The site tree ID. |
from Page |
| Tree|null deprecated | $siteTree | from Page | |
| protected Locale | $locale |
Methods
No description
Get a page given its path.
Returns an instance of MultilingualSection for the given page ID.
Read the data from the database.
No description
No description
Return a representation of the Page object as something easily serializable.
Get the package ID for a page (page thats added by a package) (returns 0 if its not in a package).
Uses a Request object to determine which page to load. Queries by path and then by cID.
Persist the data associated to a block when it has been moved around in the page.
Remove specific permission keys for a specific access entity (user, group, group combination).
This is the legacy function that is called just by xml. We pass these values in as though they were the old ones.
Update the name, link, and to open in a new window for an external link.
Add a new external link as a child of this page.
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.
Gets the icon for a page (also fires the on_page_get_icon event).
Create an array containing data about child pages.
Sort a list of pages, so that the order is correct for the deletion.
Sort a list of pages, so that the order is correct for the duplication.
Add this page and its subpages to the Delete Page Requests queue (or to a custom queue).
Add this page and its subpages to the Copy Page queue.
Get the uID for a page that is checked out (if any).
Add a non-canonical page path to the current page.
Set the canonical page path for a page.
Returns full url for the current page.
Get the collection ID for the aliased page (returns 0 unless used on an actual alias).
Should the alias link to be opened in a new window?
Get the original cID of a page (if it's a page alias).
Get the date/time when the current version was made public (or a falsy value if the current version doesn't have public date).
Get the date/time when the current version was made public (or NULL value if the current version doesn't have public date).
Get the parent cID of a page given its cID.
Get an array containint this cParentID and aliased parentIDs.
Get the position of the page in the sitemap, relative to its parent page.
Set the permissions of sub-collections added beneath this permissions to inherit from the template.
Set the permissions of sub-collections added beneath this permissions to inherit from the parent.
Get the ID of the page from which this page inherits permissions from.
Where permissions should be inherited from? 'PARENT' or 'TEMPLATE' or 'OVERRIDE'.
Get the ID of the page from which the parent page page inherits permissions from.
Get the page from which this page inherits permissions from.
Get the master page of this page, given its page template and page type.
Get the first child of the current page, or null if there is no child.
Get the list of child page IDs, sorted by their display order.
Populate the childrenCIDArray property (called by the getCollectionChildrenArray() method).
Set the custom style for this page for a specific theme.
Get the CSS class to be used to wrap the whole page contents.
Write the page theme customization CSS files to the cache directory.
Set this page permissions to be inherited from its parent page.
Set this page permissions to be inherited from its parent type defaults.
Rescan the page areas ensuring that they are inheriting permissions properly.
Are template permissions overriden?
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).
Acquire the area permissions, copying them from the inherited ones.
Acquire the page permissions, copying them from the inherited ones.
Duplicate this page and all its child pages and return the new Page created.
Duplicate all the child pages of a specific page which has already have been duplicated.
Duplicate this page and return the new Page created.
Get the ID of the homepage for the site tree this page belongs to.
Get a new PagePath object with the computed canonical page path.
Get the URL-slug-based path to the current page (including any suffixes) in a string format. Does so in real time.
Recalculate the canonical page path for the current page and its sub-pages, based on its current version, URL slug, etc.
Set a new display order for this page (or for another page given its ID).
Move this page before of after another page.
Set the page index score (used by a PageList for instance).
Duplicate the master collection blocks/permissions to a newly created page.
Duplicate the master collection attributes to a newly created page.
Add the home page to the system. Typically used only by the installation program.
Get the custom style for the currently loaded page version (if any).
Get the full-page cache flag (-1: use global setting; 0: no; 1: yes - NULL if page is not loaded).
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).
Get the full-page cache custom lifetime in minutes (to be used if getCollectionFullPageCachingLifetime() is 'custom').
Get the actual full-page cache lifespan (in seconds).
No description
No description
No description
No description
No description
No description
No description
Returns the number of plural forms.
Returns the rule to determine which plural we should use (in gettext notation).
Returns the plural cases for the language; array keys are the case name, array values are some examples for that case.
No description
No description
No description
No description
No description
Gets the MultilingualSection object for the current section of the site.
No description
No description
No description
No description
No description
No description
No description
No description
Receives a page in a different language tree, and tries to return the corresponding page in the current language tree.
Loads the translations of this multilingual section.
Details
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)
No description
in
Page at line 155
static Page
getByPath(string $path, string $version = 'RECENT', TreeInterface $tree = null)
Get a page given its path.
in
Page at line 188
CategoryInterface
getObjectAttributeCategory()
No description
static Page
getByID(int $cID, int|string $cvID = 'RECENT')
Returns an instance of MultilingualSection for the given page ID.
in
Page at line 227
__construct()
Initialize collection until we populate it.
in
Page at line 239
ItemInterface
getExporter()
No description
in
Page at line 251
protected
populatePage(mixed $cInfo, string $where, string|int $cvID)
Read the data from the database.
getPermissionResponseClassName()
No description
in
Page at line 305
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
No description
in
Page at line 325
stdClass
getJSONObject()
Return a representation of the Page object as something easily serializable.
in
Page at line 348
PageController
getPageController()
Get the page controller.
in
Page at line 389
getPermissionObjectIdentifier()
No description
in
Page at line 407
bool
isEditMode()
Is the page in edit mode?
in
Page at line 424
int
getPackageID()
Get the package ID for a page (page thats added by a package) (returns 0 if its not in a package).
in
Page at line 434
string|null
getPackageHandle()
Get the handle the the package that added this page.
in
Page at line 448
false
isArrangeMode()
deprecated
deprecated
No description
in
Page at line 456
forceCheckIn()
Forces the page to be checked in if its checked out.
in
Page at line 468
static private
forceCheckInForAllPages()
No description
in
Page at line 480
bool
isAdminArea()
Is this a dashboard page?
in
Page at line 498
static Page
getFromRequest(Request $request)
Uses a Request object to determine which page to load. Queries by path and then by cID.
in
Page at line 567
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.
in
Page at line 600
bool|null
isCheckedOut()
Is the page checked out?
in
Page at line 641
string
getCollectionCheckedOutUserName()
Gets the user that is editing the current page.
in
Page at line 662
bool
isCheckedOutByMe()
Checks if the page is checked out by the current user.
in
Page at line 677
bool
isGeneratedCollection()
Checks if the page is a single page.
Generated collections are collections without templates, that have special cFilename attributes .
in
Page at line 687
setPermissionsToOverride()
No description
in
Page at line 699
setChildPermissionsToOverride()
No description
in
Page at line 712
removePermissions(Group|Group[]|User|UserInfo|User $userOrGroup, string[] $permissions = [])
Remove specific permission keys for a specific access entity (user, group, group combination).
in
Page at line 750
static Page
getDraftsParentPage(Site $site = null)
Get the drafts parent page for a specific site.
in
Page at line 765
static Page[]
getDrafts(Site $site)
Get the list of draft pages in a specific site.
in
Page at line 786
bool
isPageDraft()
Is this a draft page?
in
Page at line 800
static private string[]
translatePermissionsXMLToKeys(SimpleXMLElement $node)
No description
in
Page at line 836
setController(PageController|null $controller)
Set the page controller.
in
Page at line 846
PageController
getController()
deprecated
deprecated
No description
in
Page at line 858
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.
in
Page at line 893
int
addCollectionAlias($c)
Make an alias to a page.
in
Page at line 947
updateCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)
Update the name, link, and to open in a new window for an external link.
in
Page at line 971
int
addCollectionAliasExternal(string $cName, string $cLink, bool $newWindow = 0)
Add a new external link as a child of this page.
in
Page at line 1025
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.
in
Page at line 1035
string
getCollectionIcon()
Gets the icon for a page (also fires the on_page_get_icon event).
in
Page at line 1080
int|null
removeThisAlias()
Remove an external link/alias.
in
Page at line 1124
array
populateRecursivePages(array $pages, array $pageRow, int $cParentID, int $level, bool $includeThisPage = true)
Create an array containing data about child pages.
in
Page at line 1156
int
queueForDeletionSort(array $a, array $b)
Sort a list of pages, so that the order is correct for the deletion.
in
Page at line 1176
int
queueForDuplicationSort(array $a, array $b)
Sort a list of pages, so that the order is correct for the duplication.
in
Page at line 1203
queueForDeletion()
Add this page and its subpages to the Delete Page queue.
in
Page at line 1227
queueForDeletionRequest(Queue|null $queue = null, bool $includeThisPage = true)
Add this page and its subpages to the Delete Page Requests queue (or to a custom queue).
in
Page at line 1248
queueForDuplication(Page $destination, bool $includeParent = true)
Add this page and its subpages to the Copy Page queue.
in
Page at line 1269
export(SimpleXMLElement $pageNode)
deprecated
deprecated
No description
in
Page at line 1280
int|null
getCollectionCheckedOutUserID()
Get the uID for a page that is checked out (if any).
in
Page at line 1290
string
getCollectionPath()
Get the path of this page.
in
Page at line 1300
PagePath|null
getCollectionPathObject()
Returns the PagePath object for the current page.
in
Page at line 1319
PagePath
addAdditionalPagePath(string $cPath, bool $commit = true)
Add a non-canonical page path to the current page.
in
Page at line 1339
setCanonicalPagePath(string $cPath, bool $isAutoGenerated = false)
Set the canonical page path for a page.
in
Page at line 1361
PagePath[]
getPagePaths()
Get all the page paths of this page.
in
Page at line 1375
PagePath[]
getAdditionalPagePaths()
Get all the non-canonical page paths of this page.
in
Page at line 1387
clearPagePaths()
Clears all page paths for a page.
in
Page at line 1404
string
getCollectionLink(bool $appendBaseURL = false)
Returns full url for the current page.
in
Page at line 1414
int|null
getSiteTreeID()
No description
in
Page at line 1424
Site
getSite()
No description
in
Page at line 1437
Tree|null
getSiteTreeObject()
No description
in
Page at line 1453
static
getCollectionPathFromID($cID)
Returns the path for a page from its cID.
in
Page at line 1466
int|null
getCollectionUserID()
Get the uID of the page author (if any).
in
Page at line 1476
string
getCollectionHandle()
Get the page handle.
in
Page at line 1486
string|null
getCollectionTypeName()
deprecated
deprecated
No description
in
Page at line 1496
string|null
getPageTypeName()
Get the display name of the page type (if available).
in
Page at line 1509
getCollectionTypeID()
deprecated
deprecated
No description
in
Page at line 1519
int|null
getPageTypeID()
Get the Collection Type ID.
in
Page at line 1529
Type|null
getPageTypeObject()
Get the page type object.
in
Page at line 1539
int
getPageTemplateID()
Get the Page Template ID.
in
Page at line 1549
Template|null
getPageTemplateObject()
Get the Page Template Object (if available).
in
Page at line 1559
string|false
getPageTemplateHandle()
Get the handle of the Page Template (if available).
in
Page at line 1574
string|false
getPageTypeHandle()
Get the handle of the Page Type (if available).
in
Page at line 1595
string|false
getCollectionTypeHandle()
deprecated
deprecated
No description
in
Page at line 1605
int|null
getCollectionThemeID()
Get the theme ID for the collection (if available).
in
Page at line 1620
bool
isBlockAliasedFromMasterCollection(Block $b)
Check if a block is an alias from a page default.
in
Page at line 1650
Theme
getCollectionThemeObject()
Get the collection's theme object.
in
Page at line 1686
string
getCollectionName()
Get the page name.
in
Page at line 1700
int
getCollectionPointerID()
Get the collection ID for the aliased page (returns 0 unless used on an actual alias).
in
Page at line 1710
string|null
getCollectionPointerExternalLink()
Get the link for the aliased page.
in
Page at line 1720
bool|int|null
openCollectionPointerExternalLinkInNewWindow()
Should the alias link to be opened in a new window?
in
Page at line 1732
bool
isAliasPage()
Is this page an alias page of another page?
in
Page at line 1744
bool
isAliasPageOrExternalLink()
Is this page an alias page or an external link?
in
Page at line 1754
bool
isAlias()
deprecated
deprecated
No description
in
Page at line 1764
bool
isExternalLink()
Is this page an external link?
in
Page at line 1774
int
getCollectionPointerOriginalID()
Get the original cID of a page (if it's a page alias).
in
Page at line 1784
string
getCollectionFilename()
Get the file name of a page (single pages).
in
Page at line 1796
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).
in
Page at line 1806
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).
in
Page at line 1816
string
getCollectionDescription()
Get the description of a page.
in
Page at line 1826
int|null
getCollectionParentID()
Ges the cID of the parent page.
in
Page at line 1838
static int|null
getCollectionParentIDFromChildID(int $cID)
Get the parent cID of a page given its cID.
in
Page at line 1852
int[]
getCollectionParentIDs()
Get an array containint this cParentID and aliased parentIDs.
in
Page at line 1869
bool|int|null
isMasterCollection()
Is this page a page default?
in
Page at line 1879
bool|int|null
overrideTemplatePermissions()
Are template permissions overriden?
in
Page at line 1889
int|null
getCollectionDisplayOrder()
Get the position of the page in the sitemap, relative to its parent page.
in
Page at line 1899
setTheme(Theme $pl)
Set the theme of this page.
in
Page at line 1911
setPageType(Type $type = null)
Set the theme for a page using the page object.
in
Page at line 1925
setPermissionsInheritanceToTemplate()
Set the permissions of sub-collections added beneath this permissions to inherit from the template.
in
Page at line 1936
setPermissionsInheritanceToOverride()
Set the permissions of sub-collections added beneath this permissions to inherit from the parent.
in
Page at line 1949
int|null
getPermissionsCollectionID()
Get the ID of the page from which this page inherits permissions from.
in
Page at line 1959
string|null
getCollectionInheritance()
Where permissions should be inherited from? 'PARENT' or 'TEMPLATE' or 'OVERRIDE'.
in
Page at line 1969
int|null
getParentPermissionsCollectionID()
Get the ID of the page from which the parent page page inherits permissions from.
in
Page at line 1989
Page
getPermissionsCollectionObject()
Get the page from which this page inherits permissions from.
in
Page at line 1999
int
getMasterCollectionID()
Get the master page of this page, given its page template and page type.
in
Page at line 2019
int|null
getOriginalCollectionID()
Get the ID of the original collection.
in
Page at line 2032
int|null
getNumChildren()
Get the number of child pages.
in
Page at line 2042
int
getNumChildrenDirect()
Get the number of child pages (direct children only).
in
Page at line 2062
Page|false
getFirstChild(string $sortColumn = 'cDisplayOrder asc')
Get the first child of the current page, or null if there is no child.
in
Page at line 2098
int[]
getCollectionChildrenArray(bool $oneLevelOnly = 0)
Get the list of child page IDs, sorted by their display order.
in
Page at line 2111
Page[]
getCollectionChildren()
Get the immediate children of the this page.
in
Page at line 2136
protected
_getNumChildren(int $cID, bool $oneLevelOnly = 0, string $sortColumn = 'cDisplayOrder asc')
Populate the childrenCIDArray property (called by the getCollectionChildrenArray() method).
in
Page at line 2160
bool
canMoveCopyTo(Collection $cobj)
Check if a collection is this page itself or one of its sub-pages.
in
Page at line 2173
updateCollectionName(string $name)
Update the collection name.
in
Page at line 2201
bool
hasPageThemeCustomizations()
Does this page have theme customizations?
in
Page at line 2213
resetCustomThemeStyles()
Clears the custom theme styles for this page.
in
Page at line 2230
CustomStyle
setCustomStyleObject(Theme $pt, ValueList $valueList, Preset|null|false $selectedPreset = false, CustomCssRecord $customCssRecord = null)
Set the custom style for this page for a specific theme.
in
Page at line 2268
string
getPageWrapperClass()
Get the CSS class to be used to wrap the whole page contents.
in
Page at line 2293
writePageThemeCustomizations()
Write the page theme customization CSS files to the cache directory.
in
Page at line 2317
static
resetAllCustomStyles()
Clears the custom theme styles for every page.
in
Page at line 2341
update(array $data)
Update the data of this page.
in
Page at line 2499
clearPagePermissions()
Clear all the page permissions.
in
Page at line 2509
inheritPermissionsFromParent()
Set this page permissions to be inherited from its parent page.
in
Page at line 2526
inheritPermissionsFromDefaults()
Set this page permissions to be inherited from its parent type defaults.
in
Page at line 2549
setPermissionsToManualOverride()
Set this page permissions to be manually specified.
in
Page at line 2570
rescanAreaPermissions()
Rescan the page areas ensuring that they are inheriting permissions properly.
in
Page at line 2585
setOverrideTemplatePermissions(bool|int $cOverrideTemplatePermissions)
Are template permissions overriden?
in
Page at line 2600
updatePermissionsCollectionID(int|string $cParentIDString, $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).
in
Page at line 2624
acquireAreaPermissions(int $permissionsCollectionID)
Acquire the area permissions, copying them from the inherited ones.
in
Page at line 2658
acquirePagePermissions(int $permissionsCollectionID)
Acquire the page permissions, copying them from the inherited ones.
in
Page at line 2675
__destruct()
No description
in
Page at line 2685
updateGroupsSubCollection(int|string $cParentIDString)
deprecated
deprecated
No description
in
Page at line 2713
Block
addBlock(BlockType $bt, Area $a, array $data)
Add a new block to a specific area of the page.
in
Page at line 2761
SiblingRelation[]
getPageRelations()
Get the relations of this page.
in
Page at line 2783
move($nc)
Move this page under a new parent page.
in
Page at line 2873
Page
duplicateAll($nc = null, bool $preserveUserID = false, Site $site = null)
Duplicate this page and all its child pages and return the new Page created.
in
Page at line 2889
protected
_duplicateAll($cParent, $cNewParent, bool $preserveUserID = false, Site $site = null)
Duplicate all the child pages of a specific page which has already have been duplicated.
in
Page at line 2918
Page
duplicate($nc = null, bool $preserveUserID = false, TreeInterface $site = null)
Duplicate this page and return the new Page created.
in
Page at line 2934
null|false
delete()
Delete this page and all its child pages.
in
Page at line 3018
moveToTrash()
Move this page and all its child pages to the trash.
in
Page at line 3055
rescanChildrenDisplayOrder()
Regenerate the display order of the child pages.
in
Page at line 3076
bool
isHomePage()
Is this the homepage for the site tree this page belongs to?
in
Page at line 3086
int|null
getSiteHomePageID()
Get the ID of the homepage for the site tree this page belongs to.
in
Page at line 3096
bool
isLocaleHomePage()
deprecated
deprecated
No description
in
Page at line 3108
static int|null
getHomePageID(Page|int $page = null)
Get the ID of the home page.
in
Page at line 3137
PagePath
getAutoGeneratedPagePathObject()
Get a new PagePath object with the computed canonical page path.
in
Page at line 3153
int
getNextSubPageDisplayOrder()
Get the next available display order of child pages.
in
Page at line 3166
string
generatePagePath()
Get 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 3210
rescanCollectionPath()
Recalculate the canonical page path for the current page and its sub-pages, based on its current version, URL slug, etc.
in
Page at line 3244
protected string
computeCanonicalPagePath()
Get the canonical path string of this page .
This happens before any uniqueness checks get run.
in
Page at line 3277
updateDisplayOrder(int $displayOrder, int|null $cID = 0)
Set a new display order for this page (or for another page given its ID).
in
Page at line 3320
movePageDisplayOrderToTop()
Make this page the first child of its parent.
in
Page at line 3339
movePageDisplayOrderToBottom()
Make this page the first child of its parent.
in
Page at line 3355
movePageDisplayOrderToSibling(Page $c, string $position = 'before')
Move this page before of after another page.
in
Page at line 3385
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.
in
Page at line 3425
bool
isInTrash()
Is this page in the trash?
in
Page at line 3433
moveToRoot()
Make this page child of nothing, thus moving it to the root level.
in
Page at line 3444
deactivate()
Mark this page as non active.
in
Page at line 3453
setPageToDraft()
Mark this page as non draft.
in
Page at line 3463
activate()
Mark this page as active.
in
Page at line 3474
bool
isActive()
Is this page marked as active?
in
Page at line 3484
setPageIndexScore(float $score)
Set the page index score (used by a PageList for instance).
in
Page at line 3494
float
getPageIndexScore()
Get the page index score (as set by a PageList for instance).
in
Page at line 3504
string
getPageIndexContent()
Get the indexed content of this page.
in
Page at line 3518
protected
_associateMasterCollectionBlocks(int $newCID, $masterCID, bool $cAcquireComposerOutputControls)
Duplicate the master collection blocks/permissions to a newly created page.
in
Page at line 3559
protected
_associateMasterCollectionAttributes(int $newCID, $masterCID)
Duplicate the master collection attributes to a newly created page.
in
Page at line 3580
static Page
addHomePage(TreeInterface $siteTree = null)
Add the home page to the system. Typically used only by the installation program.
in
Page at line 3640
Page
add($pt, array $data, $template = false)
Add a new page, child of this page.
in
Page at line 3793
protected
acquireAreaStylesFromDefaults(Template $template)
Copy the area styles from a page template.
in
Page at line 3825
CustomStyle|null
getCustomStyleObject()
Get the custom style for the currently loaded page version (if any).
in
Page at line 3845
int|null
getCollectionFullPageCaching()
Get the full-page cache flag (-1: use global setting; 0: no; 1: yes - NULL if page is not loaded).
in
Page at line 3855
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).
in
Page at line 3865
int|null
getCollectionFullPageCachingLifetimeCustomValue()
Get the full-page cache custom lifetime in minutes (to be used if getCollectionFullPageCachingLifetime() is 'custom').
in
Page at line 3875
int
getCollectionFullPageCachingLifetimeValue()
Get the actual full-page cache lifespan (in seconds).
in
Page at line 3911
static Page
addStatic(array $data, TreeInterface $parent = null)
Create a new page.
in
Page at line 3969
static Page|null
getCurrentPage()
Get the currently requested page.
in
Page at line 3982
int
getPageDraftTargetParentPageID()
Get the ID of the draft parent page ID.
in
Page at line 3994
setPageDraftTargetParentPageID(int $cParentID)
Set the ID of the draft parent page ID.
static
isMultilingualSection($cID)
No description
static protected
getLocaleFromHomePageID($cID)
No description
protected
setLocale($locale)
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
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.