vendor/zendframework/zend-navigation/doc/book/intro.md

   1 # Introduction
   2
   3 zend-navigation manages trees of pointers to web pages. Simply put: It can be
   4 used for creating menus, breadcrumbs, links, and sitemaps, or serve as a model
   5 for other navigation related purposes.
   6
   7 ## Pages and Containers
   8
   9 There are two main concepts in zend-navigation: pages and containers.
  10
  11 ### Pages
  12
  13 A page (`Zend\Navigation\AbstractPage`) in zend-navigation, in its most basic
  14 form, is an object that holds a pointer to a web page. In addition to the
  15 pointer itself, the page object contains a number of other properties that are
  16 typically relevant for navigation, such as `label`, `title`, etc.
  17
  18 Read more about pages in the [pages](pages.md) section.
  19
  20 ### Containers
  21
  22 A navigation container (`Zend\Navigation\AbstractContainer`) holds pages. It has
  23 methods for adding, retrieving, deleting and iterating pages. It implements the
  24 [SPL](http://php.net/spl) interfaces `RecursiveIterator` and `Countable`, and
  25 can thus be iterated with SPL iterators such as `RecursiveIteratorIterator`.
  26
  27 Read more about containers in the [containers](containers.md) section.
  28
  29 > ### Pages are containers
  30 >
  31 > `Zend\Navigation\AbstractPage` extends `Zend\Navigation\AbstractContainer`,
  32 > which means that a page can have sub pages.
  33
  34 ## View Helpers
  35
  36 ### Separation of data (model) and rendering (view)
  37
  38 Classes in the zend-navigation namespace do not deal with rendering of
  39 navigational elements.  Rendering is done with navigational view helpers.
  40 However, pages contain information that is used by view helpers when rendering,
  41 such as `label`, `class` (CSS), `title`, `lastmod`, and `priority` properties
  42 for sitemaps, etc.
  43
  44 Read more about rendering navigational elements in the
  45 [view helpers](helpers/intro.md) section.