API Documentation
Back to top  

ContentNavigationCollection

Extends \KeyValueCollection 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.

category

System
package

Http
subpackage

Collections

Methods

Initialize the collection instance.

__construct(array|mixed|null $argumentsArray = null)
inherited
Throws
\InvalidArgumentException

Arguments

$argumentsArray

array|mixed|null

Adds a new page to the collection.

add(\StringType $name, \StringType $url, \BoolType $current)

Arguments

$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.

Get collection item count.

count() : integer
inherited

Response

integer

Get the collection as an array.

getArray() : array
inherited

Response

array

Get specific collection item by index.

getItem( $p_index) : mixed
inherited
Throws
\InvalidArgumentException

if index is not numeric | OutOfBoundsException if index is out of bounds

Arguments

$p_index

Response

mixed

getIterator

getIterator()
inherited

Get the value that corresponds to the provided key.

getValue(string $p_keyName) : mixed
inherited
Throws
\InvalidArgumentException

Arguments

$p_keyName

string

Response

mixed

Determine whether the collection is empty or not.

isEmpty() : boolean
inherited

Response

boolean

Check if a given key exists within the collection.

keyExists(string $p_keyName) : boolean
inherited

Arguments

$p_keyName

string

Response

boolean

Properties