Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Navigation_Page_Uri Class Reference

Public Member Functions

 setUri ($uri)
 Sets page URI.
 
 getUri ()
 Returns URI.
 
 getHref ()
 Returns href for this page.
 
 toArray ()
 Returns an array representation of the page.
 
- Public Member Functions inherited from Zend_Navigation_Page
 __construct ($options=null)
 Page constructor.
 
 setConfig (Zend_Config $config)
 Sets page properties using a Zend_Config object.
 
 setOptions (array $options)
 Sets page properties using options from an associative array.
 
 setLabel ($label)
 Sets page label.
 
 getLabel ()
 Returns page label.
 
 setFragment ($fragment)
 Sets a fragment identifier.
 
 getFragment ()
 Returns fragment identifier.
 
 setId ($id=null)
 Sets page id.
 
 getId ()
 Returns page id.
 
 setClass ($class=null)
 Sets page CSS class.
 
 getClass ()
 Returns page class (CSS)
 
 setTitle ($title=null)
 Sets page title.
 
 getTitle ()
 Returns page title.
 
 setTarget ($target=null)
 Sets page target.
 
 getTarget ()
 Returns page target.
 
 setAccesskey ($character=null)
 Sets access key for this page.
 
 getAccesskey ()
 Returns page access key.
 
 setRel ($relations=null)
 Sets the page's forward links to other pages.
 
 getRel ($relation=null)
 Returns the page's forward links to other pages.
 
 setRev ($relations=null)
 Sets the page's reverse links to other pages.
 
 getRev ($relation=null)
 Returns the page's reverse links to other pages.
 
 setCustomHtmlAttrib ($name, $value)
 Sets a single custom HTML attribute.
 
 getCustomHtmlAttrib ($name)
 Returns a single custom HTML attributes by name.
 
 setCustomHtmlAttribs (array $attribs)
 Sets multiple custom HTML attributes at once.
 
 getCustomHtmlAttribs ()
 Returns all custom HTML attributes as an array.
 
 removeCustomHtmlAttrib ($name)
 Removes a custom HTML attribute from the page.
 
 clearCustomHtmlAttribs ()
 Clear all custom HTML attributes.
 
 setOrder ($order=null)
 Sets page order to use in parent container.
 
 getOrder ()
 Returns page order used in parent container.
 
 setResource ($resource=null)
 Sets ACL resource assoicated with this page.
 
 getResource ()
 Returns ACL resource assoicated with this page.
 
 setPrivilege ($privilege=null)
 Sets ACL privilege associated with this page.
 
 getPrivilege ()
 Returns ACL privilege associated with this page.
 
 setActive ($active=true)
 Sets whether page should be considered active or not.
 
 isActive ($recursive=false)
 Returns whether page should be considered active or not.
 
 getActive ($recursive=false)
 Proxy to isActive()
 
 setVisible ($visible=true)
 Sets whether the page should be visible or not.
 
 isVisible ($recursive=false)
 Returns a boolean value indicating whether the page is visible.
 
 getVisible ($recursive=false)
 Proxy to isVisible()
 
 setParent (Zend_Navigation_Container $parent=null)
 Sets parent container.
 
 getParent ()
 Returns parent container.
 
 set ($property, $value)
 Sets the given property.
 
 get ($property)
 Returns the value of the given property.
 
 __set ($name, $value)
 Sets a custom property.
 
 __get ($name)
 Returns a property, or null if it doesn't exist.
 
 __isset ($name)
 Checks if a property is set.
 
 __unset ($name)
 Unsets the given custom property.
 
 __toString ()
 Returns page label.
 
 addRel ($relation, $value)
 Adds a forward relation to the page.
 
 addRev ($relation, $value)
 Adds a reverse relation to the page.
 
 removeRel ($relation)
 Removes a forward relation from the page.
 
 removeRev ($relation)
 Removes a reverse relation from the page.
 
 getDefinedRel ()
 Returns an array containing the defined forward relations.
 
 getDefinedRev ()
 Returns an array containing the defined reverse relations.
 
 getCustomProperties ()
 Returns custom properties as an array.
 
 hashCode ()
 Returns a hash code value for the page.
 
 toArray ()
 Returns an array representation of the page.
 
 getHref ()
 Returns href for this page.
 
- Public Member Functions inherited from Zend_Navigation_Container
 notifyOrderUpdated ()
 Notifies container that the order of pages are updated.
 
 addPage ($page)
 Adds a page to the container.
 
 addPages ($pages)
 Adds several pages at once.
 
 setPages (array $pages)
 Sets pages this container should have, removing existing pages.
 
 getPages ()
 Returns pages in the container.
 
 removePage ($page)
 Removes the given page from the container.
 
 removePages ()
 Removes all pages in container.
 
 hasPage (Zend_Navigation_Page $page, $recursive=false)
 Checks if the container has the given page.
 
 hasPages ()
 Returns true if container contains any pages.
 
 findOneBy ($property, $value, $useRegex=false)
 Returns a child page matching $property == $value or preg_match($value, $property), or null if not found.
 
 findAllBy ($property, $value, $useRegex=false)
 Returns all child pages matching $property == $value or preg_match($value, $property), or an empty array if no pages are found.
 
 findBy ($property, $value, $all=false, $useRegex=false)
 Returns page(s) matching $property == $value or preg_match($value, $property)
 
 __call ($method, $arguments)
 Magic overload: Proxy calls to finder methods.
 
 toArray ()
 Returns an array representation of all pages in container.
 
 current ()
 Returns current page.
 
 key ()
 Returns hash code of current page.
 
 next ()
 Moves index pointer to next page in the container.
 
 rewind ()
 Sets index pointer to first page in the container.
 
 valid ()
 Checks if container index is valid.
 
 hasChildren ()
 Proxy to hasPages()
 
 getChildren ()
 Returns the child container.
 
 count ()
 Returns number of pages in container.
 

Protected Attributes

 $_uri = null
 
- Protected Attributes inherited from Zend_Navigation_Page
 $_label
 
 $_fragment
 
 $_id
 
 $_class
 
 $_title
 
 $_target
 
 $_accesskey
 
 $_rel = array()
 
 $_rev = array()
 
 $_order
 
 $_resource
 
 $_privilege
 
 $_active = false
 
 $_visible = true
 
 $_parent
 
 $_properties = array()
 
 $_customHtmlAttribs = array()
 
- Protected Attributes inherited from Zend_Navigation_Container
 $_pages = array()
 
 $_index = array()
 
 $_dirtyIndex = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Navigation_Page
static factory ($options)
 Factory for Zend_Navigation_Page classes.
 
static setDefaultPageType ($type=null)
 
static getDefaultPageType ()
 
- Protected Member Functions inherited from Zend_Navigation_Page
 _init ()
 Initializes page (used by subclasses)
 
- Static Protected Member Functions inherited from Zend_Navigation_Page
static _normalizePropertyName ($property)
 Normalizes a property name.
 
- Static Protected Attributes inherited from Zend_Navigation_Page
static $_defaultPageType
 

Member Function Documentation

getHref ( )

Returns href for this page.

Returns
string
getUri ( )

Returns URI.

Returns
string
setUri (   $uri)

Sets page URI.

Parameters
string$uripage URI, must a string or null
Returns
Zend_Navigation_Page_Uri fluent interface, returns self
Exceptions
Zend_Navigation_Exceptionif $uri is invalid
toArray ( )

Returns an array representation of the page.

Returns
array

Member Data Documentation

$_uri = null
protected