FlexPageCollection
extends FlexCollection
in package
Class FlexPageCollection
Tags
Table of Contents
Methods
- adjacentSibling() : PageInterface|false
- Returns the adjacent sibling based on a direction.
- currentPosition() : int|null
- Returns the item in the current position.
- getCachedMethods() : array<string|int, mixed>
- getNextOrder() : string
- isFirst() : bool
- Check to see if this item is the first in the collection.
- isLast() : bool
- Check to see if this item is the last in the collection.
- nextSibling() : PageInterface|false
- Gets the next sibling based on current position.
- prevSibling() : PageInterface|false
- Gets the previous sibling based on current position.
- withPublished() : static
- withRoutable() : static
- withVisible() : static
Methods
adjacentSibling()
Returns the adjacent sibling based on a direction.
public
adjacentSibling(string $path[, int $direction = 1 ]) : PageInterface|false
Parameters
- $path : string
- $direction : int = 1
-
either -1 or +1
Tags
Return values
PageInterface|false —The sibling item.
currentPosition()
Returns the item in the current position.
public
currentPosition(string $path) : int|null
Parameters
- $path : string
-
the path the item
Return values
int|null —The index of the current page, null if not found.
getCachedMethods()
public
static getCachedMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>getNextOrder()
public
getNextOrder() : string
Return values
stringisFirst()
Check to see if this item is the first in the collection.
public
isFirst(string $path) : bool
Parameters
- $path : string
Return values
bool —True if item is first.
isLast()
Check to see if this item is the last in the collection.
public
isLast(string $path) : bool
Parameters
- $path : string
Return values
bool —True if item is last.
nextSibling()
Gets the next sibling based on current position.
public
nextSibling(string $path) : PageInterface|false
Parameters
- $path : string
Tags
Return values
PageInterface|false —The next item.
prevSibling()
Gets the previous sibling based on current position.
public
prevSibling(string $path) : PageInterface|false
Parameters
- $path : string
Tags
Return values
PageInterface|false —The previous item.
withPublished()
public
withPublished([bool $bool = true ]) : static
Parameters
- $bool : bool = true
Tags
Return values
staticwithRoutable()
public
withRoutable([bool $bool = true ]) : static
Parameters
- $bool : bool = true
Tags
Return values
staticwithVisible()
public
withVisible([bool $bool = true ]) : static
Parameters
- $bool : bool = true