API Documentation

Zend/Navigation/Page.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 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  
Version
$Id: Page.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Navigation_Page

Package: Zend\Navigation

Base class for Zend_Navigation_Page pages

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

Properties

Propertyprotectedstring|null  $_accesskey= ''

Accessibility key character

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

Details
Type
stringnull
Link
http://www.w3.org/TR/html401/interact/forms.html#access-keys  
Propertyprotectedbool  $_active= 'false'

Whether this page should be considered active

Default valuefalseDetails
Type
bool
Propertyprotectedstring|null  $_class= ''

Style class for this page (CSS)

Details
Type
stringnull
Propertyprotectedstring  $_defaultPageType= ''
static

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

Details
Type
string
Propertyprotectedstring|null  $_fragment= ''

Fragment identifier (anchor identifier)

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
stringnull
Link
http://www.w3.org/TR/html401/intro/intro.html#fragment-uri  
Propertyprotectedstring|null  $_id= ''

Page id

Details
Type
stringnull
Propertyprotectedstring|null  $_label= ''

Page label

Details
Type
stringnull
Propertyprotectedint|null  $_order= ''

Page order used by parent container

Details
Type
intnull
Propertyprotected\Zend_Navigation_Container|null  $_parent= ''

Parent container

Details
Type
\Zend_Navigation_Containernull
Propertyprotectedstring|null  $_privilege= ''

ACL privilege associated with this page

Details
Type
stringnull
Propertyprotectedarray  $_properties= 'array()'

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

Default valuearray()Details
Type
array
Propertyprotectedarray  $_rel= 'array()'

Forward links to other pages

Default valuearray()Details
Type
array
Link
http://www.w3.org/TR/html4/struct/links.html#h-12.3.1  
Propertyprotectedstring|\Zend_Acl_Resource_Interface|null  $_resource= ''

ACL resource associated with this page

Details
Type
string\Zend_Acl_Resource_Interfacenull
Propertyprotectedarray  $_rev= 'array()'

Reverse links to other pages

Default valuearray()Details
Type
array
Link
http://www.w3.org/TR/html4/struct/links.html#h-12.3.1  
Propertyprotectedstring|null  $_target= ''

This page's target

Details
Type
stringnull
Propertyprotectedstring|null  $_title= ''

A more descriptive title for this page

Details
Type
stringnull
Propertyprotectedbool  $_visible= 'true'

Whether this page should be considered visible

Default valuetrueDetails
Type
bool

Methods

methodpublic__construct( array|\Zend_Config $options = null ) : void

Page constructor

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

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

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

Checks if a property is set

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

Sets a custom property

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

Returns page label

Magic overload for enabling

echo $page

.

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

Unsets the given custom property

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

Initializes page (used by subclasses)

methodprotected_normalizePropertyName( string $property ) : string
static

Normalizes a property name

Parameters
Name Type Description
$property string

property name to normalize

Returns
Type Description
string normalized property name
methodpublicaddRel( string $relation, mixed $value ) : \Zend_Navigation_Page

Adds a forward relation to the page

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

Adds a reverse relation to the page

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
methodpublicfactory( array|\Zend_Config $options ) : \Zend_Navigation_Page
static

Factory for Zend_Navigation_Page classes

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
methodpublicget( string $property ) : mixed

Returns the value of the given property

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

Returns page access key

Returns
Type Description
string|null page access key or null
methodpublicgetActive( bool $recursive = false ) : bool

Proxy to isActive()

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
methodpublicgetClass( ) : string|null

Returns page class (CSS)

Returns
Type Description
string|null page's CSS class or null
methodpublicgetCustomProperties( ) : array

Returns custom properties as an array

Returns
Type Description
array an array containing custom properties
methodpublicgetDefaultPageType( ) : void
static

methodpublicgetDefinedRel( ) : array

Returns an array containing the defined forward relations

Returns
Type Description
array defined forward relations
methodpublicgetDefinedRev( ) : array

Returns an array containing the defined reverse relations

Returns
Type Description
array defined reverse relations
methodpublicgetFragment( ) : string|null

Returns fragment identifier

Returns
Type Description
string|null fragment identifier
methodpublicgetHref( ) : string
abstract

Returns href for this page

Returns
Type Description
string the page's href
methodpublicgetId( ) : string|null

Returns page id

Returns
Type Description
string|null page id or null
methodpublicgetLabel( ) : string

Returns page label

Returns
Type Description
string page label or null
methodpublicgetOrder( ) : int|null

Returns page order used in parent container

Returns
Type Description
int|null page order or null
methodpublicgetParent( ) : \Zend_Navigation_Container|null

Returns parent container

Returns
Type Description
\Zend_Navigation_Container|null parent container or null
methodpublicgetPrivilege( ) : string|null

Returns ACL privilege associated with this page

Returns
Type Description
string|null ACL privilege or null
methodpublicgetRel( string $relation = null ) : array

Returns the page's forward links to other pages

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.
methodpublicgetResource( ) : string|\Zend_Acl_Resource_Interface|null

Returns ACL resource assoicated with this page

Returns
Type Description
string|\Zend_Acl_Resource_Interface|null ACL resource or null
methodpublicgetRev( string $relation = null ) : array

Returns the page's reverse links to other pages

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.
methodpublicgetTarget( ) : string|null

Returns page target

Returns
Type Description
string|null page target or null
methodpublicgetTitle( ) : string|null

Returns page title

Returns
Type Description
string|null page title or null
methodpublicgetVisible( bool $recursive = false ) : bool

Proxy to isVisible()

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
methodpublichashCode( ) : string
final

Returns a hash code value for the page

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

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
methodpublicisVisible( bool $recursive = false ) : bool

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
methodpublicremoveRel( string $relation ) : \Zend_Navigation_Page

Removes a forward relation from the page

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

Removes a reverse relation from the page

Parameters
Name Type Description
$relation string

name of relation to remove

Returns
Type Description
\Zend_Navigation_Page fluent interface, returns self
methodpublicset( string $property, mixed $value ) : \Zend_Navigation_Page

Sets the given property

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

Sets access key for this page

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
methodpublicsetActive( bool $active = true ) : \Zend_Navigation_Page

Sets whether page should be considered active or not

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

Sets page CSS class

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

Sets page properties using a Zend_Config object

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
methodpublicsetDefaultPageType(  $type = null ) : void
static

Parameters
Name Type Description
$type
methodpublicsetFragment( string $fragment ) : \Zend_Navigation_Page

Sets a fragment identifier

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

Sets page id

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

Sets page label

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
methodpublicsetOptions( array $options ) : \Zend_Navigation_Page

Sets page properties using options from an associative array

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

Sets page order to use in parent container

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
methodpublicsetParent( \Zend_Navigation_Container $parent = null ) : \Zend_Navigation_Page

Sets parent container

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

Sets ACL privilege associated with this page

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

Sets the page's forward links to other pages

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
methodpublicsetResource( string|\Zend_Acl_Resource_Interface $resource = null ) : \Zend_Navigation_Page

Sets ACL resource assoicated with this page

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

Sets the page's reverse links to other pages

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
methodpublicsetTarget( string|null $target = null ) : \Zend_Navigation_Page

Sets page target

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

Sets page title

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
methodpublicsetVisible( bool $visible = true ) : \Zend_Navigation_Page

Sets whether the page should be visible or not

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
Documentation was generated by DocBlox 0.15.1.