Zend Framework
Back to top  

Helper for rendering menus from navigation containers

 Methods

Magic overload: Proxy calls to the navigation container

__call(string $method, array $arguments) : mixed
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::__call()

Parameters

$method

string

method name in container

$arguments

array

rguments to pass

Exceptions

\Zend\Navigation\Exception\ExceptionInterface

Returns

mixed

View helper entry point: Retrieves helper and optionally sets container to operate on

__invoke(\Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\self

Parameters

$container

\Zend\Navigation\AbstractContainer

[optional] container to operate on

Returns

\Zend\View\Helper\Navigation\self

Magic overload: Proxy to {@link render()}.

__toString() : string
Inherited

This method will trigger an E_USER_ERROR if rendering the helper causes an exception to be thrown.

Implements HelperInterface::__toString().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::__toString()

Returns

string

Determines whether a page should be accepted when iterating

accept(\Zend\Navigation\Page\AbstractPage $page, bool $recursive) : bool
Inherited

Default listener may be 'overridden' by attaching listener to 'isAllowed' method. Listener must be 'short circuited' if overriding default ACL listener.

Rules: - If a page is not visible it is not accepted, unless RenderInvisible has been set to true - If $useAcl is true (default is true): - Page is accepted if listener returns true, otherwise false - If page is accepted and $recursive is true, the page will not be accepted if it is the descendant of a non-accepted page

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::accept()

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to check

$recursive

bool

[optional] if true, page will not be accepted if it is the descendant of a page that is not accepted. Default is true

Returns

boolWhether page should be accepted

Sets a flag indicating whether labels should be escaped

escapeLabels(bool $flag) : \Zend\View\Helper\Navigation\self

Parameters

$flag

bool

[optional] escape labels

Returns

\Zend\View\Helper\Navigation\self

Finds the deepest active page in the given container

findActive(\Zend\Navigation\AbstractContainer $container, int | null $minDepth, int | null $maxDepth) : array
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::findActive()

Parameters

$container

\Zend\Navigation\AbstractContainer

container to search

$minDepth

intnull

[optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required.

$maxDepth

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.

Returns

arrayan associative array with the values 'depth' and 'page', or an empty array if not found

Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}

getAcl() : \Zend\Permissions\Acl\AclInterface | null
Inherited

Implements HelperInterface::getAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getAcl()

Returns

\Zend\Permissions\Acl\AclInterfacenullACL object or null

Returns flag indicating whether page class should be applied to <li> element

getAddClassToListItem() : bool

By default, this value is false.

Returns

boolwhether parents should be rendered

Get the tag closing bracket

getClosingBracket() : string
Inherited

inherited_from \Zend\View\Helper\AbstractHtmlElement::getClosingBracket()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getClosingBracket()

Returns

string

Returns the navigation container helper operates on by default

getContainer() : \Zend\Navigation\AbstractContainer
Inherited

Implements HelperInterface::getContainer().

If no container is set, a new container will be instantiated and stored in the helper.

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getContainer()

Returns

\Zend\Navigation\AbstractContainernavigation container

Get the event manager.

getEventManager() : \Zend\EventManager\EventManagerInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getEventManager()

Returns

\Zend\EventManager\EventManagerInterface

Returns indentation

getIndent() : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getIndent()

Returns

string

Returns CSS class to use for the active 'li' element when rendering

getLiActiveClass() : string

Returns

string

Returns maximum depth a page can have to be included when rendering

getMaxDepth() : int | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getMaxDepth()

Returns

intnull

Returns minimum depth a page must have to be included when rendering

getMinDepth() : int | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getMinDepth()

Returns

intnull

Returns a flag indicating whether only active branch should be rendered

getOnlyActiveBranch() : bool

By default, this value is false, meaning the entire menu will be be rendered.

Returns

bool

Returns partial view script to use for rendering menu

getPartial() : string | array | null

Returns

stringarraynull

Return renderInvisible flag

getRenderInvisible() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getRenderInvisible()

Returns

bool

Returns flag indicating whether parents should be rendered when rendering only the active branch

getRenderParents() : bool

By default, this value is true.

Returns

bool

Returns ACL role to use when iterating pages, or null if it isn't set using {@link setRole()} or {@link setDefaultRole()}

getRole() : string | \Zend\Permissions\Acl\Role\RoleInterface | null
Inherited

Implements HelperInterface::getRole().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getRole()

Returns

string\Zend\Permissions\Acl\Role\RoleInterfacenull

Get the service locator.

getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getServiceLocator()

Returns

\Zend\ServiceManager\ServiceLocatorInterface

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\TranslatorInterface | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getTranslator()

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getTranslatorTextDomain()

Returns

string

Returns CSS class to use for the first 'ul' element when rendering

getUlClass() : string

Returns

string

Returns whether ACL should be used

getUseAcl() : bool
Inherited

Implements HelperInterface::getUseAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getUseAcl()

Returns

bool

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\View\Helper\AbstractHtmlElement::getView()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getView()

Returns

null\Zend\View\Renderer\RendererInterface

Checks if the helper has an ACL instance

hasAcl() : bool
Inherited

Implements HelperInterface::hasAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasAcl()

Returns

bool

Checks if the helper has a container

hasContainer() : bool
Inherited

Implements HelperInterface::hasContainer().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasContainer()

Returns

bool

Checks if the helper has an ACL role

hasRole() : bool
Inherited

Implements HelperInterface::hasRole().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasRole()

Returns

bool

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasTranslator()

Returns

bool

Returns an HTML string containing an 'a' element for the given page if the page's href is not empty, and a 'span' element if it is empty

htmlify(\Zend\Navigation\Page\AbstractPage $page, bool $escapeLabel, bool $addClassToListItem) : string

Overrides AbstractHelper::htmlify().

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to generate HTML for

$escapeLabel

bool

Whether or not to escape the label

$addClassToListItem

bool

Whether or not to add the page class to the list item

Returns

string

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::isTranslatorEnabled()

Returns

bool

Renders menu

render(\Zend\Navigation\AbstractContainer $container) : string

Implements HelperInterface::render().

If a partial view is registered in the helper, the menu will be rendered using the given partial script. If no partial is registered, the menu will be rendered as an 'ul' element by the helper's internal method.

see \Zend\View\Helper\Navigation\renderPartial()
see \Zend\View\Helper\Navigation\renderMenu()

Parameters

$container

\Zend\Navigation\AbstractContainer

[optional] container to render. Default is to render the container registered in the helper.

Exceptions

\Zend\View\Exception\ExceptionInterface

Returns

string

Renders helper

renderMenu(\Zend\Navigation\AbstractContainer $container, array $options) : string

Renders a HTML 'ul' for the given $container. If $container is not given, the container registered in the helper will be used.

Available $options:

Parameters

$container

\Zend\Navigation\AbstractContainer

[optional] container to create menu from. Default is to use the container retrieved from {@link getContainer()}.

$options

array

[optional] options for controlling rendering

Returns

string

Renders the given $container by invoking the partial view helper

renderPartial(\Zend\Navigation\AbstractContainer $container, string | array $partial) : string

The container will simply be passed on as a model to the view script as-is, and will be available in the partial script as 'container', e.g.

echo 'Number of pages: ', count($this->container);

.

Parameters

$container

\Zend\Navigation\AbstractContainer

[optional] container to pass to view script. Default is to use the container registered in the helper.

$partial

stringarray

[optional] partial view script to use. Default is to use the partial registered in the helper. If an array is given, it is expected to contain two values; the partial view script to use, and the module where the script can be found.

Exceptions

\Zend\View\Exception\RuntimeException if no partial provided
\Zend\View\Exception\InvalidArgumentException if partial is invalid array

Returns

string

Renders the inner-most sub menu for the active page in the $container

renderSubMenu(\Zend\Navigation\AbstractContainer $container, string $ulClass, string | int $indent, string $liActiveClass) : string

This is a convenience method which is equivalent to the following call:

renderMenu($container, array(
    'indent'           => $indent,
    'ulClass'          => $ulClass,
    'minDepth'         => null,
    'maxDepth'         => null,
    'onlyActiveBranch' => true,
    'renderParents'    => false,
    'liActiveClass'    => $liActiveClass
));

Parameters

$container

\Zend\Navigation\AbstractContainer

[optional] container to render. Default is to render the container registered in the helper.

$ulClass

string

[optional] CSS class to use for UL element. Default is to use the value from {@link getUlClass()}.

$indent

stringint

[optional] indentation as a string or number of spaces. Default is to use the value retrieved from {@link getIndent()}.

$liActiveClass

string

[optional] CSS class to use for UL element. Default is to use the value from {@link getUlClass()}.

Returns

string

Sets ACL to use when iterating pages

setAcl(\Zend\Permissions\Acl\AclInterface $acl) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Implements HelperInterface::setAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setAcl()

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

ACL object.

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Enables/disables page class applied to <li> element

setAddClassToListItem(bool $flag) : \Zend\View\Helper\Navigation\self

Parameters

$flag

bool

[optional] page class applied to

  • element Default is true.

    • Returns

    \Zend\View\Helper\Navigation\selffluent interface, returns self

    Sets navigation container the helper operates on by default

    setContainer(string | \Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    Implements HelperInterface::setContainer().

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setContainer()

    Parameters

    $container

    string\Zend\Navigation\AbstractContainer

    Default is null, meaning container will be reset.

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets default ACL to use if another ACL is not explicitly set

    setDefaultAcl(\Zend\Permissions\Acl\AclInterface $acl) : void
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setDefaultAcl()

    Parameters

    $acl

    \Zend\Permissions\Acl\AclInterface

    [optional] ACL object. Default is null, which sets no ACL object.

    Sets default ACL role(s) to use when iterating pages if not explicitly set later with {@link setRole()}

    setDefaultRole(mixed $role) : void
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setDefaultRole()

    Parameters

    $role

    mixed

    [optional] role to set. Expects null, string, or an instance of {@link Acl\Role\RoleInterface}. Default is null, which sets no default role.

    Exceptions

    \Zend\View\Exception\InvalidArgumentException if role is invalid

    Set the event manager.

    setEventManager(\Zend\EventManager\EventManagerInterface $events) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setEventManager()

    Parameters

    $events

    \Zend\EventManager\EventManagerInterface

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Set the indentation string for using in {@link render()}, optionally a number of spaces to indent with

    setIndent(string | int $indent) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setIndent()

    Parameters

    $indent

    stringint

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets CSS class to use for the active 'li' element when rendering

    setLiActiveClass(string $liActiveClass) : \Zend\View\Helper\Navigation\self

    Parameters

    $liActiveClass

    string

    CSS class to set

    Returns

    \Zend\View\Helper\Navigation\self

    Sets the maximum depth a page can have to be included when rendering

    setMaxDepth(int $maxDepth) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setMaxDepth()

    Parameters

    $maxDepth

    int

    Default is null, which sets no maximum depth.

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets the minimum depth a page must have to be included when rendering

    setMinDepth(int $minDepth) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setMinDepth()

    Parameters

    $minDepth

    int

    Default is null, which sets no minimum depth.

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets a flag indicating whether only active branch should be rendered

    setOnlyActiveBranch(bool $flag) : \Zend\View\Helper\Navigation\self

    Parameters

    $flag

    bool

    [optional] render only active branch.

    Returns

    \Zend\View\Helper\Navigation\self

    Sets which partial view script to use for rendering menu

    setPartial(string | array $partial) : \Zend\View\Helper\Navigation\self

    Parameters

    $partial

    stringarray

    partial view script or null. If an array is given, it is expected to contain two values; the partial view script to use, and the module where the script can be found.

    Returns

    \Zend\View\Helper\Navigation\self

    Render invisible items?

    setRenderInvisible(bool $renderInvisible) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setRenderInvisible()

    Parameters

    $renderInvisible

    bool

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Enables/disables rendering of parents when only rendering active branch

    setRenderParents(bool $flag) : \Zend\View\Helper\Navigation\self

    See setOnlyActiveBranch() for more information.

    Parameters

    $flag

    bool

    [optional] render parents when rendering active branch.

    Returns

    \Zend\View\Helper\Navigation\self

    Sets ACL role(s) to use when iterating pages

    setRole(mixed $role) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    Implements HelperInterface::setRole().

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setRole()

    Parameters

    $role

    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.

    Exceptions

    \Zend\View\Exception\InvalidArgumentException

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Set the service locator.

    setServiceLocator(\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setServiceLocator()

    Parameters

    $serviceLocator

    \Zend\ServiceManager\ServiceLocatorInterface

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets translator to use in helper

    setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator, string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslator()

    Parameters

    $translator

    \Zend\I18n\Translator\TranslatorInterface

    [optional] translator. Default is null, which sets no translator.

    $textDomain

    string

    [optional] text domain Default is null, which skips setTranslatorTextDomain

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets whether translator is enabled and should be used

    setTranslatorEnabled(bool $enabled) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslatorEnabled()

    Parameters

    $enabled

    bool

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Set translation text domain

    setTranslatorTextDomain(string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslatorTextDomain()

    Parameters

    $textDomain

    string

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Sets CSS class to use for the first 'ul' element when rendering

    setUlClass(string $ulClass) : \Zend\View\Helper\Navigation\self

    Parameters

    $ulClass

    string

    CSS class to set

    Returns

    \Zend\View\Helper\Navigation\self

    Sets whether ACL should be used

    setUseAcl(bool $useAcl) : \Zend\View\Helper\Navigation\AbstractHelper
    Inherited

    Implements HelperInterface::setUseAcl().

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setUseAcl()

    Parameters

    $useAcl

    bool

    Returns

    \Zend\View\Helper\Navigation\AbstractHelper

    Set the View object

    setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
    Inherited

    inherited_from \Zend\View\Helper\AbstractHelper::setView()
    inherited_from \Zend\View\Helper\AbstractHtmlElement::setView()
    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setView()

    Parameters

    $view

    \Zend\View\Renderer\RendererInterface

    Returns

    \Zend\View\Helper\AbstractHelper

    Retrieve whitespace representation of $indent

    getWhitespace(int | string $indent) : string
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getWhitespace()

    Parameters

    $indent

    intstring

    Returns

    string

    Converts an associative array to a string of tag attributes.

    htmlAttribs(array $attribs) : string
    Inherited

    Overloads View\Helper\AbstractHtmlElement::htmlAttribs().

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::htmlAttribs()

    Parameters

    $attribs

    array

    an array where each key-value pair is converted to an attribute name and value

    Returns

    string

    Determines whether a page should be allowed given certain parameters

    isAllowed(array $params) : bool
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::isAllowed()

    Parameters

    $params

    array

    Returns

    bool

    Is doctype XHTML?

    isXhtml() : bool
    Inherited

    inherited_from \Zend\View\Helper\AbstractHtmlElement::isXhtml()
    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::isXhtml()

    Returns

    bool

    Normalize an ID

    normalizeId(string $value) : string
    Inherited

    Overrides View\Helper\AbstractHtmlElement::normalizeId().

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::normalizeId()

    Parameters

    $value

    string

    Returns

    string

    Normalizes given render options

    normalizeOptions(array $options) : array

    Parameters

    $options

    array

    [optional] options to normalize

    Returns

    array

    Verifies container and eventually fetches it from service locator if it is a string

    parseContainer(\Zend\Navigation\AbstractContainer | string | null $container) 
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::parseContainer()

    Parameters

    $container

    \Zend\Navigation\AbstractContainerstringnull

    Exceptions

    \Zend\View\Exception\InvalidArgumentException

    Renders the deepest active menu within [$minDepth, $maxDepth], (called from {@link renderMenu()})

    renderDeepestMenu(\Zend\Navigation\AbstractContainer $container, string $ulClass, string $indent, int | null $minDepth, int | null $maxDepth, bool $escapeLabels, bool $addClassToListItem, string $liActiveClass) : string

    Parameters

    $container

    \Zend\Navigation\AbstractContainer

    container to render

    $ulClass

    string

    CSS class for first UL

    $indent

    string

    initial indentation

    $minDepth

    intnull

    minimum depth

    $maxDepth

    intnull

    maximum depth

    $escapeLabels

    bool

    Whether or not to escape the labels

    $addClassToListItem

    bool

    Whether or not page class applied to

  • element

    • $liActiveClass

    string

    CSS class for active LI

    Returns

    string

    Renders a normal menu (called from {@link renderMenu()})

    renderNormalMenu(\Zend\Navigation\AbstractContainer $container, string $ulClass, string $indent, int | null $minDepth, int | null $maxDepth, bool $onlyActive, bool $escapeLabels, bool $addClassToListItem, string $liActiveClass) : string

    Parameters

    $container

    \Zend\Navigation\AbstractContainer

    container to render

    $ulClass

    string

    CSS class for first UL

    $indent

    string

    initial indentation

    $minDepth

    intnull

    minimum depth

    $maxDepth

    intnull

    maximum depth

    $onlyActive

    bool

    render only active branch?

    $escapeLabels

    bool

    Whether or not to escape the labels

    $addClassToListItem

    bool

    Whether or not page class applied to

  • element

    • $liActiveClass

    string

    CSS class for active LI

    Returns

    string

    Attaches default ACL listeners, if ACLs are in use

    setDefaultListeners() 
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setDefaultListeners()

    Translate a message (for label, title, …)

    translate(string $message, string $textDomain) : string
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::translate()

    Parameters

    $message

    string

    ID of the message to translate

    $textDomain

    string

    Text domain (category name for the translations)

    Returns

    stringTranslated message

     Properties

     

    ACL to use when iterating pages

    $acl : \Zend\Permissions\Acl\AclInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$acl
     

    Whether page class should be applied to <li> element

    $addClassToListItem : bool

     

    The tag closing bracket

    $closingBracket : string
    Inherited

    inherited_from \Zend\View\Helper\AbstractHtmlElement::$$closingBracket
    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$closingBracket
     

    AbstractContainer to operate on by default

    $container : \Zend\Navigation\AbstractContainer
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$container
     

    Default ACL to use when iterating pages if not explicitly set in the instance by calling {@link setAcl()}

    $defaultAcl : \Zend\Permissions\Acl\AclInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$defaultAcl
     

    Default ACL role to use when iterating pages if not explicitly set in the instance by calling {@link setRole()}

    $defaultRole : string | \Zend\Permissions\Acl\Role\RoleInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$defaultRole
     

    Whether labels should be escaped

    $escapeLabels : bool

     

    $events

    $events : \Zend\EventManager\EventManagerInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$events
     

    Indentation string

    $indent : string
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$indent
     

    CSS class to use for the active li element

    $liActiveClass : string

     

    The maximum depth a page can have to be included when rendering

    $maxDepth : int
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$maxDepth
     

    The minimum depth a page must have to be included when rendering

    $minDepth : int
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$minDepth
     

    Whether only active branch should be rendered

    $onlyActiveBranch : bool

     

    Partial view script to use for rendering menu

    $partial : string | array

     

    Whether invisible items should be rendered by this helper

    $renderInvisible : bool
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$renderInvisible
     

    Whether parents should be rendered when only rendering active branch

    $renderParents : bool

     

    ACL role to use when iterating pages

    $role : string | \Zend\Permissions\Acl\Role\RoleInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$role
     

    $serviceLocator

    $serviceLocator : \Zend\ServiceManager\ServiceLocatorInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$serviceLocator
     

    Translator (optional)

    $translator : \Zend\I18n\Translator\TranslatorInterface
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translator
     

    Whether translator should be used

    $translatorEnabled : bool
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translatorEnabled
     

    Translator text domain (optional)

    $translatorTextDomain : string
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translatorTextDomain
     

    CSS class to use for the ul element

    $ulClass : string

     

    Whether ACL should be used for filtering out pages

    $useAcl : bool
    Inherited

    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$useAcl
     

    View object instance

    $view : \Zend\View\Renderer\RendererInterface
    Inherited

    inherited_from \Zend\View\Helper\AbstractHelper::$$view
    inherited_from \Zend\View\Helper\AbstractHtmlElement::$$view
    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$view

     Constants

     

    EOL character

    EOL 
    Inherited

    inherited_from \Zend\View\Helper\AbstractHtmlElement::EOL
    inherited_from \Zend\View\Helper\Navigation\AbstractHelper::EOL