Navigation/Page.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Navigation
version: $Id: Page.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Navigation_Page

Description

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.

Zend_Navigation_Page
jump to top

Extends from: Zend_Navigation_Container
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Navigation
Properties: $_label; $_id; $_class; $_title; $_target; $_rel; $_rev; $_order; $_resource; $_privilege; $_active; $_visible; $_parent; $_properties
Methods: factory; __construct; _init; setConfig; setOptions; setLabel; getLabel; setId; getId; setClass; getClass; setTitle; getTitle; setTarget; getTarget; setRel; getRel; setRev; getRev; setOrder; getOrder; setResource; getResource; setPrivilege; getPrivilege; setActive; isActive; getActive; setVisible; isVisible; getVisible; setParent; getParent; set; get; __set; __get; __isset; __unset; __toString; addRel; addRev; removeRel; removeRev; getDefinedRel; getDefinedRev; getCustomProperties; hashCode; toArray; _normalizePropertyName; getHref

Description

Base class for Zend_Navigation_Page pages

Properties

$_active
jump to class

bool $_active = 'false'

Whether this page should be considered active

Details

$_active: bool
visibility: protected
default: false
final: false
static: false

$_class
jump to class

string|null $_class = ''

Style class for this page (CSS)

Details

$_class: string|null
visibility: protected
default
final: false
static: false

$_id
jump to class

string|null $_id = ''

Page id

Details

$_id: string|null
visibility: protected
default
final: false
static: false

$_label
jump to class

string|null $_label = ''

Page label

Details

$_label: string|null
visibility: protected
default
final: false
static: false

$_order
jump to class

int|null $_order = ''

Page order used by parent container

Details

$_order: int|null
visibility: protected
default
final: false
static: false

$_parent
jump to class

Zend_Navigation_Container|null $_parent = ''

Parent container

Details

$_parent: Zend_Navigation_Container|null
visibility: protected
default
final: false
static: false

$_privilege
jump to class

string|null $_privilege = ''

ACL privilege associated with this page

Details

$_privilege: string|null
visibility: protected
default
final: false
static: false

$_properties
jump to class

array $_properties = 'array'

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

Details

$_properties: array
visibility: protected
default: array
final: false
static: false

$_rel
jump to class

array $_rel = 'array'

Forward links to other pages

Details

$_rel: array
visibility: protected
default: array
final: false
static: false
link: http://www.w3.org/TR/html4/struct/links.html#h-12.3.1

$_resource
jump to class

string|Zend_Acl_Resource_Interface|null $_resource = ''

ACL resource associated with this page

Details

$_resource: string|Zend_Acl_Resource_Interface|null
visibility: protected
default
final: false
static: false

$_rev
jump to class

array $_rev = 'array'

Reverse links to other pages

Details

$_rev: array
visibility: protected
default: array
final: false
static: false
link: http://www.w3.org/TR/html4/struct/links.html#h-12.3.1

$_target
jump to class

string|null $_target = ''

This page's target

Details

$_target: string|null
visibility: protected
default
final: false
static: false

$_title
jump to class

string|null $_title = ''

A more descriptive title for this page

Details

$_title: string|null
visibility: protected
default
final: false
static: false

$_visible
jump to class

bool $_visible = 'true'

Whether this page should be considered visible

Details

$_visible: bool
visibility: protected
default: true
final: false
static: false

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :

Page constructor

Arguments

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

Details

visibility: public
final: false
static: false
throws: if invalid options are given

__get
jump to class

__get(
          string $name
          )
        
        :
        mixed

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

Magic overload for enabling $page->propname.

Arguments

$name: string
property name

Output

mixed: property value or null

Details

visibility: public
final: false
static: false
throws: if property name is invalid

__isset
jump to class

__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).

Arguments

$name: string
property name

Output

bool: whether the given property exists

Details

visibility: public
final: false
static: false

__set
jump to class

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

Sets a custom property

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

Arguments

$name: string
property name
$value: mixed
value to set

Details

visibility: public
final: false
static: false
throws: if property name is invalid

__toString
jump to class

__toString(
          
          )
        
        :
        string

Returns page label

Magic overload for enabling echo $page.

Output

string: page label

Details

visibility: public
final: false
static: false

__unset
jump to class

__unset(
          string $name
          )
        
        :
        void

Unsets the given custom property

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

Arguments

$name: string
property name

Details

visibility: public
final: false
static: false
throws: if the property is native

_init
jump to class

Initializes page (used by subclasses)

Details

visibility: protected
final: false
static: false

_normalizePropertyName
jump to class

_normalizePropertyName(
          string $property
          )
        
        :
        string

Normalizes a property name

Arguments

$property: string
property name to normalize

Output

string: normalized property name

Details

visibility: protected
final: false
static: true

addRel
jump to class

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

Adds a forward relation to the page

Arguments

