Navigation/Page/Mvc.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Navigation  
Subpackage
Page  
Version
$Id: Mvc.php 25213 2013-01-11 08:19:09Z frosch $  

\Zend_Navigation_Page_Mvc

Package: Zend\Navigation\Page

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

Container class for Zend_Navigation_Page classes.

Parent(s)
\Zend_Navigation_Page < \Zend_Navigation_Container
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring|null $_accesskey =
inherited

Accessibility key character

Inherited from: \Zend_Navigation_Page::$$_accesskey

This attribute assigns an access key to an element. An access key is a single character from the document character set.

Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_accesskey  
Link
http://www.w3.org/TR/html401/interact/forms.html#access-keys  
Propertyprotectedstring $_action =

Action name to use when assembling URL

Details
Type
string
Propertyprotectedbool $_active = null

Whether this page should be considered active

Default valuenullDetails
Type
bool
Propertyprotectedstring|null $_class =
inherited

Style class for this page (CSS)

Inherited from: \Zend_Navigation_Page::$$_class
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_class  
Propertyprotectedstring $_controller =

Controller name to use when assembling URL

Details
Type
string
Propertyprotectedarray $_customHtmlAttribs = array()
inherited

Custom HTML attributes

Inherited from: \Zend_Navigation_Page::$$_customHtmlAttribs
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Page::$$_customHtmlAttribs  
Propertyprotectedstring $_defaultPageType =
staticinherited

The type of page to use when it wasn't set

Inherited from: \Zend_Navigation_Page::$$_defaultPageType
Details
Type
string
Inherited_from
\Zend_Navigation_Page::$$_defaultPageType  
Propertyprotectedbool $_dirtyIndex = false
inherited

Whether index is dirty and needs to be re-arranged

Inherited from: \Zend_Navigation_Container::$$_dirtyIndex\Zend_Navigation_Page::$$_dirtyIndex
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Navigation_Container::$$_dirtyIndex  
Inherited_from
\Zend_Navigation_Page::$$_dirtyIndex  
Propertyprotectedbool $_encodeUrl = true

Whether href should be encoded when assembling URL

Default valuetrueDetails
Type
bool
See
\global\getHref()  
Propertyprotectedstring|null $_fragment =
inherited

Fragment identifier (anchor identifier)

Inherited from: \Zend_Navigation_Page::$$_fragment

The fragment identifier (anchor identifier) pointing to an anchor within a resource that is subordinate to another, primary resource. The fragment identifier introduced by a hash mark "#". Example: http://www.example.org/foo.html#bar ("bar" is the fragment identifier)

Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_fragment  
Link
http://www.w3.org/TR/html401/intro/intro.html#fragment-uri  
Propertyprotectedstring $_hrefCache =

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.

Details
Type
string
Propertyprotectedstring|null $_id =
inherited

Page id

Inherited from: \Zend_Navigation_Page::$$_id
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_id  
Propertyprotectedarray $_index = array()
inherited

An index that contains the order in which to iterate pages

Inherited from: \Zend_Navigation_Container::$$_index\Zend_Navigation_Page::$$_index
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Container::$$_index  
Inherited_from
\Zend_Navigation_Page::$$_index  
Propertyprotectedstring|null $_label =
inherited

Page label

Inherited from: \Zend_Navigation_Page::$$_label
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_label  
Propertyprotectedstring $_module =

Module name to use when assembling URL

Details
Type
string
Propertyprotectedint|null $_order =
inherited

Page order used by parent container

Inherited from: \Zend_Navigation_Page::$$_order
Details
Type
int | null
Inherited_from
\Zend_Navigation_Page::$$_order  
Propertyprotectedarray $_pages = array()
inherited

Contains sub pages

Inherited from: \Zend_Navigation_Container::$$_pages\Zend_Navigation_Page::$$_pages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Container::$$_pages  
Inherited_from
\Zend_Navigation_Page::$$_pages  
Propertyprotectedarray $_params = array()

Params to use when assembling URL

Default valuearray()Details
Type
array
See
\global\getHref()  
Propertyprotected\Zend_Navigation_Container|null $_parent =
inherited

Parent container

Inherited from: \Zend_Navigation_Page::$$_parent
Details
Type
\Zend_Navigation_Container | null
Inherited_from
\Zend_Navigation_Page::$$_parent  
Propertyprotectedstring|null $_privilege =
inherited

ACL privilege associated with this page

Inherited from: \Zend_Navigation_Page::$$_privilege
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_privilege  
Propertyprotectedarray $_properties = array()
inherited

Custom page properties, used by __set(), __get() and __isset()

Inherited from: \Zend_Navigation_Page::$$_properties
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Page::$$_properties  
Propertyprotectedarray $_rel = array()
inherited

Forward links to other pages

Inherited from: \Zend_Navigation_Page::$$_rel
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Page::$$_rel  
Link
http://www.w3.org/TR/html4/struct/links.html#h-12.3.1  
Propertyprotectedbool $_resetParams = true

Whether params should be reset when assembling URL

Default valuetrueDetails
Type
bool
See
\global\getHref()  
Propertyprotectedstring|\Zend_Acl_Resource_Interface|null $_resource =
inherited

ACL resource associated with this page

Inherited from: \Zend_Navigation_Page::$$_resource
Details
Type
string | \Zend_Acl_Resource_Interface | null
Inherited_from
\Zend_Navigation_Page::$$_resource  
Propertyprotectedarray $_rev = array()
inherited

Reverse links to other pages

Inherited from: \Zend_Navigation_Page::$$_rev
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Page::$$_rev  
Link
http://www.w3.org/TR/html4/struct/links.html#h-12.3.1  
Propertyprotectedstring $_route =

Route name to use when assembling URL

Details
Type
string
See
\global\getHref()  
Propertyprotectedstring $_scheme =

Scheme to use when assembling URL

Details
Type
string
See
\global\getHref()  
Propertyprotected\Zend_View_Helper_ServerUrl $_schemeHelper = null
static

View helper for assembling URLs with schemes

Default valuenullDetails
Type
\Zend_View_Helper_ServerUrl
See
\global\getHref()  
Propertyprotectedstring|null $_target =
inherited

This page's target

Inherited from: \Zend_Navigation_Page::$$_target
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_target  
Propertyprotectedstring|null $_title =
inherited

A more descriptive title for this page

Inherited from: \Zend_Navigation_Page::$$_title
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_title  
Propertyprotected\Zend_Controller_Action_Helper_Url $_urlHelper = null
static

Action helper for assembling URLs

Default valuenullDetails
Type
\Zend_Controller_Action_Helper_Url
See
\global\getHref()  
Propertyprotectedbool $_visible = true
inherited

Whether this page should be considered visible

Inherited from: \Zend_Navigation_Page::$$_visible
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_Navigation_Page::$$_visible  

Methods

methodpublic__call(string $method, array $arguments) : mixed
inherited

Magic overload: Proxy calls to finder methods

Inherited from: \Zend_Navigation_Container::__call()\Zend_Navigation_Page::__call()

Examples of finder calls:

// METHOD                         // SAME AS
$nav->findByLabel('foo');         // $nav->findOneBy('label', 'foo');
$nav->findByLabel('/foo/', true); // $nav->findBy('label', '/foo/', true);
$nav->findOneByLabel('foo');      // $nav->findOneBy('label', 'foo');
$nav->findAllByClass('foo');      // $nav->findAllBy('class', 'foo');
Parameters
Name Type Description
$method string

method name

$arguments array

method arguments

Returns
Type Description
mixed Zend_Navigation|array|null matching page, array of pages or null
Throws
Exception Description
\Zend_Navigation_Exception if method does not exist
methodpublic__construct(array | \Zend_Config $options = null) : void
inherited

Page constructor

Inherited from: \Zend_Navigation_Page::__construct()
Parameters
Name Type Description
$options array | \Zend_Config

[optional] page options. Default is null, which should set defaults.

Throws
Exception Description
\Zend_Navigation_Exception if invalid options are given
methodpublic__get(string $name) : mixed
inherited

Returns a property, or null if it doesn't exist

Inherited from: \Zend_Navigation_Page::__get()

Magic overload for enabling

$page->propname

.

Parameters
Name Type Description
$name string

property name

Returns
Type Description
mixed property value or null
Throws
Exception Description
\Zend_Navigation_Exception if property name is invalid
methodpublic__isset(string $name) : bool
inherited

Checks if a property is set

Inherited from: \Zend_Navigation_Page::__isset()

Magic overload for enabling

isset($page->propname)

.

Returns true if the property is native (id, class, title, etc), and true or false if it's a custom property (depending on whether the property actually is set).

Parameters
Name Type Description
$name string

property name

Returns
Type Description
bool whether the given property exists
methodpublic__set(string $name, mixed $value) : void
inherited

Sets a custom property

Inherited from: \Zend_Navigation_Page::__set()

Magic overload for enabling

$page->propname = $value

.

Parameters
Name Type Description
$name string

property name

$value mixed

value to set

Throws
Exception Description
\Zend_Navigation_Exception if property name is invalid
methodpublic__toString() : string
inherited

Returns page label

Inherited from: \Zend_Navigation_Page::__toString()

Magic overload for enabling

echo $page

.

Returns
Type Description
string page label
methodpublic__unset(string $name) : void
inherited

Unsets the given custom property

Inherited from: \Zend_Navigation_Page::__unset()

Magic overload for enabling

unset($page->propname)

.

Parameters
Name Type Description
$name string

property name

Throws
Exception Description
\Zend_Navigation_Exception if the property is native
methodprotected_init() : void
inherited

Initializes page (used by subclasses)

Inherited from: \Zend_Navigation_Page::_init()
methodprotected_normalizePropertyName(string $property) : string
staticinherited

Normalizes a property name

Inherited from: \Zend_Navigation_Page::_normalizePropertyName()
Parameters
Name Type Description
$property string

property name to normalize

Returns
Type Description
string normalized property name
methodprotected_sort() : void
inherited

Sorts the page index according to page order

Inherited from: \Zend_Navigation_Container::_sort()\Zend_Navigation_Page::_sort()
methodpublicaddPage(\Zend_Navigation_Page | array | \Zend_Config $page) : \Zend_Navigation_Container
inherited

Adds a page to the container

Inherited from: \Zend_Navigation_Container::addPage()\Zend_Navigation_Page::addPage()

This method will inject the container as the given page's parent by calling Zend_Navigation_Page::setParent().

Parameters
Name Type Description
$page \Zend_Navigation_Page | array | \Zend_Config

page to add

Returns
Type Description
\Zend_Navigation_Container fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if page is invalid
methodpublicaddPages(array | \Zend_Config | \Zend_Navigation_Container $pages) : \Zend_Navigation_Container
inherited

Adds several pages at once

Inherited from: \Zend_Navigation_Container::addPages()\Zend_Navigation_Page::addPages()
Parameters
Name Type Description
$pages array | \Zend_Config | \Zend_Navigation_Container

pages to add

Returns
Type Description
\Zend_Navigation_Container fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if $pages is not array, Zend_Config or Zend_Navigation_Container
methodpublicaddParams(array $params) : \Zend_Navigation_Page_Mvc

Add multiple parameters (to use when assembling URL) at once

URL options passed to the url action helper for assembling URLs.

Parameters
Name Type Description
$params array

paramters as array ('name' => 'value')

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicaddRel(string $relation, mixed $value) : \Zend_Navigation_Page
inherited

Adds a forward relation to the page

Inherited from: \Zend_Navigation_Page::addRel()
Parameters
Name Type Description
$relation string

relation name (e.g. alternate, glossary, canonical, etc)

$value mixed

value to set for relation

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicaddRev(string $relation, mixed $value) : \Zend_Navigation_Page
inherited

Adds a reverse relation to the page

Inherited from: \Zend_Navigation_Page::addRev()
Parameters
Name Type Description
$relation string

relation name (e.g. alternate, glossary, canonical, etc)

$value mixed

value to set for relation

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicclearCustomHtmlAttribs() : \Zend_Navigation_Page
inherited

Clear all custom HTML attributes

Inherited from: \Zend_Navigation_Page::clearCustomHtmlAttribs()
Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicclearParams() : \Zend_Navigation_Page_Mvc

Clear all parameters (to use when assembling URL)

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpubliccount() : int
inherited

Returns number of pages in container

Inherited from: \Zend_Navigation_Container::count()\Zend_Navigation_Page::count()

Implements Countable interface.

Returns
Type Description
int number of pages in the container
methodpubliccurrent() : \Zend_Navigation_Page
inherited

Returns current page

Inherited from: \Zend_Navigation_Container::current()\Zend_Navigation_Page::current()

Implements RecursiveIterator interface.

Returns
Type Description
\Zend_Navigation_Page current page or null
Throws
Exception Description
\Zend_Navigation_Exception if the index is invalid
methodpublicfactory(array | \Zend_Config $options) : \Zend_Navigation_Page
staticinherited

Factory for Zend_Navigation_Page classes

Inherited from: \Zend_Navigation_Page::factory()

A specific type to construct can be specified by specifying the key 'type' in $options. If type is 'uri' or 'mvc', the type will be resolved to Zend_Navigation_Page_Uri or Zend_Navigation_Page_Mvc. Any other value for 'type' will be considered the full name of the class to construct. A valid custom page class must extend Zend_Navigation_Page.

If 'type' is not given, the type of page to construct will be determined by the following rules: - If $options contains either of the keys 'action', 'controller', 'module', or 'route', a Zend_Navigation_Page_Mvc page will be created. - If $options contains the key 'uri', a Zend_Navigation_Page_Uri page will be created.

Parameters
Name Type Description
$options array | \Zend_Config

options used for creating page

Returns
Type Description
\Zend_Navigation_Page a page instance
Throws
Exception Description
\Zend_Navigation_Exception if $options is not array/Zend_Config
\Zend_Exception if 'type' is specified and Zend_Loader is unable to load the class
\Zend_Navigation_Exception if something goes wrong during instantiation of the page
\Zend_Navigation_Exception if 'type' is given, and the specified type does not extend this class
\Zend_Navigation_Exception if unable to determine which class to instantiate
methodpublicfindAllBy(string $property, mixed $value, bool $useRegex = false) : array
inherited

