PageController
extends CollectionController
in package
This controller describes the behavior of Page entities.
Use the controller to generate a collection of Page entities.
Tags
Table of Contents
- __construct() : mixed
- getCompletePath() : array<string|int, mixed>
- Calculate an entire path array from any Parent ID
- getHeadline() : string
- Get the headline of the entity
- getPageTree() : bool
- Returns pages as a tree structure
- getText() : string
- Get the text of the entity
- getTranslation() : string
- Get translation data
- getTranslationSeo() : string
- Get the headline of the entity
- link() : string
- Get the qualified handle of a Page entity
- makeCollection() : mixed
- pageHasChildren() : bool
- Returns whether or not a page has children. This information is located in a local array, that if not available, is loaded (once)
- pictureElementSettings() : mixed
- Fetch the picture element settings for the given page.
- productCatalogLink() : string|null
- Get the qualified handle of a Product Catalogue Page entity
Methods
__construct()
public
__construct([mixed $parseUriParameters = false ]) :
mixed
Parameters
- $parseUriParameters : mixed = false
Tags
Return values
mixed —getCompletePath()
Calculate an entire path array from any Parent ID
public
getCompletePath([int $pageId = null ][, array<string|int, int> $path = [] ]) :
array<string|int, mixed>
Parameters
- $pageId : int = null
-
Page ID for starting point
- $path : array<string|int, int> = []
-
path of ids for loop detection
Tags
Return values
array<string|int, mixed> —getHeadline()
Get the headline of the entity
public
getHeadline(mixed $Id[, mixed $LanguageIso = null ]) :
string
Parameters
- $Id : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getPageTree()
Returns pages as a tree structure
public
getPageTree() :
bool
Tags
Return values
bool —getText()
Get the text of the entity
public
getText(mixed $Id[, mixed $LanguageIso = null ]) :
string
Parameters
- $Id : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getTranslation()
Get translation data
public
getTranslation(mixed $Id, mixed $Title[, mixed $LanguageIso = null ][, mixed $Module = 'page' ]) :
string
Parameters
- $Id : mixed
- $Title : mixed
- $LanguageIso : mixed = null
- $Module : mixed = 'page'
Tags
Return values
string —getTranslationSeo()
Get the headline of the entity
public
getTranslationSeo(mixed $id, mixed $title[, mixed $languageIso = null ]) :
string
Parameters
- $id : mixed
- $title : mixed
- $languageIso : mixed = null
Tags
Return values
string —link()
Get the qualified handle of a Page entity
public
static
link( $pageId[, $absolute = false ][, $page = null ]) :
string
Parameters
- $pageId :
-
int id of the CollectionPage
- $absolute : = false
-
bool Prepend HTTP_HOST to the url
- $page : = null
-
CollectionPage If a page instance already exists, use it to calculate the url much faster
Tags
Return values
string —makeCollection()
public
makeCollection([mixed $params = array() ][, mixed $settings = array() ][, mixed $preloadKey = 'preload' ]) :
mixed
Parameters
- $params : mixed = array()
- $settings : mixed = array()
- $preloadKey : mixed = 'preload'
Tags
Return values
mixed —pageHasChildren()
Returns whether or not a page has children. This information is located in a local array, that if not available, is loaded (once)
public
static
pageHasChildren(int $pageId) :
bool
Parameters
- $pageId : int
Tags
Return values
bool —pictureElementSettings()
Fetch the picture element settings for the given page.
public
pictureElementSettings(mixed $PageId) :
mixed
Valid settings are:
- height (int) height in pixels
- inheritPage (int) Page Id for page where pictures should origin
- crop (bool) Crop pictures or not
- sortingOrder (string) 'sorting' or 'random'
- inherit (bool) Automatic inheritance
- cycleSpeed (int) Speed of cycle in ms
Parameters
- $PageId : mixed
Tags
Return values
mixed —Array with settings or null if nothing is found
productCatalogLink()
Get the qualified handle of a Product Catalogue Page entity
public
static
productCatalogLink([bool $absolute = false ]) :
string|null
Parameters
- $absolute : bool = false
-
Prepend HTTP_HOST to the url