View/Helper/Navigation/Helper.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_View
- Subpackage
- Helper
- Version
- $Id: Helper.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_View_Helper_Navigation_Helper
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods


getAcl() : \Zend_Acl | null
Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}
Type | Description |
---|---|
\Zend_Acl | null | ACL object or null |


getContainer() : \Zend_Navigation_Container
Returns the navigation container the helper operates on by default
Type | Description |
---|---|
\Zend_Navigation_Container | navigation container |


getRole() : string | \Zend_Acl_Role_Interface | null
Returns ACL role to use when iterating pages, or null if it isn't set
Type | Description |
---|---|
string | \Zend_Acl_Role_Interface | null | role or null |


getTranslator() : \Zend_Translate_Adapter | null
Returns translator used in helper
Type | Description |
---|---|
\Zend_Translate_Adapter | null | translator or null |


getUseAcl() : bool
Returns whether ACL should be used
Type | Description |
---|---|
bool | whether ACL should be used |


getUseTranslator() : bool
Returns whether translator should be used
Type | Description |
---|---|
bool | whether translator should be used |


hasAcl() : bool
Checks if the helper has an ACL instance
Type | Description |
---|---|
bool | whether the helper has a an ACL instance or not |


hasContainer() : bool
Checks if the helper has a container
Type | Description |
---|---|
bool | whether the helper has a container or not |


hasRole() : bool
Checks if the helper has an ACL role
Type | Description |
---|---|
bool | whether the helper has a an ACL role or not |


hasTranslator() : bool
Checks if the helper has a translator
Type | Description |
---|---|
bool | whether the helper has a translator or not |


render(\Zend_Navigation_Container $container = null) : string
Renders helper
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | [optional] container to render. Default is null, which indicates that the helper should render the container returned by {@link getContainer()}. |
Type | Description |
---|---|
string | helper output |
Exception | Description |
---|---|
\Zend_View_Exception | if unable to render |


setAcl(\Zend_Acl $acl = null) : \Zend_View_Helper_Navigation_Helper
Sets ACL to use when iterating pages
Name | Type | Description |
---|---|---|
$acl | \Zend_Acl | [optional] ACL instance |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |


setContainer(\Zend_Navigation_Container $container = null) : \Zend_View_Helper_Navigation_Helper
Sets navigation container the helper should operate on by default
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | [optional] container to operate on. Default is null, which indicates that the container should be reset. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |


setRenderInvisible(bool $renderInvisible = true) : \Zend_View_Helper_Navigation_HelperAbstract
Render invisible items?
Name | Type | Description |
---|---|---|
$renderInvisible | bool | [optional] boolean flag |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface returns self |


setRole(mixed $role = null) : \Zend_View_Helper_Navigation_Helper
Sets ACL role to use when iterating pages
Name | Type | Description |
---|---|---|
$role | mixed | [optional] role to set. Expects a string, an instance of type {@link Zend_Acl_Role_Interface}, or null. Default is null. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |
Exception | Description |
---|---|
\Zend_View_Exception | if $role is invalid |


setTranslator(mixed $translator = null) : \Zend_View_Helper_Navigation_Helper
Sets translator to use in helper
Name | Type | Description |
---|---|---|
$translator | mixed | [optional] translator. Expects an object of type {@link Zend_Translate_Adapter} or {@link Zend_Translate}, or null. Default is null. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |


setUseAcl(bool $useAcl = true) : \Zend_View_Helper_Navigation_Helper
Sets whether ACL should be used
Name | Type | Description |
---|---|---|
$useAcl | bool | [optional] whether ACL should be used. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |


setUseTranslator(bool $useTranslator = true) : \Zend_View_Helper_Navigation_Helper
Sets whether translator should be used
Name | Type | Description |
---|---|---|
$useTranslator | bool | [optional] whether translator should be used. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | fluent interface, returns self |