Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\Menu\PreparedMenu Class Reference

Represents a menu that has been broken down into sections, with menu hierarchy trees setup. More...

Inheritance diagram for Elgg\Menu\PreparedMenu:
Elgg\Collections\Collection Elgg\Collections\CollectionInterface

Public Member Functions

 getSection ($id)
 Get menu section. More...
 
 getItems ($section_id)
 Get items in a section. More...
 
- Public Member Functions inherited from Elgg\Collections\Collection
 __construct ($items=[], $item_class=null)
 Constructor. More...
 
 all ()
 {Returns all collection items by reference.
Returns
CollectionItemInterface[]
} More...
 
 count ()
 {Count collection items.
Returns
int
} More...
 
 add ($item)
 {Add a new item to collection.
Parameters
CollectionItemInterface$itemItem
Returns
static
} More...
 
 get ($id)
 {Get an item by its ID.
Parameters
string | int$idID
Returns
CollectionItemInterface|null
} More...
 
 has ($id)
 {Check if collection has an item with a given ID.
Parameters
string | int$idID
Returns
bool
} More...
 
 remove ($id)
 {Remove item from collection by its ID.
Parameters
string | int$idID
Returns
static
} More...
 
 fill ($items)
 {Replace collection items.
Parameters
CollectionItemInterface[]|Collection$items Items
Returns
static
} More...
 
 merge ($items)
 {Add new items to collection, replacing items with matching IDs.
Parameters
CollectionItemInterface[]|Collection$items Items
Returns
static
} More...
 
 filter (callable $callback=null)
 {Filter collection items using a custom filter Returns a new collection instance.
Parameters
callable$callbackFilter
Returns
static
} More...
 
 sort (callable $callback=null)
 {Sort fields using custom callable If not provided, will sort items by priority.
Parameters
callable$callbackSorter
Returns
static
} More...
 
 walk (callable $callback)
 Walk through members of the collection and apply a callback. More...
 
 map (callable $callback)
 {Walk through all items in the collection and apply a callback.
Parameters
callable$callbackMapper
Returns
mixed
} More...
 
 offsetExists ($offset)
 {} More...
 
 offsetGet ($offset)
 {} More...
 
 offsetSet ($offset, $value)
 {} More...
 
 offsetUnset ($offset)
 {} More...
 
 current ()
 {} More...
 
 next ()
 {} More...
 
 key ()
 {} More...
 
 valid ()
 {} More...
 
 rewind ()
 {} More...
 
 seek ($position)
 {} More...
 

Additional Inherited Members

- Protected Member Functions inherited from Elgg\Collections\Collection
 assertValidItem ($item)
 Validate if item is a valid collection item. More...
 
- Protected Attributes inherited from Elgg\Collections\Collection
 $items = []
 
 $item_class
 

Detailed Description

Represents a menu that has been broken down into sections, with menu hierarchy trees setup.

Definition at line 12 of file PreparedMenu.php.

Member Function Documentation

Elgg\Menu\PreparedMenu::getItems (   $section_id)

Get items in a section.

Parameters
string$section_idSection ID
Returns
ElggMenuItem[]

Definition at line 32 of file PreparedMenu.php.

Elgg\Menu\PreparedMenu::getSection (   $id)

Get menu section.

Parameters
string$idSection ID
Returns
MenuSection

Definition at line 21 of file PreparedMenu.php.


The documentation for this class was generated from the following file: