Represents a page that is defined using module, controller, action, route name and route params to assemble the href

• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• license: New BSD License

Located in /Navigation/Page/Mvc.php (line 50)

Zend_Navigation_Container
   |
   --Zend_Navigation_Page
      |
      --Zend_Navigation_Page_Mvc

static Zend_Controller_Action_Helper_Url $_urlHelper = null (line 114)

Action helper for assembling URLs

• see: Zend_Navigation_Page_Mvc::getHref()
• access: protected

string $_action (line 57)

Action name to use when assembling URL

• access: protected

string $_controller (line 64)

Controller name to use when assembling URL

• access: protected

string $_hrefCache (line 106)

Cached href

The use of this variable minimizes execution time when getHref() is called more than once during the lifetime of a request. If a property is updated, the cache is invalidated.

• access: protected

string $_module (line 71)

Module name to use when assembling URL

• access: protected

array $_params = array() (line 79)

Params to use when assembling URL

• see: Zend_Navigation_Page_Mvc::getHref()
• access: protected

bool $_resetParams = true (line 95)

Whether params should be reset when assembling URL

• see: Zend_Navigation_Page_Mvc::getHref()
• access: protected

string $_route (line 87)

Route name to use when assembling URL

• see: Zend_Navigation_Page_Mvc::getHref()
• access: protected

Inherited Variables

Inherited from Zend_Navigation_Page

Zend_Navigation_Page::$_active
Zend_Navigation_Page::$_class
Zend_Navigation_Page::$_id
Zend_Navigation_Page::$_label
Zend_Navigation_Page::$_order
Zend_Navigation_Page::$_parent
Zend_Navigation_Page::$_privilege
Zend_Navigation_Page::$_properties
Zend_Navigation_Page::$_rel
Zend_Navigation_Page::$_resource
Zend_Navigation_Page::$_rev
Zend_Navigation_Page::$_target
Zend_Navigation_Page::$_title
Zend_Navigation_Page::$_visible

Inherited from Zend_Navigation_Container

Zend_Navigation_Container::$_dirtyIndex
Zend_Navigation_Container::$_index
Zend_Navigation_Container::$_pages

static setUrlHelper (line 415)

Sets action helper for assembling URLs

• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

static void setUrlHelper ( $uh)

• Zend_Controller_Action_Helper_Url $uh: URL helper

getAction (line 238)

Returns action name to use when assembling URL

• return: action name
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

string|null getAction ()

getController (line 272)

Returns controller name to use when assembling URL

• return: controller name or null
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

string|null getController ()

getHref (line 177)

Returns href for this page

This method uses Zend_Controller_Action_Helper_Url to assemble the href based on the page's properties.

• return: page href
• access: public

string getHref ()

---

Redefinition of:

Zend_Navigation_Page::getHref()

Returns href for this page

getModule (line 306)

Returns module name to use when assembling URL

• return: module name or null
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

string|null getModule ()

getParams (line 340)

Returns params to use when assembling URL

• return: page params
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

array getParams ()

getResetParams (line 402)

Returns whether params should be reset when assembling URL

• return: whether params should be reset when assembling URL
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

bool getResetParams ()

getRoute (line 374)

Returns route name to use when assembling URL

• return: route name
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

string getRoute ()

isActive (line 129)

Returns whether page should be considered active or not

This method will compare the page properties against the request object that is found in the front controller.

• return: whether page should be considered active or not
• access: public

bool isActive ([bool $recursive = false])

• bool $recursive: [optional] whether page should be considered active if any child pages are active. Default is false.

---

Redefinition of:

Zend_Navigation_Page::isActive()

Returns whether page should be considered active or not

setAction (line 218)

Sets action name to use when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• throws: Zend_Navigation_Exception if invalid $action is given
• access: public

Zend_Navigation_Page_Mvc setAction (string $action)

• string $action: action name

setController (line 252)

Sets controller name to use when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• throws: Zend_Navigation_Exception if invalid controller name is given
• access: public

Zend_Navigation_Page_Mvc setController (string|null $controller)

• string|null $controller: controller name

setModule (line 286)

Sets module name to use when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• throws: Zend_Navigation_Exception if invalid module name is given
• access: public

Zend_Navigation_Page_Mvc setModule (string|null $module)

• string|null $module: module name

setParams (line 320)

Sets params to use when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

Zend_Navigation_Page_Mvc setParams ([ $params = null])

• array|null $params: [optional] page params. Default is null which sets no params.

setResetParams (line 388)

Sets whether params should be reset when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• access: public

Zend_Navigation_Page_Mvc setResetParams (bool $resetParams)

• bool $resetParams: whether params should be reset when assembling URL

setRoute (line 354)

Sets route name to use when assembling URL

• return: fluent interface, returns self
• see: Zend_Navigation_Page_Mvc::getHref()
• throws: Zend_Navigation_Exception if invalid $route is given
• access: public

Zend_Navigation_Page_Mvc setRoute (string $route)

• string $route: route name to use when assembling URL

toArray (line 427)

Returns an array representation of the page

• return: associative array containing all page properties
• access: public

array toArray ()

---

Redefinition of:

Zend_Navigation_Page::toArray()

Returns an array representation of the page

Inherited Methods

Inherited From Zend_Navigation_Page

Zend_Navigation_Page::__construct()
Zend_Navigation_Page::addRel()
Zend_Navigation_Page::addRev()
Zend_Navigation_Page::factory()
Zend_Navigation_Page::get()
Zend_Navigation_Page::getActive()
Zend_Navigation_Page::getClass()
Zend_Navigation_Page::getCustomProperties()
Zend_Navigation_Page::getDefinedRel()
Zend_Navigation_Page::getDefinedRev()
Zend_Navigation_Page::getHref()
Zend_Navigation_Page::getId()
Zend_Navigation_Page::getLabel()
Zend_Navigation_Page::getOrder()
Zend_Navigation_Page::getParent()
Zend_Navigation_Page::getPrivilege()
Zend_Navigation_Page::getRel()
Zend_Navigation_Page::getResource()
Zend_Navigation_Page::getRev()
Zend_Navigation_Page::getTarget()
Zend_Navigation_Page::getTitle()
Zend_Navigation_Page::getVisible()
Zend_Navigation_Page::hashCode()
Zend_Navigation_Page::isActive()
Zend_Navigation_Page::isVisible()
Zend_Navigation_Page::removeRel()
Zend_Navigation_Page::removeRev()
Zend_Navigation_Page::set()
Zend_Navigation_Page::setActive()
Zend_Navigation_Page::setClass()
Zend_Navigation_Page::setConfig()
Zend_Navigation_Page::setId()
Zend_Navigation_Page::setLabel()
Zend_Navigation_Page::setOptions()
Zend_Navigation_Page::setOrder()
Zend_Navigation_Page::setParent()
Zend_Navigation_Page::setPrivilege()
Zend_Navigation_Page::setRel()
Zend_Navigation_Page::setResource()
Zend_Navigation_Page::setRev()
Zend_Navigation_Page::setTarget()
Zend_Navigation_Page::setTitle()
Zend_Navigation_Page::setVisible()
Zend_Navigation_Page::toArray()
Zend_Navigation_Page::_init()
Zend_Navigation_Page::_normalizePropertyName()
Zend_Navigation_Page::__get()
Zend_Navigation_Page::__isset()
Zend_Navigation_Page::__set()
Zend_Navigation_Page::__toString()
Zend_Navigation_Page::__unset()

Inherited From Zend_Navigation_Container

Zend_Navigation_Container::addPage()
Zend_Navigation_Container::addPages()
Zend_Navigation_Container::count()
Zend_Navigation_Container::current()
Zend_Navigation_Container::findAllBy()
Zend_Navigation_Container::findBy()
Zend_Navigation_Container::findOneBy()
Zend_Navigation_Container::getChildren()
Zend_Navigation_Container::getPages()
Zend_Navigation_Container::hasChildren()
Zend_Navigation_Container::hasPage()
Zend_Navigation_Container::hasPages()
Zend_Navigation_Container::key()
Zend_Navigation_Container::next()
Zend_Navigation_Container::notifyOrderUpdated()
Zend_Navigation_Container::removePage()
Zend_Navigation_Container::removePages()
Zend_Navigation_Container::rewind()
Zend_Navigation_Container::setPages()
Zend_Navigation_Container::toArray()
Zend_Navigation_Container::valid()
Zend_Navigation_Container::_sort()
Zend_Navigation_Container::__call()