Docs For Class Zend_View_Helper_Navigation

Interface Zend_View_Helper_Navigation_Helper

Description

Interface for navigational helpers

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /View/Helper/Navigation/Helper.php (line 32)

Method Summary

Zend_Acl|null getAcl ()

Zend_Navigation_Container getContainer ()

bool getRenderInvisible ()

string|Zend_Acl_Role_Interface|null getRole ()

Zend_Translate_Adapter|null getTranslator ()

bool getUseAcl ()

bool getUseTranslator ()

bool hasAcl ()

bool hasContainer ()

bool hasRole ()

bool hasTranslator ()

string render ([ $container = null])

Zend_View_Helper_Navigation_Helper setAcl ([ $acl = null])

Zend_View_Helper_Navigation_Helper setContainer ([ $container = null])

Zend_View_Helper_Navigation_HelperAbstract setRenderInvisible ([bool $renderInvisible = true])

Zend_View_Helper_Navigation_Helper setRole ([mixed $role = null])

Zend_View_Helper_Navigation_Helper setTranslator ([mixed $translator = null])

Zend_View_Helper_Navigation_Helper setUseAcl ([bool $useAcl = true])

Zend_View_Helper_Navigation_Helper setUseTranslator ([bool $useTranslator = true])

string __toString ()

Methods

getAcl (line 89)

Returns ACL or null if it isn't set using setAcl() or setDefaultAcl()

return: ACL object or null
access: public

Zend_Acl|null getAcl ()

getContainer (line 52)

Returns the navigation container the helper operates on by default

return: navigation container
access: public

Zend_Navigation_Container getContainer ()

getRenderInvisible (line 135)

Return renderInvisible flag

access: public

bool getRenderInvisible ()

getRole (line 110)

Returns ACL role to use when iterating pages, or null if it isn't set

return: role or null
access: public

string|Zend_Acl_Role_Interface|null getRole ()

getTranslator (line 72)

Returns translator used in helper

return: translator or null
access: public

Zend_Translate_Adapter|null getTranslator ()

getUseAcl (line 128)

Returns whether ACL should be used

return: whether ACL should be used
access: public

bool getUseAcl ()

getUseTranslator (line 162)

Returns whether translator should be used

return: whether translator should be used
access: public

bool getUseTranslator ()

hasAcl (line 176)

Checks if the helper has an ACL instance

return: whether the helper has a an ACL instance or not
access: public

bool hasAcl ()

hasContainer (line 169)

Checks if the helper has a container

return: whether the helper has a container or not
access: public

bool hasContainer ()

hasRole (line 183)

Checks if the helper has an ACL role

return: whether the helper has a an ACL role or not
access: public

bool hasRole ()

hasTranslator (line 190)

Checks if the helper has a translator

return: whether the helper has a translator or not
access: public

bool hasTranslator ()

render (line 211)

Renders helper

return: helper output
throws: Zend_View_Exception if unable to render
access: public

string render ([ $container = null])

Zend_Navigation_Container $container: [optional] container to render. Default is null, which indicates that the helper should render the container returned by getContainer().

setAcl (line 81)

Sets ACL to use when iterating pages

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Helper setAcl ([ $acl = null])

Zend_Acl $acl: [optional] ACL instance

setContainer (line 45)

Sets navigation container the helper should operate on by default

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Helper setContainer ([ $container = null])

Zend_Navigation_Container $container: [optional] container to operate on. Default is null, which indicates that the container should be reset.

setRenderInvisible (line 144)

Render invisible items?

return: fluent interface returns self
access: public

Zend_View_Helper_Navigation_HelperAbstract setRenderInvisible ([bool $renderInvisible = true])

bool $renderInvisible: [optional] boolean flag

setRole (line 103)

Sets ACL role to use when iterating pages

return: fluent interface, returns self
throws: Zend_View_Exception if $role is invalid
access: public

Zend_View_Helper_Navigation_Helper setRole ([mixed $role = null])

mixed $role: [optional] role to set. Expects a string, an instance of type Zend_Acl_Role_Interface, or null. Default is null.

setTranslator (line 65)

Sets translator to use in helper

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Helper setTranslator ([mixed $translator = null])

mixed $translator: [optional] translator. Expects an object of type Zend_Translate_Adapter or Zend_Translate, or null. Default is null.

setUseAcl (line 121)

Sets whether ACL should be used

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Helper setUseAcl ([bool $useAcl = true])

bool $useAcl: [optional] whether ACL should be used. Default is true.

setUseTranslator (line 155)

Sets whether translator should be used

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Helper setUseTranslator ([bool $useTranslator = true])

bool $useTranslator: [optional] whether translator should be used. Default is true.

__toString (line 197)

Magic overload: Should proxy to render().

access: public

string __toString ()

Documentation generated on Mon, 21 Jun 2010 15:26:27 -0400 by phpDocumentor 1.4.3