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.

category Zend
package Zend_Navigation
subpackage Page
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Navigation_Page

 Methods

Magic overload: Proxy calls to finder methods

__call(string $method, array $arguments) : mixed
Inherited

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

$method

string

method name

$arguments

array

method arguments

Exceptions

\Zend_Navigation_Exception if method does not exist

Returns

mixedZend_Navigation|array|null matching page, array of pages or null

Page constructor

__construct(array|\Zend_Config $options = null
Inherited

Parameters

$options

array\Zend_Config

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

Exceptions

\Zend_Navigation_Exception if invalid options are given

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

__get(string $name) : mixed
Inherited

Magic overload for enabling $page->propname.

Parameters

$name

string

property name

Exceptions

\Zend_Navigation_Exception if property name is invalid

Returns

mixedproperty value or null

Checks if a property is set

__isset(string $name) : boolean
Inherited

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

string

property name

Returns

booleanwhether the given property exists

Sets a custom property

__set(string $name, mixed $value) : void
Inherited

Magic overload for enabling $page->propname = $value.

Parameters

$name

string

property name

$value

mixed

value to set

Exceptions

\Zend_Navigation_Exception if property name is invalid

Returns page label

__toString() : string
Inherited

Magic overload for enabling echo $page.

Returns

stringpage label

Unsets the given custom property

__unset(string $name) : void
Inherited

Magic overload for enabling unset($page->propname).

Parameters

$name

string

property name

Exceptions

\Zend_Navigation_Exception if the property is native

Adds a page to the container

addPage(\Zend_Navigation_Page|array|\Zend_Config $page) : \Zend_Navigation_Container
Inherited

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

Parameters

$page

\Zend_Navigation_Pagearray\Zend_Config

page to add

Exceptions

\Zend_Navigation_Exception if page is invalid

Returns

\Zend_Navigation_Containerfluent interface, returns self

Adds several pages at once

addPages(array<mixed,\Zend_Navigation_Page>|\Zend_Config|\Zend_Navigation_Container $pages) : \Zend_Navigation_Container
Inherited

Parameters

$pages

array<mixed,\Zend_Navigation_Page>\Zend_Config\Zend_Navigation_Container

pages to add

Exceptions

\Zend_Navigation_Exception if $pages is not array, Zend_Config or Zend_Navigation_Container

Returns

\Zend_Navigation_Containerfluent interface, returns self

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

addParams(array $params) : \Zend_Navigation_Page_Mvc

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

see

Parameters

$params

array

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

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Adds a forward relation to the page

addRel(string $relation, mixed $value) : \Zend_Navigation_Page
Inherited

Parameters

$relation

string

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

$value

mixed

value to set for relation

Returns

\Zend_Navigation_Pagefluent interface, returns self

Adds a reverse relation to the page

addRev(string $relation, mixed $value) : \Zend_Navigation_Page
Inherited

Parameters

$relation

string

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

$value

mixed

value to set for relation

Returns

\Zend_Navigation_Pagefluent interface, returns self

Clear all custom HTML attributes

clearCustomHtmlAttribs() : \Zend_Navigation_Page
Inherited

Returns

\Zend_Navigation_Pagefluent interface, returns self

Clear all parameters (to use when assembling URL)

clearParams() : \Zend_Navigation_Page_Mvc
see

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Returns number of pages in container

count() : integer
Inherited

Implements Countable interface.

Returns

integernumber of pages in the container

Returns current page

current() : \Zend_Navigation_Page
Inherited

Implements RecursiveIterator interface.

Exceptions

\Zend_Navigation_Exception if the index is invalid

Returns

\Zend_Navigation_Pagecurrent page or null

Factory for Zend_Navigation_Page classes

factory(array|\Zend_Config $options) : \Zend_Navigation_Page
InheritedStatic

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

$options

array\Zend_Config

options used for creating page

Exceptions

\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

Returns

\Zend_Navigation_Pagea page instance

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

findAllBy(string $property, mixed $value, boolean $useRegex = false) : array<mixed,\Zend_Navigation_Page>
Inherited

Parameters

$property

string

name of property to match against

$value

mixed

value to match property against

$useRegex

boolean

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

Returns

array<mixed,\Zend_Navigation_Page>array containing only Zend_Navigation_Page instances

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

findBy(string $property, mixed $value, boolean $all = false, boolean $useRegex = false) : \Zend_Navigation_Page | null
Inherited

Parameters

$property

string

name of property to match against

$value

mixed

value to match property against

$all

boolean

[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

boolean

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

Returns

\Zend_Navigation_Pagenullmatching page or null

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

findOneBy(string $property, mixed $value, boolean $useRegex = false) : \Zend_Navigation_Page | null
Inherited

Parameters

$property

string

name of property to match against

$value

mixed

value to match property against

$useRegex

boolean

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

Returns

\Zend_Navigation_Pagenullmatching page or null

Returns the value of the given property

get(string $property) : mixed
Inherited

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

$property

string

property name

Exceptions

\Zend_Navigation_Exception if property name is invalid

Returns

mixedthe property's value or null

Returns page access key

getAccesskey() : string | null
Inherited

Returns

stringnullpage access key or null

Returns action name to use when assembling URL

getAction() : string | null
see

Returns

stringnullaction name

Proxy to isActive()

getActive(boolean $recursive = false) : boolean
Inherited

Parameters

$recursive

boolean

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

Returns

booleanwhether page should be considered active

Returns the child container.

getChildren() : \Zend_Navigation_Page | null
Inherited

Implements RecursiveIterator interface.

Returns

\Zend_Navigation_Pagenull

Returns page class (CSS)

getClass() : string | null
Inherited

Returns

stringnullpage's CSS class or null

Returns controller name to use when assembling URL

getController() : string | null
see

Returns

stringnullcontroller name or null

Returns a single custom HTML attributes by name

getCustomHtmlAttrib(string $name) : string | null
Inherited

Parameters

$name

string

name of the HTML attribute

Exceptions

\Zend_Navigation_Exception if name is not string

Returns

stringnullvalue for the HTML attribute or null

Returns all custom HTML attributes as an array

getCustomHtmlAttribs() : array
Inherited

Returns

arrayan array containing custom HTML attributes

Returns custom properties as an array

getCustomProperties() : array
Inherited

Returns

arrayan array containing custom properties

getDefaultPageType()

getDefaultPageType() 
InheritedStatic

Returns an array containing the defined forward relations

getDefinedRel() : array
Inherited

Returns

arraydefined forward relations

Returns an array containing the defined reverse relations

getDefinedRev() : array
Inherited

Returns

arraydefined reverse relations

Returns whether herf should be encoded when assembling URL

getEncodeUrl() : boolean
see

Returns

booleanwhether herf should be encoded when assembling URL

Returns fragment identifier

getFragment() : string | null
Inherited

Returns

stringnullfragment identifier

Returns href for this page

getHref() : string

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

inherited_from \Zend_Navigation_Page::getHref()

Returns

stringpage href

Returns href for this page

getHref() : string
Inherited

Returns

stringthe page's href

Returns page id

getId() : string | null
Inherited

Returns

stringnullpage id or null

Returns page label

getLabel() : string
Inherited

Returns

stringpage label or null

Returns module name to use when assembling URL

getModule() : string | null
see

Returns

stringnullmodule name or null

Returns page order used in parent container

getOrder() : integer | null
Inherited

Returns

integernullpage order or null

Returns pages in the container

getPages() : array<mixed,\Zend_Navigation_Page>
Inherited

Returns

array<mixed,\Zend_Navigation_Page>array of Zend_Navigation_Page instances

Retrieve a single parameter (to use when assembling URL)

getParam(string $name) : mixed
see

Parameters

$name

string

parameter name

Returns

mixed

Retrieve all parameters (to use when assembling URL)

getParams() : array
see

Returns

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

Returns parent container

getParent() : \Zend_Navigation_Container | null
Inherited

Returns

\Zend_Navigation_Containernullparent container or null

Returns ACL privilege associated with this page

getPrivilege() : string | null
Inherited

Returns

stringnullACL privilege or null

Returns the page's forward links to other pages

getRel(string $relation = null) : array
Inherited

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

$relation

string

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

Returns

arrayan array of relations. If $relation is not specified, all relations will be returned in an associative array.

Returns whether params should be reset when assembling URL

getResetParams() : boolean
see

Returns

booleanwhether params should be reset when assembling URL

Returns ACL resource assoicated with this page

getResource() : string | \Zend_Acl_Resource_Interface | null
Inherited

Returns

string\Zend_Acl_Resource_InterfacenullACL resource or null

Returns the page's reverse links to other pages

getRev(string $relation = null) : array
Inherited

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

$relation

string

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

Returns

arrayan array of relations. If $relation is not specified, all relations will be returned in an associative array.

Returns route name to use when assembling URL

getRoute() : string
see

Returns

stringroute name

Returns scheme to use when assembling URL

getScheme() : string | null
see

Returns

stringnullscheme or null

Returns page target

getTarget() : string | null
Inherited

Returns

stringnullpage target or null

Returns page title

getTitle() : string | null
Inherited

Returns

stringnullpage title or null

Proxy to isVisible()

getVisible(boolean $recursive = false) : boolean
Inherited

Returns a boolean value indicating whether the page is visible

Parameters

$recursive

boolean

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

Returns

booleanwhether page should be considered visible

Proxy to hasPages()

hasChildren() : boolean
Inherited

Implements RecursiveIterator interface.

Returns

booleanwhether container has any pages

Checks if the container has the given page

hasPage(\Zend_Navigation_Page $page, boolean $recursive = false) : boolean
Inherited

Parameters

$page

\Zend_Navigation_Page

page to look for

$recursive

boolean

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

Returns

booleanwhether page is in container

Returns true if container contains any pages

hasPages() : boolean
Inherited

Returns

booleanwhether container has any pages

Returns a hash code value for the page

hashCode() : string
Inherited

Returns

stringa hash code value for this page

Returns whether page should be considered active or not

isActive(boolean $recursive = false) : boolean

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

inherited_from \Zend_Navigation_Page::isActive()

Parameters

$recursive

boolean

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

Returns

booleanwhether page should be considered active or not

Returns whether page should be considered active or not

isActive(boolean $recursive = false) : boolean
Inherited

Parameters

$recursive

boolean

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

Returns

booleanwhether page should be considered active

Returns a boolean value indicating whether the page is visible

isVisible(boolean $recursive = false) : boolean
Inherited

Parameters

$recursive

boolean

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

Returns

booleanwhether page should be considered visible

Returns hash code of current page

key() : string
Inherited

Implements RecursiveIterator interface.

Returns

stringhash code of current page

Moves index pointer to next page in the container

next() : void
Inherited

Implements RecursiveIterator interface.

Notifies container that the order of pages are updated

notifyOrderUpdated() : void
Inherited

Removes a custom HTML attribute from the page

removeCustomHtmlAttrib(string $name) : \Zend_Navigation_Page
Inherited

Parameters

$name

string

name of the custom HTML attribute

Returns

\Zend_Navigation_Pagefluent interface, returns self

Removes the given page from the container

removePage(\Zend_Navigation_Page|integer $page, boolean $recursive = false) : boolean
Inherited

Parameters

$page

\Zend_Navigation_Pageinteger

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

$recursive

boolean

[optional] whether to remove recursively

Returns

booleanwhether the removal was successful

Removes all pages in container

removePages() : \Zend_Navigation_Container
Inherited

Returns

\Zend_Navigation_Containerfluent interface, returns self

Remove parameter (to use when assembling URL)

removeParam(string $name) : boolean
see

Parameters

$name

string

Returns

boolean

Removes a forward relation from the page

removeRel(string $relation) : \Zend_Navigation_Page
Inherited

Parameters

$relation

string

name of relation to remove

Returns

\Zend_Navigation_Pagefluent interface, returns self

Removes a reverse relation from the page

removeRev(string $relation) : \Zend_Navigation_Page
Inherited

Parameters

$relation

string

name of relation to remove

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets index pointer to first page in the container

rewind() : void
Inherited

Implements RecursiveIterator interface.

Sets the given property

set(string $property, mixed $value) : \Zend_Navigation_Page
Inherited

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

$property

string

property name

$value

mixed

value to set

Exceptions

\Zend_Navigation_Exception if property name is invalid

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets access key for this page

setAccesskey(string|null $character = null) : \Zend_Navigation_Page
Inherited

Parameters

$character

stringnull

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

Exceptions

\Zend_Navigation_Exception if access key is not string or null or if the string length not equal to one

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets action name to use when assembling URL

setAction(string $action) : \Zend_Navigation_Page_Mvc
see

Parameters

$action

string

action name

Exceptions

\Zend_Navigation_Exception if invalid $action is given

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets whether page should be considered active or not

setActive(boolean $active = true) : \Zend_Navigation_Page
Inherited

Parameters

$active

boolean

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page CSS class

setClass(string|null $class = null) : \Zend_Navigation_Page
Inherited

Parameters

$class

stringnull

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

Exceptions

\Zend_Navigation_Exception if not given string or null

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page properties using a Zend_Config object

setConfig(\Zend_Config $config) : \Zend_Navigation_Page
Inherited

Parameters

$config

\Zend_Config

config object to get properties from

Exceptions

\Zend_Navigation_Exception if invalid options are given

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets controller name to use when assembling URL

setController(string|null $controller) : \Zend_Navigation_Page_Mvc
see

Parameters

$controller

stringnull

controller name

Exceptions

\Zend_Navigation_Exception if invalid controller name is given

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets a single custom HTML attribute

setCustomHtmlAttrib(string $name, string|null $value) : \Zend_Navigation_Page
Inherited

Parameters

$name

string

name of the HTML attribute

$value

stringnull

value for the HTML attribute

Exceptions

\Zend_Navigation_Exception if name is not string or value is not null or a string

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets multiple custom HTML attributes at once

setCustomHtmlAttribs(array $attribs) : \Zend_Navigation_Page
Inherited

Parameters

$attribs

array

an associative array of html attributes

Returns

\Zend_Navigation_Pagefluent interface, returns self

setDefaultPageType()

setDefaultPageType($type = null
InheritedStatic

Parameters

$type

Sets whether href should be encoded when assembling URL

setEncodeUrl($encodeUrl) : \Zend_Navigation_Page_Mvc
see

Parameters

$encodeUrl

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets a fragment identifier

setFragment(string $fragment) : \Zend_Navigation_Page
Inherited

Parameters

$fragment

string

new fragment identifier

Exceptions

\Zend_Navigation_Exception if empty/no string is given

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page id

setId(string|null $id = null) : \Zend_Navigation_Page
Inherited

Parameters

$id

stringnull

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

Exceptions

\Zend_Navigation_Exception if not given string or null

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page label

setLabel(string $label) : \Zend_Navigation_Page
Inherited

Parameters

$label

string

new page label

Exceptions

\Zend_Navigation_Exception if empty/no string is given

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets module name to use when assembling URL

setModule(string|null $module) : \Zend_Navigation_Page_Mvc
see

Parameters

$module

stringnull

module name

Exceptions

\Zend_Navigation_Exception if invalid module name is given

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets page properties using options from an associative array

setOptions(array $options) : \Zend_Navigation_Page
Inherited

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

$options

array

associative array of options to set

Exceptions

\Zend_Navigation_Exception if invalid options are given

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page order to use in parent container

setOrder(integer $order = null) : \Zend_Navigation_Page
Inherited

Parameters

$order

integer

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

Exceptions

\Zend_Navigation_Exception if order is not integer or null

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets pages this container should have, removing existing pages

setPages(array<mixed,\Zend_Navigation_Page> $pages) : \Zend_Navigation_Container
Inherited

Parameters

$pages

array<mixed,\Zend_Navigation_Page>

pages to set

Returns

\Zend_Navigation_Containerfluent interface, returns self

Set parameter (to use when assembling URL)

setParam(string $name, mixed $value) : \Zend_Navigation_Page_Mvc

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

see

Parameters

$name

string

parameter name

$value

mixed

parameter value

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

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

setParams(array|null $params = null) : \Zend_Navigation_Page_Mvc

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

see

Parameters

$params

arraynull

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

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets parent container

setParent(\Zend_Navigation_Container $parent = null) : \Zend_Navigation_Page
Inherited

Parameters

$parent

\Zend_Navigation_Container

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets ACL privilege associated with this page

setPrivilege(string|null $privilege = null) : \Zend_Navigation_Page
Inherited

Parameters

$privilege

stringnull

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets the page's forward links to other pages

setRel(array|\Zend_Config $relations = null) : \Zend_Navigation_Page
Inherited

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

$relations

array\Zend_Config

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets whether params should be reset when assembling URL

setResetParams(boolean $resetParams) : \Zend_Navigation_Page_Mvc
see

Parameters

$resetParams

boolean

whether params should be reset when assembling URL

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets ACL resource assoicated with this page

setResource(string|\Zend_Acl_Resource_Interface $resource = null) : \Zend_Navigation_Page
Inherited

Parameters

$resource

string\Zend_Acl_Resource_Interface

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

Exceptions

\Zend_Navigation_Exception if $resource if invalid

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets the page's reverse links to other pages

setRev(array|\Zend_Config $relations = null) : \Zend_Navigation_Page
Inherited

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

$relations

array\Zend_Config

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets route name to use when assembling URL

setRoute(string $route) : \Zend_Navigation_Page_Mvc
see

Parameters

$route

string

route name to use when assembling URL

Exceptions

\Zend_Navigation_Exception if invalid $route is given

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets scheme to use when assembling URL

setScheme(string|null $scheme) : \Zend_Navigation_Page_Mvc
see

Parameters

$scheme

stringnull

scheme

Exceptions

\Zend_Navigation_Exception

Returns

\Zend_Navigation_Page_Mvcfluent interface, returns self

Sets view helper for assembling URLs with schemes

setSchemeHelper(\Zend_View_Helper_ServerUrl $sh) : void
Static
see

Parameters

$sh

\Zend_View_Helper_ServerUrl

scheme helper

Sets page target

setTarget(string|null $target = null) : \Zend_Navigation_Page
Inherited

Parameters

$target

stringnull

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

Exceptions

\Zend_Navigation_Exception if target is not string or null

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets page title

setTitle(string $title = null) : \Zend_Navigation_Page
Inherited

Parameters

$title

string

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

Exceptions

\Zend_Navigation_Exception if not given string or null

Returns

\Zend_Navigation_Pagefluent interface, returns self

Sets action helper for assembling URLs

setUrlHelper(\Zend_Controller_Action_Helper_Url $uh) : void
Static
see

Parameters

$uh

\Zend_Controller_Action_Helper_Url

URL helper

Sets whether the page should be visible or not

setVisible(boolean $visible = true) : \Zend_Navigation_Page
Inherited

Parameters

$visible

boolean

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

Returns

\Zend_Navigation_Pagefluent interface, returns self

Returns an array representation of the page

toArray() : array
inherited_from \Zend_Navigation_Page::toArray()

Returns

arrayassociative array containing all page properties

Returns an array representation of all pages in container

toArray() : array<mixed,\Zend_Navigation_Page>
Inherited

Returns

array<mixed,\Zend_Navigation_Page>

Checks if container index is valid

valid() : boolean
Inherited

Implements RecursiveIterator interface.

Returns

boolean

Initializes page (used by subclasses)

_init() : void
Inherited

Normalizes a property name

_normalizePropertyName(string $property) : string
InheritedStatic

Parameters

$property

string

property name to normalize

Returns

stringnormalized property name

Sorts the page index according to page order

_sort() : void
Inherited

 Properties

 

Accessibility key character

$_accesskey : string | null

Default

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

link http://www.w3.org/TR/html401/interact/forms.html#access-keys
 

Action name to use when assembling URL

$_action : string

Default

 

Whether this page should be considered active

$_active : boolean

Default

null
inherited_from \Zend_Navigation_Page::_active
 

Whether this page should be considered active

$_active : boolean

Default

false
 

Style class for this page (CSS)

$_class : string | null

Default

 

Controller name to use when assembling URL

$_controller : string

Default

 

Custom HTML attributes

$_customHtmlAttribs : array

Default

array()
 

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

$_defaultPageType : string

Default

Static
 

Whether index is dirty and needs to be re-arranged

$_dirtyIndex : boolean

Default

false
 

Whether href should be encoded when assembling URL

$_encodeUrl : boolean

Default

true
see
 

Fragment identifier (anchor identifier)

$_fragment : string | null

Default

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)

link http://www.w3.org/TR/html401/intro/intro.html#fragment-uri
 

Cached href

$_hrefCache : string

Default

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.

 

Page id

$_id : string | null

Default

 

An index that contains the order in which to iterate pages

$_index : array

Default

array()
 

Page label

$_label : string | null

Default

 

Module name to use when assembling URL

$_module : string

Default

 

Page order used by parent container

$_order : integer | null

Default

 

Contains sub pages

$_pages : array<mixed,\Zend_Navigation_Page>

Default

array()
 

Params to use when assembling URL

$_params : array

Default

array()
see
 

Parent container

$_parent : \Zend_Navigation_Container | null

Default

 

ACL privilege associated with this page

$_privilege : string | null

Default

 

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

$_properties : array

Default

array()
 

Forward links to other pages

$_rel : array

Default

array()
 

Whether params should be reset when assembling URL

$_resetParams : boolean

Default

true
see
 

ACL resource associated with this page

$_resource : string | \Zend_Acl_Resource_Interface | null

Default

 

Reverse links to other pages

$_rev : array

Default

array()
 

Route name to use when assembling URL

$_route : string

Default

see
 

Scheme to use when assembling URL

$_scheme : string

Default

see
 

View helper for assembling URLs with schemes

$_schemeHelper : \Zend_View_Helper_ServerUrl

Default

null
Static
see
 

This page's target

$_target : string | null

Default

 

A more descriptive title for this page

$_title : string | null

Default

 

Action helper for assembling URLs

$_urlHelper : \Zend_Controller_Action_Helper_Url

Default

null
Static
see
 

Whether this page should be considered visible

$_visible : boolean

Default

true