__toString()
getAcl()
getContainer()
getRenderInvisible()
getRole()
getUseAcl()
hasAcl()
hasContainer()
hasRole()
render()
setAcl()
setContainer()
setRenderInvisible()
setRole()
setUseAcl()
Interface for navigational helpers
__toString() : string
string
getAcl() : \Zend\Permissions\Acl\AclInterface | null
\Zend\Permissions\Acl\AclInterface
null
ACL object or nullgetContainer() : \Zend\Navigation\AbstractContainer
\Zend\Navigation\AbstractContainer
navigation containergetRenderInvisible() : bool
bool
getRole() : string | \Zend\Permissions\Acl\Role\RoleInterface | null
getUseAcl() : bool
bool
whether ACL should be usedhasAcl() : bool
bool
whether the helper has a an ACL instance or nothasContainer() : bool
bool
whether the helper has a container or nothasRole() : bool
bool
whether the helper has a an ACL role or notrender(string | \Zend\Navigation\AbstractContainer $container) : string
string\Zend\Navigation\AbstractContainer
[optional] container to render. Default is null, which indicates that the helper should render the container returned by {@link getContainer()}.
\Zend\View\Exception\ExceptionInterface |
if unable to render |
---|
string
helper outputsetAcl(\Zend\Permissions\Acl\AclInterface $acl) : \Zend\View\Helper\Navigation\HelperInterface
setContainer(string | \Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\HelperInterface
string\Zend\Navigation\AbstractContainer
[optional] container to operate on. Default is null, which indicates that the container should be reset.
\Zend\View\Helper\Navigation\HelperInterface
fluent interface, returns selfsetRenderInvisible(bool $renderInvisible) : \Zend\View\Helper\Navigation\HelperInterface
bool
[optional] boolean flag
\Zend\View\Helper\Navigation\HelperInterface
fluent interface returns selfsetRole(mixed $role) : \Zend\View\Helper\Navigation\HelperInterface
mixed
[optional] role to set. Expects a string, an instance of type {@link Acl\Role}, or null. Default is null.
\Zend\View\Exception\ExceptionInterface |
if $role is invalid |
---|
\Zend\View\Helper\Navigation\HelperInterface
fluent interface, returns selfsetUseAcl(bool $useAcl) : \Zend\View\Helper\Navigation\HelperInterface
bool
[optional] whether ACL should be used. Default is true.
\Zend\View\Helper\Navigation\HelperInterface
fluent interface, returns self