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 |
__toString() : string
string
getAcl() : \Zend_Acl | null
\Zend_Acl
null
ACL object or nullgetContainer() : \Zend_Navigation_Container
\Zend_Navigation_Container
navigation containergetRenderInvisible() : boolean
boolean
getRole() : string | \Zend_Acl_Role_Interface | null
string
\Zend_Acl_Role_Interface
null
role or nullgetTranslator() : \Zend_Translate_Adapter | null
\Zend_Translate_Adapter
null
translator or nullgetUseAcl() : boolean
boolean
whether ACL should be usedgetUseTranslator() : boolean
boolean
whether translator should be usedhasAcl() : boolean
boolean
whether the helper has a an ACL instance or nothasContainer() : boolean
boolean
whether the helper has a container or nothasRole() : boolean
boolean
whether the helper has a an ACL role or nothasTranslator() : boolean
boolean
whether the helper has a translator or notrender(\Zend_Navigation_Container $container = null
) : string
\Zend_Navigation_Container
[optional] container to render. Default is null, which indicates that the helper should render the container returned by {@link getContainer()}.
\Zend_View_Exception |
if unable to render |
---|
string
helper outputsetAcl(\Zend_Acl $acl = null
) : \Zend_View_Helper_Navigation_Helper
\Zend_Acl
[optional] ACL instance
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
selfsetContainer(\Zend_Navigation_Container $container = null
) : \Zend_View_Helper_Navigation_Helper
\Zend_Navigation_Container
[optional] container to operate on. Default is null, which indicates that the container should be reset.
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
selfsetRenderInvisible(boolean $renderInvisible = true
) : \Zend_View_Helper_Navigation_HelperAbstract
boolean
[optional] boolean flag
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface
returns selfsetRole(mixed $role = null
) : \Zend_View_Helper_Navigation_Helper
mixed
[optional] role to set. Expects a string, an instance of type {@link Zend_Acl_Role_Interface}, or null. Default is null.
\Zend_View_Exception |
if $role is invalid |
---|
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
selfsetTranslator(mixed $translator = null
) : \Zend_View_Helper_Navigation_Helper
mixed
[optional] translator. Expects an object of type {@link Zend_Translate_Adapter} or {@link Zend_Translate}, or null. Default is null.
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
selfsetUseAcl(boolean $useAcl = true
) : \Zend_View_Helper_Navigation_Helper
boolean
[optional] whether ACL should be used. Default is true.
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
selfsetUseTranslator(boolean $useTranslator = true
) : \Zend_View_Helper_Navigation_Helper
boolean
[optional] whether translator should be used. Default is true.
\Zend_View_Helper_Navigation_Helper
fluent interface, returns
self