ContentNavigationCollection
extends KeyValueCollection
in package
implements
ContentNavigationCollectionInterface
Class ContentNavigationCollection
This class extends the KeyValueCollection where the key is the display name of the navigation and the value the URL of the page. If you use the constructor to set the content navigation links make sure that you provide an empty URL for the current page so that it's marked as active in frontend.
Tags
Interfaces, Classes and Traits
- ContentNavigationCollectionInterface
- Interface AssetCollectionInterface
Table of Contents
- $collectionContentArray : array<string|int, mixed>
- Content Collection
- __construct() : mixed
- Initialize the collection instance.
- add() : mixed
- Adds a new page to the collection.
- count() : int
- Get collection item count.
- getArray() : array<string|int, mixed>
- Get the collection as an array.
- getItem() : mixed
- Get specific collection item by index.
- getIterator() : Traversable
- getValue() : mixed
- Get the value that corresponds to the provided key.
- isEmpty() : bool
- Determine whether the collection is empty or not.
- keyExists() : bool
- Check if a given key exists within the collection.
- _add() : mixed
- Add a new item.
- _addToCollectionContentArray() : mixed
- Add the passed key value array to the collection content array.
- _getExceptionText() : string
- Get exception text.
- _getValidType() : string
- Get valid type.
- _itemIsValid() : bool
- Check if a new item has the valid collection type.
Properties
$collectionContentArray
Content Collection
protected
array<string|int, mixed>
$collectionContentArray
= []
Methods
__construct()
Initialize the collection instance.
public
__construct([array<string|int, mixed>|mixed|null $argumentsArray = null ]) : mixed
Parameters
- $argumentsArray : array<string|int, mixed>|mixed|null = null
Tags
Return values
mixed —add()
Adds a new page to the collection.
public
add(StringType $name, StringType $url, BoolType $current) : mixed
Parameters
- $name : StringType
-
The page name to be displayed must be already translated.
- $url : StringType
-
The page url to be displayed.
- $current : BoolType
-
Whether the provided page is the one currently displayed.
Return values
mixed —count()
Get collection item count.
public
count() : int
Return values
int —getArray()
Get the collection as an array.
public
getArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getItem()
Get specific collection item by index.
public
getItem( $p_index) : mixed
Parameters
Tags
Return values
mixed —getIterator()
public
getIterator() : Traversable
Return values
Traversable —getValue()
Get the value that corresponds to the provided key.
public
getValue(string $p_keyName) : mixed
Parameters
- $p_keyName : string
Tags
Return values
mixed —isEmpty()
Determine whether the collection is empty or not.
public
isEmpty() : bool
Return values
bool —keyExists()
Check if a given key exists within the collection.
public
keyExists(string $p_keyName) : bool
Parameters
- $p_keyName : string
Return values
bool —_add()
Add a new item.
protected
_add(mixed $item) : mixed
This method must be used by child-collection classes.
Parameters
- $item : mixed
-
Item which should add to the collection
Tags
Return values
mixed —_addToCollectionContentArray()
Add the passed key value array to the collection content array.
protected
_addToCollectionContentArray(array<string|int, mixed> $keyValueArray) : mixed
Parameters
- $keyValueArray : array<string|int, mixed>
Return values
mixed —_getExceptionText()
Get exception text.
protected
_getExceptionText() : string
Return values
string —_getValidType()
Get valid type.
protected
abstract _getValidType() : string
This method must be implemented in the child-collection classes.
Return values
string —_itemIsValid()
Check if a new item has the valid collection type.
protected
_itemIsValid(mixed $dataItem) : bool
Parameters
- $dataItem : mixed