MenuItems
in package
Uses
MenuSortTrait
Class MenuItems
Table of Contents
- $items : array<string|int, MenuItem>
- add() : void
- Adds new menu item to collection.
- filter() : void
- Filters menu items.
- isEmpty() : bool
- Checks if collection is empty.
- merge() : void
- Merges this with other menu items.
- reset() : void
- Flushes collected items.
- sort() : void
- Sorts collection by items sort order.
- toArray() : array<string|int, mixed>
- Array serialization.
- recursiveArrayUnique() : array<string|int, mixed>
- Recursively filter the given array and returns a result with unique items only.
- sortCallback() : callable
Properties
$items
private
array<string|int, MenuItem>
$items
= []
Methods
add()
Adds new menu item to collection.
public
add(MenuItem $item) : void
Parameters
- $item : MenuItem
Return values
void —filter()
Filters menu items.
public
filter(FilterFactory $filterFactory) : void
This function filter menu items by using conditions, if available and performing a check if the menu group should be used in the final structure, or is restricted by some configurations.
Parameters
- $filterFactory : FilterFactory
Return values
void —isEmpty()
Checks if collection is empty.
public
isEmpty() : bool
Return values
bool —merge()
Merges this with other menu items.
public
merge(MenuItems $other) : void
Parameters
- $other : MenuItems
Return values
void —reset()
Flushes collected items.
public
reset() : void
Return values
void —sort()
Sorts collection by items sort order.
public
sort() : void
Return values
void —toArray()
Array serialization.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —recursiveArrayUnique()
Recursively filter the given array and returns a result with unique items only.
private
recursiveArrayUnique(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed> —sortCallback()
private
sortCallback() : callable