Interface for navigational helpers

category Zend
package Zend_View
subpackage Helper
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Magic overload: Should proxy to {@link render()}.

__toString() : string

Returns

string

Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}

getAcl() : \Zend_Acl | null

Returns

\Zend_AclnullACL object or null

Returns the navigation container the helper operates on by default

getContainer() : \Zend_Navigation_Container

Returns

\Zend_Navigation_Containernavigation container

Return renderInvisible flag

getRenderInvisible() : boolean

Returns

boolean

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

getRole() : string | \Zend_Acl_Role_Interface | null

Returns

string\Zend_Acl_Role_Interfacenullrole or null

Returns translator used in helper

getTranslator() : \Zend_Translate_Adapter | null

Returns

\Zend_Translate_Adapternulltranslator or null

Returns whether ACL should be used

getUseAcl() : boolean

Returns

booleanwhether ACL should be used

Returns whether translator should be used

getUseTranslator() : boolean

Returns

booleanwhether translator should be used

Checks if the helper has an ACL instance

hasAcl() : boolean

Returns

booleanwhether the helper has a an ACL instance or not

Checks if the helper has a container

hasContainer() : boolean

Returns

booleanwhether the helper has a container or not

Checks if the helper has an ACL role

hasRole() : boolean

Returns

booleanwhether the helper has a an ACL role or not

Checks if the helper has a translator

hasTranslator() : boolean

Returns

booleanwhether the helper has a translator or not

Renders helper

render(\Zend_Navigation_Container $container = null) : string

Parameters

$container

\Zend_Navigation_Container

[optional] container to render. Default is null, which indicates that the helper should render the container returned by {@link getContainer()}.

Exceptions

\Zend_View_Exception if unable to render

Returns

stringhelper output

Sets ACL to use when iterating pages

setAcl(\Zend_Acl $acl = null) : \Zend_View_Helper_Navigation_Helper

Parameters

$acl

\Zend_Acl

[optional] ACL instance

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self

Sets navigation container the helper should operate on by default

setContainer(\Zend_Navigation_Container $container = null) : \Zend_View_Helper_Navigation_Helper

Parameters

$container

\Zend_Navigation_Container

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

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self

Render invisible items?

setRenderInvisible(boolean $renderInvisible = true) : \Zend_View_Helper_Navigation_HelperAbstract

Parameters

$renderInvisible

boolean

[optional] boolean flag

Returns

\Zend_View_Helper_Navigation_HelperAbstractfluent interface returns self

Sets ACL role to use when iterating pages

setRole(mixed $role = null) : \Zend_View_Helper_Navigation_Helper

Parameters

$role

mixed

[optional] role to set. Expects a string, an instance of type {@link Zend_Acl_Role_Interface}, or null. Default is null.

Exceptions

\Zend_View_Exception if $role is invalid

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self

Sets translator to use in helper

setTranslator(mixed $translator = null) : \Zend_View_Helper_Navigation_Helper

Parameters

$translator

mixed

[optional] translator. Expects an object of type {@link Zend_Translate_Adapter} or {@link Zend_Translate}, or null. Default is null.

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self

Sets whether ACL should be used

setUseAcl(boolean $useAcl = true) : \Zend_View_Helper_Navigation_Helper

Parameters

$useAcl

boolean

[optional] whether ACL should be used. Default is true.

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self

Sets whether translator should be used

setUseTranslator(boolean $useTranslator = true) : \Zend_View_Helper_Navigation_Helper

Parameters

$useTranslator

boolean

[optional] whether translator should be used. Default is true.

Returns

\Zend_View_Helper_Navigation_Helperfluent interface, returns self