Zend\Navigation is a component for managing trees of pointers to web pages. Simply put: It can be used for creating menus, breadcrumbs, links, and sitemaps, or serve as a model for other navigation related purposes.
There are two main concepts in Zend\Navigation:
A page (Zend\Navigation\AbstractPage) in Zend\Navigation – in its most basic form – is an object that holds a pointer to a web page. In addition to the pointer itself, the page object contains a number of other properties that are typically relevant for navigation, such as label, title, etc.
Read more about pages in the pages section.
A navigation container (Zend\Navigation\AbstractContainer) is a container class for pages. It has methods for adding, retrieving, deleting and iterating pages. It implements the SPL interfaces RecursiveIterator and Countable, and can thus be iterated with SPL iterators such as RecursiveIteratorIterator.
Read more about containers in the containers section.
Zend\Navigation\AbstractPage extends Zend\Navigation\AbstractContainer, which means that a page can have sub pages.
Classes in the Zend\Navigation namespace do not deal with rendering of navigational elements. Rendering is done with navigational view helpers. However, pages contain information that is used by view helpers when rendering, such as; label, class (CSS), title, lastmod and priority properties for sitemaps, etc.
Read more about rendering navigational elements in the manual section on navigation helpers.
The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.