Class used to generate a collection of navigation nodes most closely related to the current page.
More...
|
| __construct (moodle_page &$page) |
| Constructor.
|
|
| add (navigation_node $node, $beforekey=null) |
| Override the parent so we can set a label for this collection if it has not been set yet.
|
|
| count () |
| Gets the number of nodes in this collection.
|
|
| find ($key, $type=null) |
| Searches for a node with matching key and type.
|
|
| get ($key, $type=null) |
| Fetches a node from this collection.
|
|
| get_collectionlabel () |
| Return a label for this collection.
|
|
| get_key_list () |
| Return a list of all the keys of all the nodes.
|
|
| getIterator () |
| Gets an array iterator for the collection.
|
|
| initialise () |
| Build the list of navigation nodes based on the current navigation and settings trees.
|
|
| last () |
| Fetches the last node that was added to this collection.
|
|
| remove ($key, $type=null) |
| Removes the node with the given key and type from the collection.
|
|
| set_collectionlabel ($label) |
| Set a label for this collection.
|
|
| type ($type) |
| Fetches all nodes of a given type from this collection.
|
|
|
array | $collection = array() |
| A multidimensional array to where the first key is the type and the second key is the nodes key.
|
|
string | $collectionlabel = '' |
| Label for collection of nodes.
|
|
int | $count = 0 |
| The total number of items added to this array.
|
|
navigation_node | $last = null |
| A reference to the last node that was added to the collection.
|
|
array | $orderedcollection = array() |
| An array that contains references to nodes in the same order they were added.
|
|
moodle_page | $page |
| the moodle page that the navigation belongs to
|
|
Class used to generate a collection of navigation nodes most closely related to the current page.
- Deprecated
- since Moodle 4.0 - do not use any more. Leverage secondary/tertiary navigation concepts
- Copyright
- 2016 Damyon Wiese
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
◆ add()
Override the parent so we can set a label for this collection if it has not been set yet.
- Parameters
-
navigation_node | $node | Node to add |
string | $beforekey | If specified, adds before a node with this key, otherwise adds at end |
- Return values
-
Reimplemented from navigation_node_collection.
◆ count()
navigation_node_collection::count |
( |
| ) |
|
|
inherited |
Gets the number of nodes in this collection.
This option uses an internal count rather than counting the actual options to avoid a performance hit through the count function.
- Return values
-
◆ find()
navigation_node_collection::find |
( |
| $key, |
|
|
| $type = null ) |
|
inherited |
Searches for a node with matching key and type.
This function searches both the nodes in this collection and all of the nodes in each collection belonging to the nodes in this collection.
Recursive.
- Parameters
-
string | int | $key | The key of the node we want to find. |
int | $type | One of navigation_node\TYPE_*. |
- Return values
-
◆ get()
navigation_node_collection::get |
( |
| $key, |
|
|
| $type = null ) |
|
inherited |
Fetches a node from this collection.
- Parameters
-
string | int | $key | The key of the node we want to find. |
int | $type | One of navigation_node\TYPE_*. |
- Return values
-
navigation_node|null|false | |
◆ get_collectionlabel()
navigation_node_collection::get_collectionlabel |
( |
| ) |
|
|
inherited |
Return a label for this collection.
- Return values
-
◆ get_key_list()
navigation_node_collection::get_key_list |
( |
| ) |
|
|
inherited |
Return a list of all the keys of all the nodes.
- Return values
-
◆ getIterator()
navigation_node_collection::getIterator |
( |
| ) |
|
|
inherited |
Gets an array iterator for the collection.
This is required by the IteratorAggregator interface and is used by routines such as the foreach loop.
- Return values
-
◆ last()
navigation_node_collection::last |
( |
| ) |
|
|
inherited |
Fetches the last node that was added to this collection.
- Return values
-
◆ remove()
navigation_node_collection::remove |
( |
| $key, |
|
|
| $type = null ) |
|
inherited |
Removes the node with the given key and type from the collection.
- Parameters
-
string | int | $key | The key of the node we want to find. |
int | $type | |
- Return values
-
◆ set_collectionlabel()
navigation_node_collection::set_collectionlabel |
( |
| $label | ) |
|
|
inherited |
Set a label for this collection.
- Parameters
-
◆ type()
navigation_node_collection::type |
( |
| $type | ) |
|
|
inherited |
Fetches all nodes of a given type from this collection.
- Parameters
-
string | int | $type | node type being searched for. |
- Return values
-
◆ $orderedcollection
array navigation_node_collection::$orderedcollection = array() |
|
protectedinherited |
An array that contains references to nodes in the same order they were added.
This is maintained as a progressive array.
The documentation for this class was generated from the following file: