__call()
__toString()
accept()
findActive()
getAcl()
getClosingBracket()
getContainer()
getIndent()
getMaxDepth()
getMinDepth()
getRenderInvisible()
getRole()
getServiceLocator()
getTranslator()
getTranslatorTextDomain()
getUseAcl()
getView()
hasAcl()
hasContainer()
hasRole()
hasTranslator()
htmlify()
isTranslatorEnabled()
render()
setAcl()
setContainer()
setDefaultAcl()
setDefaultRole()
setIndent()
setMaxDepth()
setMinDepth()
setRenderInvisible()
setRole()
setServiceLocator()
setTranslator()
setTranslatorEnabled()
setTranslatorTextDomain()
setUseAcl()
setView()
acceptAcl()
getWhitespace()
htmlAttribs()
isXhtml()
normalizeId()
parseContainer()
$acl
$closingBracket
$container
$defaultAcl
$defaultRole
$indent
$maxDepth
$minDepth
$renderInvisible
$role
$serviceLocator
$translator
$translatorEnabled
$translatorTextDomain
$useAcl
$view
EOL
Base class for navigational helpers
__call(string $method, array $arguments) : mixed
stringmethod name in container
array[optional] arguments to pass
\Zend\Navigation\Exception\ExceptionInterface |
if method does not exist in container |
|---|
mixedreturns what the container returns__toString() : string
This method will trigger an E_USER_ERROR if rendering the helper causes an exception to be thrown.
Implements HelperInterface::__toString().
stringaccept(\Zend\Navigation\Page\AbstractPage $page, bool $recursive) : bool
Rules: - If a page is not visible it is not accepted, unless RenderInvisible has been set to true. - If helper has no ACL, page is accepted - If helper has ACL, but no role, page is not accepted - If helper has ACL and role: - Page is accepted if it has no resource or privilege - Page is accepted if ACL allows page's resource or privilege - If page is accepted by the rules above and $recursive is true, the page will not be accepted if it is the descendant of a non-accepted page.
bool[optional] if true, page will not be accepted if it is the descendant of a page that is not accepted. Default is true.
boolwhether page should be acceptedfindActive(\Zend\Navigation\AbstractContainer $container, int | null $minDepth, int | null $maxDepth) : array
intnull[optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required.
intnull[optional] maximum depth a page can have to be valid. Default is to use {@link getMaxDepth()}. A null value means no maximum depth required.
arrayan associative array with the values 'depth' and 'page', or an empty array if not foundgetAcl() : \Zend\Permissions\Acl\AclInterface | null
Implements HelperInterface::getAcl().
\Zend\Permissions\Acl\AclInterfacenullACL object or nullgetClosingBracket() : string
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::getClosingBracket() |
|---|
stringgetContainer() : \Zend\Navigation\AbstractContainer
Implements HelperInterface::getContainer().
If no container is set, a new container will be instantiated and stored in the helper.
\Zend\Navigation\AbstractContainernavigation containergetIndent() : string
stringgetMaxDepth() : int | null
intnullmaximum depth or nullgetMinDepth() : int | null
intnullminimum depth or nullgetRenderInvisible() : bool
boolgetRole() : string | \Zend\Permissions\Acl\Role\RoleInterface | null
Implements HelperInterface::getRole().
getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface
getTranslatorTextDomain() : string
stringgetUseAcl() : bool
getView() : null | \Zend\View\Renderer\RendererInterface
| inherited_from | \Zend\View\Helper\AbstractHelper::getView() |
|---|---|
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::getView() |
hasAcl() : bool
hasContainer() : bool
hasRole() : bool
hasTranslator() : bool
boolhtmlify(\Zend\Navigation\Page\AbstractPage $page) : string
stringHTML string for the given pageisTranslatorEnabled() : bool
boolrender(string | \Zend\Navigation\AbstractContainer $container) : string
| inherited_from | \Zend\View\Helper\Navigation\HelperInterface::render() |
|---|
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 |
|---|
stringhelper outputsetAcl(\Zend\Permissions\Acl\AclInterface $acl) : \Zend\View\Helper\Navigation\AbstractHelper
Implements HelperInterface::setAcl().
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetContainer(string | \Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\AbstractHelper
Implements HelperInterface::setContainer().
string\Zend\Navigation\AbstractContainer[optional] container to operate on. Default is null, meaning container will be reset.
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetDefaultAcl(\Zend\Permissions\Acl\AclInterface $acl) : void
\Zend\Permissions\Acl\AclInterface[optional] ACL object. Default is null, which sets no ACL object.
setDefaultRole(mixed $role) : void
mixed[optional] role to set. Expects null, string, or an instance of {@link Acl\Role\RoleInterface}. Default is null, which sets no default role.
\Zend\View\Exception\InvalidArgumentException |
if role is invalid |
|---|
setIndent(string | int $indent) : \Zend\View\Helper\Navigation\AbstractHelper
stringintindentation string or number of spaces
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetMaxDepth(int $maxDepth) : \Zend\View\Helper\Navigation\AbstractHelper
int[optional] maximum depth. Default is null, which sets no maximum depth.
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetMinDepth(int $minDepth) : \Zend\View\Helper\Navigation\AbstractHelper
int[optional] minimum depth. Default is null, which sets no minimum depth.
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetRenderInvisible(bool $renderInvisible) : \Zend\View\Helper\Navigation\AbstractHelper
bool[optional] boolean flag
\Zend\View\Helper\Navigation\AbstractHelperfluent interface returns selfsetRole(mixed $role) : \Zend\View\Helper\Navigation\AbstractHelper
Implements HelperInterface::setRole().
mixed[optional] role to set. Expects a string, an instance of type {@link Acl\Role\RoleInterface}, or null. Default is null, which will set no role.
\Zend\View\Exception\InvalidArgumentException |
if $role is invalid |
|---|
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetServiceLocator(\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator) : \Zend\View\Helper\Navigation\AbstractHelper
setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
\Zend\I18n\Translator\Translator[optional] translator. Default is null, which sets no translator.
string[optional] text domain Default is null, which skips setTranslatorTextDomain
setTranslatorEnabled(bool $enabled) : \Zend\View\Helper\Navigation\AbstractHelper
bool[optional] whether translator should be used. Default is true.
setTranslatorTextDomain(string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
setUseAcl(bool $useAcl) : \Zend\View\Helper\Navigation\AbstractHelper
Implements HelperInterface::setUseAcl().
bool[optional] whether ACL should be used. Default is true.
\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns selfsetView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
| inherited_from | \Zend\View\Helper\AbstractHelper::setView() |
|---|---|
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::setView() |
acceptAcl(\Zend\Navigation\Page\AbstractPage $page) : bool
Rules: - If helper has no ACL, page is accepted - If page has a resource or privilege defined, page is accepted if the ACL allows access to it using the helper's role - If page has no resource or privilege, page is accepted
boolwhether page is accepted by ACLgetWhitespace(int | string $indent) : string
intstring
stringhtmlAttribs(array $attribs) : string
Overloads View\Helper\AbstractHtmlElement::htmlAttribs().
arrayan array where each key-value pair is converted to an attribute name and value
stringan attribute stringisXhtml() : bool
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::isXhtml() |
|---|
boolnormalizeId(string $value) : string
parseContainer(\Zend\Navigation\AbstractContainer | string | null $container)
\Zend\Navigation\AbstractContainerstringnull
\Zend\View\Exception\InvalidArgumentException |
|---|
$closingBracket : string
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::$$closingBracket |
|---|
$defaultAcl : \Zend\Permissions\Acl\AclInterface
$defaultRole : string | \Zend\Permissions\Acl\Role\RoleInterface
$indent : string
$maxDepth : int
$minDepth : int
$renderInvisible : bool
$translatorEnabled : bool
$translatorTextDomain : string
$useAcl : bool
$view : \Zend\View\Renderer\RendererInterface
| inherited_from | \Zend\View\Helper\AbstractHelper::$$view |
|---|---|
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::$$view |
EOL
| inherited_from | \Zend\View\Helper\AbstractHtmlElement::EOL |
|---|