Route
extends PlatformUtility
in package
Provides access to information regarding the route.
Tags
Table of Contents
- getBrandId() : int|null
- Get the product brand id of the current route
- getCatalogId() : mixed
- Get the product catalog page id
- getCatalogLink() : string|null
- Get the product catalog page link
- getCategoryId() : int
- Get the product category id of the current route
- getFolderId() : int
- Get the folder id of the current route
- getHomeId() : mixed
- Get the home page id
- getId() : int
- Get the page id of the current route
- getPageCanonicalHref() : string|null
- Get the page canonical link for the current route
- getPageLinks() : array<string|int, mixed>
- Get the page links for the current route
- getPageMetas() : array<string|int, mixed>
- Get the page metas for the current route
- getPageScripts() : array<string|int, mixed>
- Get the page scripts for the current route
- getParentId() : int
- Get the parent page id of the current route
- getProductId() : int|string
- Get the product id of the current route
- getSeoDescription() : string
- Get the page seo description from page meta If no meta with "description" name is found, empty string is returned.
- getSeoTitle() : array<string|int, mixed>|string
- Get the title of the current route
- getTitle() : string
- Get the title of the current route
- getType() : string
- Get the page type of the current route
- getView() : string
- Get the title of the current route
- resolveView() : string
- Get the view name of the current route
Methods
getBrandId()
Get the product brand id of the current route
public
getBrandId() :
int|null
Tags
Return values
int|null —getCatalogId()
Get the product catalog page id
public
getCatalogId() :
mixed
Tags
Return values
mixed —getCatalogLink()
Get the product catalog page link
public
getCatalogLink() :
string|null
Tags
Return values
string|null —getCategoryId()
Get the product category id of the current route
public
getCategoryId() :
int
Tags
Return values
int —getFolderId()
Get the folder id of the current route
public
getFolderId() :
int
Tags
Return values
int —getHomeId()
Get the home page id
public
getHomeId() :
mixed
Tags
Return values
mixed —getId()
Get the page id of the current route
public
getId() :
int
Tags
Return values
int —getPageCanonicalHref()
Get the page canonical link for the current route
public
getPageCanonicalHref() :
string|null
Tags
Return values
string|null —getPageLinks()
Get the page links for the current route
public
getPageLinks() :
array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —[] | [[ key => value ]]
getPageMetas()
Get the page metas for the current route
public
getPageMetas() :
array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —[] | [[ key => value ]]
getPageScripts()
Get the page scripts for the current route
public
getPageScripts() :
array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —[] | [[ key => value ]]
getParentId()
Get the parent page id of the current route
public
getParentId() :
int
Tags
Return values
int —getProductId()
Get the product id of the current route
public
getProductId() :
int|string
Tags
Return values
int|string —getSeoDescription()
Get the page seo description from page meta If no meta with "description" name is found, empty string is returned.
public
getSeoDescription() :
string
Tags
Return values
string —getSeoTitle()
Get the title of the current route
public
getSeoTitle([bool $asArray = false ]) :
array<string|int, mixed>|string
Parameters
- $asArray : bool = false
-
Wether to return as string or array
Tags
Return values
array<string|int, mixed>|string —getTitle()
Get the title of the current route
public
getTitle() :
string
Tags
Return values
string —getType()
Get the page type of the current route
public
getType() :
string
Tags
Return values
string —getView()
Get the title of the current route
public
getView() :
string
Tags
Return values
string —resolveView()
Get the view name of the current route
public
resolveView() :
string