Returns all child pages matching $property == $value or preg_match($value, $property), or an empty array if no pages are found

Inherited from: \Zend_Navigation_Container::findAllBy()\Zend_Navigation_Page::findAllBy()
Parameters
Name Type Description
$property string

name of property to match against

$value mixed

value to match property against

$useRegex bool

[optional] if true PHP's preg_match is used. Default is false.

Returns
Type Description
array array containing only Zend_Navigation_Page instances
methodpublicfindBy(string $property, mixed $value, bool $all = false, bool $useRegex = false) : \Zend_Navigation_Page | null
inherited

Returns page(s) matching $property == $value or preg_match($value, $property)

Inherited from: \Zend_Navigation_Container::findBy()\Zend_Navigation_Page::findBy()
Parameters
Name Type Description
$property string

name of property to match against

$value mixed

value to match property against

$all bool

[optional] whether an array of all matching pages should be returned, or only the first. If true, an array will be returned, even if not matching pages are found. If false, null will be returned if no matching page is found. Default is false.

$useRegex bool

[optional] if true PHP's preg_match is used. Default is false.

Returns
Type Description
\Zend_Navigation_Page | null matching page or null
methodpublicfindOneBy(string $property, mixed $value, bool $useRegex = false) : \Zend_Navigation_Page | null
inherited

Returns a child page matching $property == $value or preg_match($value, $property), or null if not found

Inherited from: \Zend_Navigation_Container::findOneBy()\Zend_Navigation_Page::findOneBy()
Parameters
Name Type Description
$property string

name of property to match against

$value mixed

value to match property against

$useRegex bool

[optional] if true PHP's preg_match is used. Default is false.

Returns
Type Description
\Zend_Navigation_Page | null matching page or null
methodpublicget(string $property) : mixed
inherited

Returns the value of the given property

Inherited from: \Zend_Navigation_Page::get()

If the given property is native (id, class, title, etc), the matching get method will be used. Otherwise, it will return the matching custom property, or null if not found.

Parameters
Name Type Description
$property string

property name

Returns
Type Description
mixed the property's value or null
Throws
Exception Description
\Zend_Navigation_Exception if property name is invalid
methodpublicgetAccesskey() : string | null
inherited

Returns page access key

Inherited from: \Zend_Navigation_Page::getAccesskey()
Returns
Type Description
string | null page access key or null
methodpublicgetAction() : string | null

Returns action name to use when assembling URL

Returns
Type Description
string | null action name
Details
See
\global\getHref()  
methodpublicgetActive(bool $recursive = false) : bool
inherited

Proxy to isActive()

Inherited from: \Zend_Navigation_Page::getActive()
Parameters
Name Type Description
$recursive bool

[optional] whether page should be considered active if any child pages are active. Default is false.

Returns
Type Description
bool whether page should be considered active
methodpublicgetChildren() : \Zend_Navigation_Page | null
inherited

Returns the child container.

Inherited from: \Zend_Navigation_Container::getChildren()\Zend_Navigation_Page::getChildren()

Implements RecursiveIterator interface.

Returns
Type Description
\Zend_Navigation_Page | null
methodpublicgetClass() : string | null
inherited

Returns page class (CSS)

Inherited from: \Zend_Navigation_Page::getClass()
Returns
Type Description
string | null page's CSS class or null
methodpublicgetController() : string | null

Returns controller name to use when assembling URL

Returns
Type Description
string | null controller name or null
Details
See
\global\getHref()  
methodpublicgetCustomHtmlAttrib(string $name) : string | null
inherited

Returns a single custom HTML attributes by name

Inherited from: \Zend_Navigation_Page::getCustomHtmlAttrib()
Parameters
Name Type Description
$name string

name of the HTML attribute

Returns
Type Description
string | null value for the HTML attribute or null
Throws
Exception Description
\Zend_Navigation_Exception if name is not string
methodpublicgetCustomHtmlAttribs() : array
inherited

Returns all custom HTML attributes as an array

Inherited from: \Zend_Navigation_Page::getCustomHtmlAttribs()
Returns
Type Description
array an array containing custom HTML attributes
methodpublicgetCustomProperties() : array
inherited

Returns custom properties as an array

Inherited from: \Zend_Navigation_Page::getCustomProperties()
Returns
Type Description
array an array containing custom properties
methodpublicgetDefaultPageType() : void
staticinherited

Inherited from: \Zend_Navigation_Page::getDefaultPageType()
methodpublicgetDefinedRel() : array
inherited

Returns an array containing the defined forward relations

Inherited from: \Zend_Navigation_Page::getDefinedRel()
Returns
Type Description
array defined forward relations
methodpublicgetDefinedRev() : array
inherited

Returns an array containing the defined reverse relations

