PageRoutableTrait
Implements PageRoutableInterface.
Table of Contents
Methods
- active() : bool
- Returns whether or not this page is the currently active page requested via the URL.
- activeChild() : bool
- Returns whether or not this URI's URL contains the URL of the active page.
- currentPosition() : int|null
- Returns the item in the current position.
- parent() : PageInterface|null
- Gets and Sets the parent object for this page
Methods
active()
Returns whether or not this page is the currently active page requested via the URL.
public
active() : bool
Return values
bool —True if it is active
activeChild()
Returns whether or not this URI's URL contains the URL of the active page.
public
activeChild() : bool
Or in other words, is this page's URL in the current URL
Return values
bool —True if active child exists
currentPosition()
Returns the item in the current position.
public
currentPosition() : int|null
Return values
int|null —the index of the current page.
parent()
Gets and Sets the parent object for this page
public
parent([PageInterface|null $var = null ]) : PageInterface|null
Parameters
- $var : PageInterface|null = null
-
the parent page object
Return values
PageInterface|null —the parent page object if it exists.