Navigation/Page/Uri.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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: Uri.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Navigation_Page_Uri

Package: Zend\Navigation\Page
Represents a page that is defined by specifying a URI

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

>VPropertyprotectedstring|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  
>VPropertyprotectedbool $_active = false
inherited
Whether this page should be considered active
Inherited from: \Zend_Navigation_Page::$$_active
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Navigation_Page::$$_active  
>VPropertyprotectedstring|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  
>VPropertyprotectedarray $_customHtmlAttribs = array()
inherited
Custom HTML attributes
Inherited from: \Zend_Navigation_Page::$$_customHtmlAttribs
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Page::$$_customHtmlAttribs  
>VPropertyprotectedstring $_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  
>VPropertyprotectedbool $_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  
>VPropertyprotectedstring|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  
>VPropertyprotectedstring|null $_id
inherited
Page id
Inherited from: \Zend_Navigation_Page::$$_id
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_id  
>VPropertyprotectedarray $_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  
>VPropertyprotectedstring|null $_label
inherited
Page label
Inherited from: \Zend_Navigation_Page::$$_label
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_label  
>VPropertyprotectedint|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  
>VPropertyprotectedarray $_pages = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Navigation_Container::$$_pages  
Inherited_from
\Zend_Navigation_Page::$$_pages  
>VPropertyprotected\Zend_Navigation_Container|null $_parent
inherited
Parent container
Inherited from: \Zend_Navigation_Page::$$_parent
>VPropertyprotectedstring|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  
>VPropertyprotectedarray $_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  
>VPropertyprotectedarray $_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  
>VPropertyprotectedstring|\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  
>VPropertyprotectedarray $_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  
>VPropertyprotectedstring|null $_target
inherited
This page's target
Inherited from: \Zend_Navigation_Page::$$_target
Details
Type
string | null
Inherited_from
\Zend_Navigation_Page::$$_target  
>VPropertyprotectedstring|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  
>VPropertyprotectedstring|null $_uri = null
Page URI
Default valuenullDetails
Type
string | null
>VPropertyprotectedbool $_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
NameTypeDescription
$methodstring

method name

$argumentsarray

method arguments

Returns
TypeDescription
mixedZend_Navigation|array|null matching page, array of pages or null
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif method does not exist
methodpublic__construct(array | \Zend_Config $options = null) : void
inherited

Page constructor

Inherited from: \Zend_Navigation_Page::__construct()
Parameters
NameTypeDescription
$optionsarray | \Zend_Config

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

Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$namestring

property name

Returns
TypeDescription
mixedproperty value or null
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$namestring

property name

Returns
TypeDescription
boolwhether 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
NameTypeDescription
$namestring

property name

$valuemixed

value to set

Throws
ExceptionDescription
\Zend_Navigation_Exceptionif property name is invalid
methodpublic__toString() : string
inherited

Returns page label

Inherited from: \Zend_Navigation_Page::__toString()

Magic overload for enabling

echo $page

.

Returns
TypeDescription
stringpage 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
NameTypeDescription
$namestring

property name

Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$propertystring

property name to normalize

Returns
TypeDescription
stringnormalized 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
NameTypeDescription
$page\Zend_Navigation_Page | array | \Zend_Config

page to add

Returns
TypeDescription
\Zend_Navigation_Containerfluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$pagesarray | \Zend_Config | \Zend_Navigation_Container

pages to add

Returns
TypeDescription
\Zend_Navigation_Containerfluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif $pages is not array, Zend_Config or Zend_Navigation_Container
methodpublicaddRel(string $relation, mixed $value) : \Zend_Navigation_Page
inherited

Adds a forward relation to the page

Inherited from: \Zend_Navigation_Page::addRel()
Parameters
NameTypeDescription
$relationstring

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

$valuemixed

value to set for relation

Returns
TypeDescription
\Zend_Navigation_Pagefluent 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
NameTypeDescription
$relationstring

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

$valuemixed

value to set for relation

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublicclearCustomHtmlAttribs() : \Zend_Navigation_Page
inherited

Clear all custom HTML attributes

