Interface for navigational helpers

package Default
inherited_from \Zend\View\Helper\HelperInterface

 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\Permissions\Acl\AclInterface | null

Returns

\Zend\Permissions\Acl\AclInterfacenull

Returns the navigation container the helper operates on by default

getContainer() : \Zend\Navigation\AbstractContainer

Returns

\Zend\Navigation\AbstractContainernavigation 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\Permissions\Acl\Role\RoleInterface | null

Returns

string\Zend\Permissions\Acl\Role\RoleInterfacenull

Returns whether ACL should be used

getUseAcl() : boolean

Returns

boolean

Checks if the helper has an ACL instance

hasAcl() : boolean

Returns

boolean

Checks if the helper has a container

hasContainer() : boolean

Returns

boolean

Checks if the helper has an ACL role

hasRole() : boolean

Returns

boolean

Renders helper

render(string|\Zend\Navigation\AbstractContainer $container = null) : string

Parameters

$container

string\Zend\Navigation\AbstractContainer

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

Exceptions

\Zend\View\Exception\ExceptionInterface

Returns

stringhelper output

Sets ACL to use when iterating pages

setAcl(\Zend\Permissions\Acl\AclInterface $acl = null) : \Zend\View\Helper\Navigation\HelperInterface

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

[optional] ACL instance

Returns

\Zend\View\Helper\Navigation\HelperInterface

Sets navigation container the helper should operate on by default

setContainer(string|\Zend\Navigation\AbstractContainer $container = null) : \Zend\View\Helper\Navigation\HelperInterface

Parameters

$container

string\Zend\Navigation\AbstractContainer

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

Returns

\Zend\View\Helper\Navigation\HelperInterface

Render invisible items?

setRenderInvisible(boolean $renderInvisible = true) : \Zend\View\Helper\Navigation\HelperInterface

Parameters

$renderInvisible

boolean

[optional] boolean flag

Returns

\Zend\View\Helper\Navigation\HelperInterface

Sets ACL role to use when iterating pages

setRole(mixed $role = null) : \Zend\View\Helper\Navigation\HelperInterface

Parameters

$role

mixed

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

Exceptions

\Zend\View\Exception\ExceptionInterface if $role is invalid

Returns

\Zend\View\Helper\Navigation\HelperInterface

Sets whether ACL should be used

setUseAcl(boolean $useAcl = true) : \Zend\View\Helper\Navigation\HelperInterface

Parameters

$useAcl

boolean

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

Returns

\Zend\View\Helper\Navigation\HelperInterface