Chapter 37. Zend_Navigation

Table of Contents

37.1. Introduction
37.1.1. Pages and Containers
37.1.1.1. Pages
37.1.1.2. Containers
37.1.2. Separation of data (model) and rendering (view)
37.2. Pages
37.2.1. Common page features
37.2.2. Zend_Navigation_Page_Mvc
37.2.3. Zend_Navigation_Page_Uri
37.2.4. Creating custom page types
37.2.5. Creating pages using the page factory
37.3. Containers
37.3.1. Creating containers
37.3.2. Adding pages
37.3.3. Removing pages
37.3.4. Finding pages
37.3.5. Iterating containers
37.3.6. Other operations
37.4. Migrating from Previous Versions
37.4.1. Migrating from versions prior to 1.9

37.1. Introduction

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.

37.1.1. Pages and Containers

There are two main concepts in Zend_Navigation:

37.1.1.1. Pages

A page (Zend_Navigation_Page) 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.

37.1.1.2. Containers

A navigation container (Zend_Navigation_Container) 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.

[Note] Note

Zend_Navigation_Page extends Zend_Navigation_Container, which means that a page can have sub pages.

37.1.2. Separation of data (model) and rendering (view)

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, CSS class, title, lastmod and priority properties for sitemaps, etc.

Read more about rendering navigational elements in the manual section on navigation helpers.