$relation: string
relation name (e.g. alternate, glossary, canonical, etc)
$value: mixed
value to set for relation

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

addRev
jump to class

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

Adds a reverse relation to the page

Arguments

$relation: string
relation name (e.g. alternate, glossary, canonical, etc)
$value: mixed
value to set for relation

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

factory
jump to class

factory(
          array|Zend_Config $options
          )
        
        :
        Zend_Navigation_Page

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.

Arguments

$options: arrayZend_Config
options used for creating page

Output

Zend_Navigation_Page: a page instance

Details

visibility: public
final: false
static: true
throws: if $options is not array/Zend_Config
throws: if 'type' is specified and Zend_Loader is unable to load the class
throws: if something goes wrong during instantiation of the page
throws: if 'type' is given, and the specified type does not extend this class
throws: if unable to determine which class to instantiate

get
jump to class

get(
          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.

Arguments

$property: string
property name

Output

mixed: the property's value or null

Details

visibility: public
final: false
static: false
throws: if property name is invalid

getActive
jump to class

getActive(
          bool $recursive
              =
              false
          )
        
        :
        bool

Proxy to isActive()

Arguments

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

Output

bool: whether page should be considered active

Details

visibility: public
final: false
static: false

getClass
jump to class

getClass(
          
          )
        
        :
        string|null

Returns page class (CSS)

Output

string|null: page's CSS class or null

Details

visibility: public
final: false
static: false

getCustomProperties
jump to class

getCustomProperties(
          
          )
        
        :
        array

Returns custom properties as an array

Output

array: an array containing custom properties

Details

visibility: public
final: false
static: false

getDefinedRel
jump to class

getDefinedRel(
          
          )
        
        :
        array

Returns an array containing the defined forward relations

Output

array: defined forward relations

Details

visibility: public
final: false
static: false

getDefinedRev
jump to class

getDefinedRev(
          
          )
        
        :
        array

Returns an array containing the defined reverse relations

Output

array: defined reverse relations

Details

visibility: public
final: false
static: false

getHref
jump to class

getHref(
          
          )
        
        :
        string

Returns href for this page

Output

string: the page's href

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        string|null

Returns page id

Output

string|null: page id or null

Details

visibility: public
final: false
static: false

getLabel
jump to class

getLabel(
          
          )
        
        :
        string

Returns page label

Output

string: page label or null

Details

visibility: public
final: false
static: false

getOrder
jump to class

getOrder(
          
          )
        
        :
        int|null

Returns page order used in parent container

Output

int|null: page order or null

Details

visibility: public
final: false
static: false

getParent
jump to class

getParent(
          
          )
        
        :
        Zend_Navigation_Container|null

Returns parent container

Output

Zend_Navigation_Container|null: parent container or null

Details

visibility: public
final: false
static: false

getPrivilege
jump to class

getPrivilege(
          
          )
        
        :
        string|null

Returns ACL privilege associated with this page

Output

string|null: ACL privilege or null

Details

visibility: public
final: false
static: false

getRel
jump to class

getRel(
          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.

Arguments

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

Output

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

Details

visibility: public
final: false
static: false

getResource
jump to class

getResource(
          
          )
        
        :
        string|Zend_Acl_Resource_Interface|null

Returns ACL resource assoicated with this page

Output

string|Zend_Acl_Resource_Interface|null: ACL resource or null

Details

visibility: public
final: false
static: false

getRev
jump to class

getRev(
          string $relation
              =
              null
          )
        
        :
        array

Returns the page's reverse links to other pages

Arguments

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

Output

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

Details

visibility: public
final: false
static: false

getTarget
jump to class

getTarget(
          
          )
        
        :
        string|null

Returns page target

Output

string|null: page target or null

Details

visibility: public
final: false
static: false

getTitle
jump to class

getTitle(
          
          )
        
        :
        string|null

Returns page title

Output

string|null: page title or null

Details

visibility: public
final: false
static: false

getVisible
jump to class

getVisible(
          bool $recursive
              =
              false
          )
        
        :
        bool

Proxy to isVisible()

Returns a boolean value indicating whether the page is visible

Arguments

$recursive: bool
[optional] whether page should be considered invisible if parent is invisible. Default is false.

Output

bool: whether page should be considered visible

Details

visibility: public
final: false
static: false

hashCode
jump to class

hashCode(
          
          )
        
        :
        string

Returns a hash code value for the page

Output

string: a hash code value for this page

Details

visibility: public
final: true
static: false

isActive
jump to class

isActive(
          bool $recursive
              =
              false
          )
        
        :
        bool

Returns whether page should be considered active or not

Arguments

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

Output

bool: whether page should be considered active

Details

visibility: public
final: false
static: false

isVisible
jump to class

isVisible(
          bool $recursive
              =
              false
          )
        
        :
        bool

Returns a boolean value indicating whether the page is visible

Arguments

$recursive: bool
[optional] whether page should be considered invisible if parent is invisible. Default is false.

Output

bool: whether page should be considered visible

Details

visibility: public
final: false
static: false

removeRel
jump to class

removeRel(
          string $relation
          )
        
        :
        Zend_Navigation_Page

Removes a forward relation from the page

Arguments

$relation: string
name of relation to remove

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

removeRev
jump to class

removeRev(
          string $relation
          )
        
        :
        Zend_Navigation_Page

Removes a reverse relation from the page

Arguments

$relation: string
name of relation to remove

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

set
jump to class

set(
          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.

Arguments

$property: string
property name
$value: mixed
value to set

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if property name is invalid

setActive
jump to class

setActive(
          bool $active
              =
              true
          )
        
        :
        Zend_Navigation_Page

Sets whether page should be considered active or not

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

setClass
jump to class

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

Sets page CSS class

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if not given string or null

setConfig
jump to class

setConfig(
          Zend_Config $config
          )
        
        :
        Zend_Navigation_Page

Sets page properties using a Zend_Config object

Arguments

$config: Zend_Config
config object to get properties from

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if invalid options are given

setId
jump to class

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

Sets page id

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if not given string or null

setLabel
jump to class

setLabel(
          string $label
          )
        
        :
        Zend_Navigation_Page

Sets page label

Arguments

$label: string
new page label

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if empty/no string is given

setOptions
jump to class

setOptions(
          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().

Arguments

$options: array
associative array of options to set

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if invalid options are given

setOrder
jump to class

setOrder(
          int $order
              =
              null
          )
        
        :
        Zend_Navigation_Page

Sets page order to use in parent container

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if order is not integer or null

setParent
jump to class

setParent(
          Zend_Navigation_Container $parent
              =
              null
          )
        
        :
        Zend_Navigation_Page

Sets parent container

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

setPrivilege
jump to class

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

Sets ACL privilege associated with this page

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

setRel
jump to class

setRel(
          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.

Arguments

$relations: arrayZend_Config
[optional] an associative array of forward links to other pages

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

setResource
jump to class

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

Sets ACL resource assoicated with this page

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if $resource if invalid

setRev
jump to class

setRev(
          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.

Arguments

$relations: arrayZend_Config
[optional] an associative array of reverse links to other pages

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

setTarget
jump to class

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

Sets page target

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if target is not string or null

setTitle
jump to class

setTitle(
          string $title
              =
              null
          )
        
        :
        Zend_Navigation_Page

Sets page title

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if not given string or null

setVisible
jump to class

setVisible(
          bool $visible
              =
              true
          )
        
        :
        Zend_Navigation_Page

Sets whether the page should be visible or not

Arguments

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

Output

Zend_Navigation_Page: fluent interface, returns self

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Returns an array representation of the page

Output

array: associative array containing all page properties

Details

visibility: public
final: false
static: false

API Documentation

Navigation/Page.php

Description

Zend_Navigation_Pagejump to top

Description

Properties

$_activejump to class

Details

$_classjump to class

Details

$_idjump to class

Details

$_labeljump to class

Details

$_orderjump to class

Details

$_parentjump to class

Details

$_privilegejump to class

Details

$_propertiesjump to class

Details

$_reljump to class

Details

$_resourcejump to class

Details

$_revjump to class

Details

$_targetjump to class

Details

$_titlejump to class

Details

$_visiblejump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__toStringjump to class

Output

Details

__unsetjump to class

Arguments

Details

_initjump to class

Details

_normalizePropertyNamejump to class

Arguments

Output

Details

addReljump to class

Arguments

Output

Details

addRevjump to class

Arguments

Output

Details

factoryjump to class

Arguments

Output

Details

getjump to class

Arguments

Output

Details

getActivejump to class

Arguments

Output

Zend_Navigation_Page
jump to top

$_active
jump to class

$_class
jump to class

$_id
jump to class

$_label
jump to class

$_order
jump to class

$_parent
jump to class

$_privilege
jump to class

$_properties
jump to class

$_rel
jump to class

$_resource
jump to class

$_rev
jump to class

$_target
jump to class

$_title
jump to class

$_visible
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__toString
jump to class

__unset
jump to class

_init
jump to class

_normalizePropertyName
jump to class

addRel
jump to class

addRev
jump to class

factory
jump to class

get
jump to class

getActive
jump to class

getClass
jump to class

getCustomProperties
jump to class

getDefinedRel
jump to class

getDefinedRev
jump to class

getHref
jump to class

getId
jump to class

getLabel
jump to class

getOrder
jump to class

getParent
jump to class

getPrivilege
jump to class

getRel
jump to class

getResource
jump to class

getRev
jump to class

getTarget
jump to class

getTitle
jump to class

getVisible
jump to class

hashCode
jump to class

isActive
jump to class

isVisible
jump to class

removeRel
jump to class

removeRev
jump to class