Zend Framework  1.12
Public Member Functions | List of all members
Zend_Navigation Class Reference

Public Member Functions

 __construct ($pages=null)
 Creates a new navigation container.
 
- Public Member Functions inherited from Zend_Navigation_Container
 notifyOrderUpdated ()
 Notifies container that the order of pages are updated.
 
 addPage ($page)
 Adds a page to the container.
 
 addPages ($pages)
 Adds several pages at once.
 
 setPages (array $pages)
 Sets pages this container should have, removing existing pages.
 
 getPages ()
 Returns pages in the container.
 
 removePage ($page)
 Removes the given page from the container.
 
 removePages ()
 Removes all pages in container.
 
 hasPage (Zend_Navigation_Page $page, $recursive=false)
 Checks if the container has the given page.
 
 hasPages ()
 Returns true if container contains any pages.
 
 findOneBy ($property, $value, $useRegex=false)
 Returns a child page matching $property == $value or preg_match($value, $property), or null if not found.
 
 findAllBy ($property, $value, $useRegex=false)
 Returns all child pages matching $property == $value or preg_match($value, $property), or an empty array if no pages are found.
 
 findBy ($property, $value, $all=false, $useRegex=false)
 Returns page(s) matching $property == $value or preg_match($value, $property)
 
 __call ($method, $arguments)
 Magic overload: Proxy calls to finder methods.
 
 toArray ()
 Returns an array representation of all pages in container.
 
 current ()
 Returns current page.
 
 key ()
 Returns hash code of current page.
 
 next ()
 Moves index pointer to next page in the container.
 
 rewind ()
 Sets index pointer to first page in the container.
 
 valid ()
 Checks if container index is valid.
 
 hasChildren ()
 Proxy to hasPages()
 
 getChildren ()
 Returns the child container.
 
 count ()
 Returns number of pages in container.
 

Additional Inherited Members

- Protected Member Functions inherited from Zend_Navigation_Container
 _sort ()
 Sorts the page index according to page order.
 
- Protected Attributes inherited from Zend_Navigation_Container
 $_pages = array()
 
 $_index = array()
 
 $_dirtyIndex = false
 

Constructor & Destructor Documentation

__construct (   $pages = null)

Creates a new navigation container.

Parameters
array | Zend_Config$pages[optional] pages to add
Exceptions
Zend_Navigation_Exceptionif $pages is invalid