Inherited from: \Zend_Navigation_Page::getDefinedRev()
Returns
Type Description
array defined reverse relations
methodpublicgetEncodeUrl() : bool

Returns whether herf should be encoded when assembling URL

Returns
Type Description
bool whether herf should be encoded when assembling URL
Details
See
\global\getHref()  
methodpublicgetFragment() : string | null
inherited

Returns fragment identifier

Inherited from: \Zend_Navigation_Page::getFragment()
Returns
Type Description
string | null fragment identifier
methodpublicgetHref() : string

Returns href for this page

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

Returns
Type Description
string page href
methodpublicgetId() : string | null
inherited

Returns page id

Inherited from: \Zend_Navigation_Page::getId()
Returns
Type Description
string | null page id or null
methodpublicgetLabel() : string
inherited

Returns page label

Inherited from: \Zend_Navigation_Page::getLabel()
Returns
Type Description
string page label or null
methodpublicgetModule() : string | null

Returns module name to use when assembling URL

Returns
Type Description
string | null module name or null
Details
See
\global\getHref()  
methodpublicgetOrder() : int | null
inherited

Returns page order used in parent container

Inherited from: \Zend_Navigation_Page::getOrder()
Returns
Type Description
int | null page order or null
methodpublicgetPages() : array
inherited

Returns pages in the container

Inherited from: \Zend_Navigation_Container::getPages()\Zend_Navigation_Page::getPages()
Returns
Type Description
array array of Zend_Navigation_Page instances
methodpublicgetParam(string $name) : mixed

Retrieve a single parameter (to use when assembling URL)

Parameters
Name Type Description
$name string

parameter name

Returns
Type Description
mixed
Details
See
\global\getHref()  
methodpublicgetParams() : array

Retrieve all parameters (to use when assembling URL)

Returns
Type Description
array parameters as array ('name' => 'value')
Details
See
\global\getHref()  
methodpublicgetParent() : \Zend_Navigation_Container | null
inherited

Returns parent container

Inherited from: \Zend_Navigation_Page::getParent()
Returns
Type Description
\Zend_Navigation_Container | null parent container or null
methodpublicgetPrivilege() : string | null
inherited

Returns ACL privilege associated with this page

Inherited from: \Zend_Navigation_Page::getPrivilege()
Returns
Type Description
string | null ACL privilege or null
methodpublicgetRel(string $relation = null) : array
inherited

Returns the page's forward links to other pages

Inherited from: \Zend_Navigation_Page::getRel()

This method returns an associative array of forward links to other pages, where each element's key is the name of the relation (e.g. alternate, prev, next, help, etc), and the value is a mixed value that could somehow be considered a page.

Parameters
Name Type Description
$relation string

[optional] name of relation to return. If not given, all relations will be returned.

Returns
Type Description
array an array of relations. If $relation is not specified, all relations will be returned in an associative array.
methodpublicgetResetParams() : bool

Returns whether params should be reset when assembling URL

Returns
Type Description
bool whether params should be reset when assembling URL
Details
See
\global\getHref()  
methodpublicgetResource() : string | \Zend_Acl_Resource_Interface | null
inherited

Returns ACL resource assoicated with this page

Inherited from: \Zend_Navigation_Page::getResource()
Returns
Type Description
string | \Zend_Acl_Resource_Interface | null ACL resource or null
methodpublicgetRev(string $relation = null) : array
inherited

Returns the page's reverse links to other pages

Inherited from: \Zend_Navigation_Page::getRev()

This method returns an associative array of forward links to other pages, where each element's key is the name of the relation (e.g. alternate, prev, next, help, etc), and the value is a mixed value that could somehow be considered a page.

Parameters
Name Type Description
$relation string

[optional] name of relation to return. If not given, all relations will be returned.

Returns
Type Description
array an array of relations. If $relation is not specified, all relations will be returned in an associative array.
methodpublicgetRoute() : string

Returns route name to use when assembling URL

Returns
Type Description
string route name
Details
See
\global\getHref()  
methodpublicgetScheme() : string | null

Returns scheme to use when assembling URL

Returns
Type Description
string | null scheme or null
Details
See
\global\getHref()  
methodpublicgetTarget() : string | null
inherited

Returns page target

Inherited from: \Zend_Navigation_Page::getTarget()
Returns
Type Description
string | null page target or null
methodpublicgetTitle() : string | null
inherited

Returns page title

Inherited from: \Zend_Navigation_Page::getTitle()
Returns
Type Description
string | null page title or null
methodpublicgetVisible(bool $recursive = false) : bool
inherited

Proxy to isVisible()

Inherited from: \Zend_Navigation_Page::getVisible()

Returns a boolean value indicating whether the page is visible

Parameters
Name Type Description
$recursive bool

[optional] whether page should be considered invisible if parent is invisible. Default is false.

Returns
Type Description
bool whether page should be considered visible
methodpublichasChildren() : bool