Inherited from: \Zend_Navigation_Page::clearCustomHtmlAttribs()
Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpubliccount() : int
inherited

Returns number of pages in container

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

Implements Countable interface.

Returns
TypeDescription
intnumber of pages in the container
methodpubliccurrent() : \Zend_Navigation_Page

Implements RecursiveIterator interface.

Returns
TypeDescription
\Zend_Navigation_Pagecurrent page or null
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$optionsarray | \Zend_Config

options used for creating page

Returns
TypeDescription
\Zend_Navigation_Pagea page instance
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif $options is not array/Zend_Config
\Zend_Exceptionif 'type' is specified and Zend_Loader is unable to load the class
\Zend_Navigation_Exceptionif something goes wrong during instantiation of the page
\Zend_Navigation_Exceptionif 'type' is given, and the specified type does not extend this class
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$propertystring

name of property to match against

$valuemixed

value to match property against

$useRegexbool

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

Returns
TypeDescription
arrayarray 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
NameTypeDescription
$propertystring

name of property to match against

$valuemixed

value to match property against

$allbool

[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.

$useRegexbool

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

Returns
TypeDescription
\Zend_Navigation_Page | nullmatching 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
NameTypeDescription
$propertystring

name of property to match against

$valuemixed

value to match property against

$useRegexbool

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

Returns
TypeDescription
\Zend_Navigation_Page | nullmatching 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
NameTypeDescription
$propertystring

property name

Returns
TypeDescription
mixedthe property's value or null
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif property name is invalid
methodpublicgetAccesskey() : string | null
inherited

Returns page access key

Inherited from: \Zend_Navigation_Page::getAccesskey()
Returns
TypeDescription
string | nullpage access key or null
methodpublicgetActive(bool $recursive = false) : bool
inherited

Proxy to isActive()

Inherited from: \Zend_Navigation_Page::getActive()
Parameters
NameTypeDescription
$recursivebool

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

Returns
TypeDescription
boolwhether 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
TypeDescription
\Zend_Navigation_Page | null
methodpublicgetClass() : string | null
inherited

Returns page class (CSS)

Inherited from: \Zend_Navigation_Page::getClass()
Returns
TypeDescription
string | nullpage's CSS class or null
methodpublicgetCustomHtmlAttrib(string $name) : string | null
inherited

Returns a single custom HTML attributes by name

Inherited from: \Zend_Navigation_Page::getCustomHtmlAttrib()
Parameters
NameTypeDescription
$namestring

name of the HTML attribute

Returns
TypeDescription
string | nullvalue for the HTML attribute or null
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif name is not string
methodpublicgetCustomHtmlAttribs() : array
inherited

Returns all custom HTML attributes as an array

Inherited from: \Zend_Navigation_Page::getCustomHtmlAttribs()
Returns
TypeDescription
arrayan array containing custom HTML attributes
methodpublicgetCustomProperties() : array
inherited

Returns custom properties as an array

Inherited from: \Zend_Navigation_Page::getCustomProperties()
Returns
TypeDescription
arrayan 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
TypeDescription
arraydefined forward relations
methodpublicgetDefinedRev() : array
inherited

Returns an array containing the defined reverse relations

Inherited from: \Zend_Navigation_Page::getDefinedRev()
Returns
TypeDescription
arraydefined reverse relations
methodpublicgetFragment() : string | null
inherited

Returns fragment identifier

Inherited from: \Zend_Navigation_Page::getFragment()
Returns
TypeDescription
string | nullfragment identifier
methodpublicgetHref() : string

Returns href for this page

Returns
TypeDescription
string
methodpublicgetId() : string | null
inherited

Returns page id

Inherited from: \Zend_Navigation_Page::getId()
Returns
TypeDescription
string | nullpage id or null
methodpublicgetLabel() : string
inherited

Returns page label

Inherited from: \Zend_Navigation_Page::getLabel()
Returns
TypeDescription
stringpage label or null
methodpublicgetOrder() : int | null
inherited

Returns page order used in parent container

Inherited from: \Zend_Navigation_Page::getOrder()
Returns
TypeDescription
int | nullpage order or null
methodpublicgetPages() : array
inherited

Returns pages in the container

Inherited from: \Zend_Navigation_Container::getPages()\Zend_Navigation_Page::getPages()
Returns
TypeDescription
arrayarray of Zend_Navigation_Page instances
methodpublicgetParent() : \Zend_Navigation_Container | null
inherited

Returns parent container

Inherited from: \Zend_Navigation_Page::getParent()
Returns
TypeDescription
\Zend_Navigation_Container | nullparent container or null
methodpublicgetPrivilege() : string | null
inherited

Returns ACL privilege associated with this page

Inherited from: \Zend_Navigation_Page::getPrivilege()
Returns
TypeDescription
string | nullACL 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
NameTypeDescription
$relationstring

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

Returns
TypeDescription
arrayan array of relations. If $relation is not specified, all relations will be returned in an associative array.
methodpublicgetResource() : string | \Zend_Acl_Resource_Interface | null
inherited

Returns ACL resource assoicated with this page

Inherited from: \Zend_Navigation_Page::getResource()
Returns
TypeDescription
string | \Zend_Acl_Resource_Interface | nullACL 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
NameTypeDescription
$relationstring

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

Returns
TypeDescription
arrayan array of relations. If $relation is not specified, all relations will be returned in an associative array.
methodpublicgetTarget() : string | null
inherited

Returns page target

Inherited from: \Zend_Navigation_Page::getTarget()
Returns
TypeDescription
string | nullpage target or null
methodpublicgetTitle() : string | null
inherited

Returns page title

Inherited from: \Zend_Navigation_Page::getTitle()
Returns
TypeDescription
string | nullpage title or null
methodpublicgetUri() : string

Returns URI

Returns
TypeDescription
string
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
NameTypeDescription
$recursivebool

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

Returns
TypeDescription
boolwhether page should be considered visible
methodpublichasChildren() : bool

Implements RecursiveIterator interface.

Returns
TypeDescription
boolwhether 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
NameTypeDescription
$page\Zend_Navigation_Page

page to look for

$recursivebool

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

Returns
TypeDescription
boolwhether 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
TypeDescription
boolwhether container has any pages
methodpublichashCode() : string
finalinherited

Returns a hash code value for the page

Inherited from: \Zend_Navigation_Page::hashCode()
Returns
TypeDescription
stringa hash code value for this page
methodpublicisActive(bool $recursive = false) : bool
inherited

Returns whether page should be considered active or not

Inherited from: \Zend_Navigation_Page::isActive()
Parameters
NameTypeDescription
$recursivebool

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

Returns
TypeDescription
boolwhether page should be considered active
methodpublicisVisible(bool $recursive = false) : bool
inherited

Returns a boolean value indicating whether the page is visible

Inherited from: \Zend_Navigation_Page::isVisible()
Parameters
NameTypeDescription
$recursivebool

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

Returns
TypeDescription
boolwhether 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
TypeDescription
stringhash 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
NameTypeDescription
$namestring

name of the custom HTML attribute

Returns
TypeDescription
\Zend_Navigation_Pagefluent 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
NameTypeDescription
$page\Zend_Navigation_Page | int

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

Returns
TypeDescription
boolwhether 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
TypeDescription
\Zend_Navigation_Containerfluent interface, returns self
methodpublicremoveRel(string $relation) : \Zend_Navigation_Page
inherited

Removes a forward relation from the page

Inherited from: \Zend_Navigation_Page::removeRel()
Parameters
NameTypeDescription
$relationstring

name of relation to remove

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublicremoveRev(string $relation) : \Zend_Navigation_Page
inherited

Removes a reverse relation from the page

Inherited from: \Zend_Navigation_Page::removeRev()
Parameters
NameTypeDescription
$relationstring

name of relation to remove

Returns
TypeDescription
\Zend_Navigation_Pagefluent 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
NameTypeDescription
$propertystring

property name

$valuemixed

value to set

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$characterstring | null

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif access key is not string or null or if the string length not equal to one
methodpublicsetActive(bool $active = true) : \Zend_Navigation_Page
inherited

Sets whether page should be considered active or not

Inherited from: \Zend_Navigation_Page::setActive()
Parameters
NameTypeDescription
$activebool

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublicsetClass(string | null $class = null) : \Zend_Navigation_Page
inherited

Sets page CSS class

Inherited from: \Zend_Navigation_Page::setClass()
Parameters
NameTypeDescription
$classstring | null

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$config\Zend_Config

config object to get properties from

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif invalid options are given
methodpublicsetCustomHtmlAttrib(string $name, string | null $value) : \Zend_Navigation_Page
inherited

Sets a single custom HTML attribute

Inherited from: \Zend_Navigation_Page::setCustomHtmlAttrib()
Parameters
NameTypeDescription
$namestring

name of the HTML attribute

$valuestring | null

value for the HTML attribute

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$attribsarray

an associative array of html attributes

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublicsetDefaultPageType( $type = null) : void
staticinherited

Inherited from: \Zend_Navigation_Page::setDefaultPageType()
Parameters
NameTypeDescription
$type
methodpublicsetFragment(string $fragment) : \Zend_Navigation_Page
inherited

Sets a fragment identifier

Inherited from: \Zend_Navigation_Page::setFragment()
Parameters
NameTypeDescription
$fragmentstring

new fragment identifier

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif empty/no string is given
methodpublicsetId(string | null $id = null) : \Zend_Navigation_Page
inherited

Sets page id

Inherited from: \Zend_Navigation_Page::setId()
Parameters
NameTypeDescription
$idstring | null

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif not given string or null
methodpublicsetLabel(string $label) : \Zend_Navigation_Page
inherited

Sets page label

Inherited from: \Zend_Navigation_Page::setLabel()
Parameters
NameTypeDescription
$labelstring

new page label

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif empty/no string is given
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
NameTypeDescription
$optionsarray

associative array of options to set

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$orderint

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif 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
NameTypeDescription
$pagesarray

pages to set

Returns
TypeDescription
\Zend_Navigation_Containerfluent interface, returns self
methodpublicsetParent(\Zend_Navigation_Container $parent = null) : \Zend_Navigation_Page
inherited

Sets parent container

Inherited from: \Zend_Navigation_Page::setParent()
Parameters
NameTypeDescription
$parent\Zend_Navigation_Container

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent 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
NameTypeDescription
$privilegestring | null

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent 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
NameTypeDescription
$relationsarray | \Zend_Config

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
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
NameTypeDescription
$resourcestring | \Zend_Acl_Resource_Interface

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif $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
NameTypeDescription
$relationsarray | \Zend_Config

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublicsetTarget(string | null $target = null) : \Zend_Navigation_Page
inherited

Sets page target

Inherited from: \Zend_Navigation_Page::setTarget()
Parameters
NameTypeDescription
$targetstring | null

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif target is not string or null
methodpublicsetTitle(string $title = null) : \Zend_Navigation_Page
inherited

Sets page title

Inherited from: \Zend_Navigation_Page::setTitle()
Parameters
NameTypeDescription
$titlestring

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif not given string or null
methodpublicsetUri(string $uri) : \Zend_Navigation_Page_Uri

Sets page URI

Parameters
NameTypeDescription
$uristring

page URI, must a string or null

Returns
TypeDescription
\Zend_Navigation_Page_Urifluent interface, returns self
Throws
ExceptionDescription
\Zend_Navigation_Exceptionif $uri is invalid
methodpublicsetVisible(bool $visible = true) : \Zend_Navigation_Page
inherited

Sets whether the page should be visible or not

Inherited from: \Zend_Navigation_Page::setVisible()
Parameters
NameTypeDescription
$visiblebool

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

Returns
TypeDescription
\Zend_Navigation_Pagefluent interface, returns self
methodpublictoArray() : array

Returns an array representation of the page

Returns
TypeDescription
array
methodpublicvalid() : bool
inherited

Checks if container index is valid

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

Implements RecursiveIterator interface.

Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.