Implements RecursiveIterator interface.

Returns
Type Description
bool whether container has any pages
methodpublichasPage(\Zend_Navigation_Page $page, bool $recursive = false) : bool
inherited

Checks if the container has the given page

Inherited from: \Zend_Navigation_Container::hasPage()\Zend_Navigation_Page::hasPage()
Parameters
Name Type Description
$page \Zend_Navigation_Page

page to look for

$recursive bool

[optional] whether to search recursively. Default is false.

Returns
Type Description
bool whether page is in container
methodpublichasPages() : bool
inherited

Returns true if container contains any pages

Inherited from: \Zend_Navigation_Container::hasPages()\Zend_Navigation_Page::hasPages()
Returns
Type Description
bool whether container has any pages
methodpublichashCode() : string
finalinherited

Returns a hash code value for the page

Inherited from: \Zend_Navigation_Page::hashCode()
Returns
Type Description
string a hash code value for this page
methodpublicisActive(bool $recursive = false) : bool

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.

Parameters
Name Type Description
$recursive bool

[optional] whether page should be considered active if any child pages are active. Default is false.

Returns
Type Description
bool whether page should be considered active or not
methodpublicisVisible(bool $recursive = false) : bool
inherited

Returns a boolean value indicating whether the page is visible

Inherited from: \Zend_Navigation_Page::isVisible()
Parameters
Name Type Description
$recursive bool

[optional] whether page should be considered invisible if parent is invisible. Default is false.

Returns
Type Description
bool whether page should be considered visible
methodpublickey() : string
inherited

Returns hash code of current page

Inherited from: \Zend_Navigation_Container::key()\Zend_Navigation_Page::key()

Implements RecursiveIterator interface.

Returns
Type Description
string hash code of current page
methodpublicnext() : void
inherited

Moves index pointer to next page in the container

Inherited from: \Zend_Navigation_Container::next()\Zend_Navigation_Page::next()

Implements RecursiveIterator interface.

methodpublicnotifyOrderUpdated() : void
inherited

Notifies container that the order of pages are updated

Inherited from: \Zend_Navigation_Container::notifyOrderUpdated()\Zend_Navigation_Page::notifyOrderUpdated()
methodpublicremoveCustomHtmlAttrib(string $name) : \Zend_Navigation_Page
inherited

Removes a custom HTML attribute from the page

Inherited from: \Zend_Navigation_Page::removeCustomHtmlAttrib()
Parameters
Name Type Description
$name string

name of the custom HTML attribute

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicremovePage(\Zend_Navigation_Page | int $page) : bool
inherited

Removes the given page from the container

Inherited from: \Zend_Navigation_Container::removePage()\Zend_Navigation_Page::removePage()
Parameters
Name Type Description
$page \Zend_Navigation_Page | int

page to remove, either a page instance or a specific page order

Returns
Type Description
bool whether the removal was successful
methodpublicremovePages() : \Zend_Navigation_Container
inherited

Removes all pages in container

Inherited from: \Zend_Navigation_Container::removePages()\Zend_Navigation_Page::removePages()
Returns
Type Description
\Zend_Navigation_Container fluent interface, returns self
methodpublicremoveParam(string $name) : bool

Remove parameter (to use when assembling URL)

Parameters
Name Type Description
$name string
Returns
Type Description
bool
Details
See
\global\getHref()  
methodpublicremoveRel(string $relation) : \Zend_Navigation_Page
inherited

Removes a forward relation from the page

Inherited from: \Zend_Navigation_Page::removeRel()
Parameters
Name Type Description
$relation string

name of relation to remove

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicremoveRev(string $relation) : \Zend_Navigation_Page
inherited

Removes a reverse relation from the page

Inherited from: \Zend_Navigation_Page::removeRev()
Parameters
Name Type Description
$relation string

name of relation to remove

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicrewind() : void
inherited

Sets index pointer to first page in the container

Inherited from: \Zend_Navigation_Container::rewind()\Zend_Navigation_Page::rewind()

Implements RecursiveIterator interface.

methodpublicset(string $property, mixed $value) : \Zend_Navigation_Page
inherited

Sets the given property

Inherited from: \Zend_Navigation_Page::set()

If the given property is native (id, class, title, etc), the matching set method will be used. Otherwise, it will be set as a custom property.

Parameters
Name Type Description
$property string

property name

$value mixed

value to set

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if property name is invalid
methodpublicsetAccesskey(string | null $character = null) : \Zend_Navigation_Page
inherited

Sets access key for this page

Inherited from: \Zend_Navigation_Page::setAccesskey()
Parameters
Name Type Description
$character string | null

[optional] access key to set. Default is null, which sets no access key.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if access key is not string or null or if the string length not equal to one
methodpublicsetAction(string $action) : \Zend_Navigation_Page_Mvc

Sets action name to use when assembling URL

Parameters
Name Type Description
$action string

action name

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid $action is given
Details
See
\global\getHref()  
methodpublicsetActive(bool $active = true) : \Zend_Navigation_Page
inherited

Sets whether page should be considered active or not

Inherited from: \Zend_Navigation_Page::setActive()
Parameters
Name Type Description
$active bool

[optional] whether page should be considered active or not. Default is true.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetClass(string | null $class = null) : \Zend_Navigation_Page
inherited

Sets page CSS class

Inherited from: \Zend_Navigation_Page::setClass()
Parameters
Name Type Description
$class string | null

[optional] CSS class to set. Default is null, which sets no CSS class.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if not given string or null
methodpublicsetConfig(\Zend_Config $config) : \Zend_Navigation_Page
inherited

Sets page properties using a Zend_Config object

Inherited from: \Zend_Navigation_Page::setConfig()
Parameters
Name Type Description
$config \Zend_Config

config object to get properties from

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid options are given
methodpublicsetController(string | null $controller) : \Zend_Navigation_Page_Mvc

Sets controller name to use when assembling URL

Parameters
Name Type Description
$controller string | null

controller name

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid controller name is given
Details
See
\global\getHref()  
methodpublicsetCustomHtmlAttrib(string $name, string | null $value) : \Zend_Navigation_Page
inherited

Sets a single custom HTML attribute

Inherited from: \Zend_Navigation_Page::setCustomHtmlAttrib()
Parameters
Name Type Description
$name string

name of the HTML attribute

$value string | null

value for the HTML attribute

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if name is not string or value is not null or a string
methodpublicsetCustomHtmlAttribs(array $attribs) : \Zend_Navigation_Page
inherited

Sets multiple custom HTML attributes at once

Inherited from: \Zend_Navigation_Page::setCustomHtmlAttribs()
Parameters
Name Type Description
$attribs array

an associative array of html attributes

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetDefaultPageType( $type = null) : void
staticinherited

Inherited from: \Zend_Navigation_Page::setDefaultPageType()
Parameters
Name Type Description
$type
methodpublicsetEncodeUrl( $encodeUrl) : \Zend_Navigation_Page_Mvc

Sets whether href should be encoded when assembling URL

Parameters
Name Type Description
$encodeUrl
Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicsetFragment(string $fragment) : \Zend_Navigation_Page
inherited

Sets a fragment identifier

Inherited from: \Zend_Navigation_Page::setFragment()
Parameters
Name Type Description
$fragment string

new fragment identifier

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if empty/no string is given
methodpublicsetId(string | null $id = null) : \Zend_Navigation_Page
inherited

Sets page id

Inherited from: \Zend_Navigation_Page::setId()
Parameters
Name Type Description
$id string | null

[optional] id to set. Default is null, which sets no id.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if not given string or null
methodpublicsetLabel(string $label) : \Zend_Navigation_Page
inherited

Sets page label

Inherited from: \Zend_Navigation_Page::setLabel()
Parameters
Name Type Description
$label string

new page label

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if empty/no string is given
methodpublicsetModule(string | null $module) : \Zend_Navigation_Page_Mvc

Sets module name to use when assembling URL

Parameters
Name Type Description
$module string | null

module name

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid module name is given
Details
See
\global\getHref()  
methodpublicsetOptions(array $options) : \Zend_Navigation_Page
inherited

Sets page properties using options from an associative array

Inherited from: \Zend_Navigation_Page::setOptions()

Each key in the array corresponds to the according set*() method, and each word is separated by underscores, e.g. the option 'target' corresponds to setTarget(), and the option 'reset_params' corresponds to the method setResetParams().

Parameters
Name Type Description
$options array

associative array of options to set

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid options are given
methodpublicsetOrder(int $order = null) : \Zend_Navigation_Page
inherited

Sets page order to use in parent container

Inherited from: \Zend_Navigation_Page::setOrder()
Parameters
Name Type Description
$order int

[optional] page order in container. Default is null, which sets no specific order.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if order is not integer or null
methodpublicsetPages(array $pages) : \Zend_Navigation_Container
inherited

Sets pages this container should have, removing existing pages

Inherited from: \Zend_Navigation_Container::setPages()\Zend_Navigation_Page::setPages()
Parameters
Name Type Description
$pages array

pages to set

Returns
Type Description
\Zend_Navigation_Container fluent interface, returns self
methodpublicsetParam(string $name, mixed $value) : \Zend_Navigation_Page_Mvc

Set parameter (to use when assembling URL)

URL option passed to the url action helper for assembling URLs.

Parameters
Name Type Description
$name string

parameter name

$value mixed

parameter value

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicsetParams(array | null $params = null) : \Zend_Navigation_Page_Mvc

Set multiple parameters (to use when assembling URL) at once

URL options passed to the url action helper for assembling URLs. Overwrites any previously set parameters!

Parameters
Name Type Description
$params array | null

[optional] paramters as array ('name' => 'value'). Default is null which clears all params.

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicsetParent(\Zend_Navigation_Container $parent = null) : \Zend_Navigation_Page
inherited

Sets parent container

Inherited from: \Zend_Navigation_Page::setParent()
Parameters
Name Type Description
$parent \Zend_Navigation_Container

[optional] new parent to set. Default is null which will set no parent.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetPrivilege(string | null $privilege = null) : \Zend_Navigation_Page
inherited

Sets ACL privilege associated with this page

Inherited from: \Zend_Navigation_Page::setPrivilege()
Parameters
Name Type Description
$privilege string | null

[optional] ACL privilege to associate with this page. Default is null, which sets no privilege.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetRel(array | \Zend_Config $relations = null) : \Zend_Navigation_Page
inherited

Sets the page's forward links to other pages

Inherited from: \Zend_Navigation_Page::setRel()

This method expects an associative array of forward links to other pages, where each element's key is the name of the relation (e.g. alternate, prev, next, help, etc), and the value is a mixed value that could somehow be considered a page.

Parameters
Name Type Description
$relations array | \Zend_Config

[optional] an associative array of forward links to other pages

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetResetParams(bool $resetParams) : \Zend_Navigation_Page_Mvc

Sets whether params should be reset when assembling URL

Parameters
Name Type Description
$resetParams bool

whether params should be reset when assembling URL

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicsetResource(string | \Zend_Acl_Resource_Interface $resource = null) : \Zend_Navigation_Page
inherited

Sets ACL resource assoicated with this page

Inherited from: \Zend_Navigation_Page::setResource()
Parameters
Name Type Description
$resource string | \Zend_Acl_Resource_Interface

[optional] resource to associate with page. Default is null, which sets no resource.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if $resource if invalid
methodpublicsetRev(array | \Zend_Config $relations = null) : \Zend_Navigation_Page
inherited

Sets the page's reverse links to other pages

Inherited from: \Zend_Navigation_Page::setRev()

This method expects an associative array of reverse links to other pages, where each element's key is the name of the relation (e.g. alternate, prev, next, help, etc), and the value is a mixed value that could somehow be considered a page.

Parameters
Name Type Description
$relations array | \Zend_Config

[optional] an associative array of reverse links to other pages

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicsetRoute(string $route) : \Zend_Navigation_Page_Mvc

Sets route name to use when assembling URL

Parameters
Name Type Description
$route string

route name to use when assembling URL

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if invalid $route is given
Details
See
\global\getHref()  
methodpublicsetScheme(string | null $scheme) : \Zend_Navigation_Page_Mvc

Sets scheme to use when assembling URL

Parameters
Name Type Description
$scheme string | null

scheme

Returns
Type Description
\Zend_Navigation_Page_Mvc fluent interface, returns self
Details
See
\global\getHref()  
methodpublicsetSchemeHelper(\Zend_View_Helper_ServerUrl $sh) : void
static

Sets view helper for assembling URLs with schemes

Parameters
Name Type Description
$sh \Zend_View_Helper_ServerUrl

scheme helper

Details
See
\global\getHref()  
methodpublicsetTarget(string | null $target = null) : \Zend_Navigation_Page
inherited

Sets page target

Inherited from: \Zend_Navigation_Page::setTarget()
Parameters
Name Type Description
$target string | null

[optional] target to set. Default is null, which sets no target.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if target is not string or null
methodpublicsetTitle(string $title = null) : \Zend_Navigation_Page
inherited

Sets page title

Inherited from: \Zend_Navigation_Page::setTitle()
Parameters
Name Type Description
$title string

[optional] page title. Default is null, which sets no title.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
Throws
Exception Description
\Zend_Navigation_Exception if not given string or null
methodpublicsetUrlHelper(\Zend_Controller_Action_Helper_Url $uh) : void
static

Sets action helper for assembling URLs

Parameters
Name Type Description
$uh \Zend_Controller_Action_Helper_Url

URL helper

Details
See
\global\getHref()  
methodpublicsetVisible(bool $visible = true) : \Zend_Navigation_Page
inherited

Sets whether the page should be visible or not

Inherited from: \Zend_Navigation_Page::setVisible()
Parameters
Name Type Description
$visible bool

[optional] whether page should be considered visible or not. Default is true.

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublictoArray() : array

Returns an array representation of the page

Returns
Type Description
array associative array containing all page properties
methodpublicvalid() : bool
inherited

Checks if container index is valid

Inherited from: \Zend_Navigation_Container::valid()\Zend_Navigation_Page::valid()

Implements RecursiveIterator interface.

Returns
Type Description
bool
Documentation was generated by phpDocumentor 2.0.0a8.