Proxy helper for retrieving navigational helpers and forwarding calls

package Default
inherited_from \Zend\View\Helper\Navigation\AbstractHelper

 Methods

Magic overload: Proxy to other navigation helpers or the container

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

Examples of usage from a view script or layout: // proxy to Menu helper and render container: echo $this->navigation()->menu();

// proxy to Breadcrumbs helper and set indentation: $this->navigation()->breadcrumbs()->setIndent(8);

// proxy to container and find all pages with 'blog' route: $blogPages = $this->navigation()->findAllByRoute('blog');

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

Parameters

$method

string

helper name or method name in container

$arguments

array

[optional] arguments to pass

Exceptions

\Zend\View\Exception\ExceptionInterface if proxying to a helper, and the helper is not an instance of the interface specified in {@link findHelper()}
\Zend\Navigation\Exception\ExceptionInterface if method does not exist in container

Returns

mixedreturns what the proxied call returns

Magic overload: Proxy calls to the navigation container

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

Parameters

$method

string

method name in container

$arguments

array

rguments to pass

Exceptions

\Zend\Navigation\Exception\ExceptionInterface

Returns

mixed

Helper entry point

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

Parameters

$container

string\Zend\Navigation\AbstractContainer

container to operate on

Returns

\Zend\View\Helper\Navigation

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\HelperInterface::__toString()

Returns

string

Determines whether a page should be accepted when iterating

accept(\Zend\Navigation\Page\AbstractPage $page, boolean $recursive = true) : boolean
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

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to check

$recursive

boolean

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

Returns

booleanWhether page should be accepted

Finds the deepest active page in the given container

findActive(\Zend\Navigation\AbstractContainer $container, integer|null $minDepth = null, integer|null $maxDepth = -1) : array
Inherited

Parameters

$container

\Zend\Navigation\AbstractContainer

container to search

$minDepth

integernull

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

$maxDepth

integernull

[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 the helper matching $proxy

findHelper(string $proxy, boolean $strict = true) : \Zend\View\Helper\Navigation\HelperInterface

The helper must implement the interface \Zend\View\Helper\Navigation\Helper.

Parameters

$proxy

string

helper name

$strict

boolean

[optional] whether exceptions should be thrown if something goes wrong. Default is true.

Exceptions

\Zend\View\Exception\RuntimeException if $strict is true and helper cannot be found

Returns

\Zend\View\Helper\Navigation\HelperInterfacehelper instance

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\HelperInterface::getAcl()

Returns

\Zend\Permissions\Acl\AclInterfacenullACL object or null

Get the tag closing bracket

getClosingBracket() : string
Inherited

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\HelperInterface::getContainer()

Returns

\Zend\Navigation\AbstractContainernavigation container

Returns the default proxy to use in {@link render()}

getDefaultProxy() : string

Returns

string

Get the event manager.

getEventManager() : \Zend\EventManager\EventManagerInterface
Inherited

Returns

\Zend\EventManager\EventManagerInterface

Returns indentation

getIndent() : string
Inherited

Returns

string

Returns whether ACL should be injected when proxying

getInjectAcl() : boolean

Returns

boolean

Returns whether container should be injected when proxying

getInjectContainer() : boolean

Returns

boolean

Returns whether translator should be injected when proxying

getInjectTranslator() : boolean

Returns

boolean

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

getMaxDepth() : integer | null
Inherited

Returns

integernull

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

getMinDepth() : integer | null
Inherited

Returns

integernull

Retrieve plugin loader for navigation helpers

getPluginManager() : \Zend\View\Helper\Navigation\PluginManager

Lazy-loads an instance of Navigation\HelperLoader if none currently registered.

Returns

\Zend\View\Helper\Navigation\PluginManager

Return renderInvisible flag

getRenderInvisible() : boolean
Inherited
inherited_from \Zend\View\Helper\Navigation\HelperInterface::getRenderInvisible()

Returns

boolean

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\HelperInterface::getRole()

Returns

string\Zend\Permissions\Acl\Role\RoleInterfacenull

Get the service locator.

getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface
Inherited
inherited_from \Zend\ServiceManager\ServiceLocatorAwareInterface::getServiceLocator()

Returns

\Zend\ServiceManager\ServiceLocatorInterface

Returns translator used in helper

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

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::getTranslatorTextDomain()

Returns

string

Returns whether ACL should be used

getUseAcl() : boolean
Inherited

Implements \HelperInterface::getUseAcl().

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

Returns

boolean

Get the view object

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

Returns

null\Zend\View\Renderer\RendererInterface

Checks if the helper has an ACL instance

hasAcl() : boolean
Inherited

Implements \HelperInterface::hasAcl().

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

Returns

boolean

Checks if the helper has a container

hasContainer() : boolean
Inherited

Implements \HelperInterface::hasContainer().

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

Returns

boolean

Checks if the helper has an ACL role

hasRole() : boolean
Inherited

Implements \HelperInterface::hasRole().

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

Returns

boolean

Checks if the helper has a translator

hasTranslator() : boolean
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::hasTranslator()

Returns

boolean

Returns an HTML string containing an 'a' element for the given page

htmlify(\Zend\Navigation\Page\AbstractPage $page) : string
Inherited

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to generate HTML for

Returns

stringHTML string (Label)

Returns whether translator is enabled and should be used

isTranslatorEnabled() : boolean
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::isTranslatorEnabled()

Returns

boolean

Renders helper

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

Parameters

$container

\Zend\Navigation\AbstractContainer

Exceptions

\Zend\View\Exception\RuntimeException

Returns

string

Sets ACL to use when iterating pages

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

Implements \HelperInterface::setAcl().

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

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

ACL object.

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Sets navigation container the helper operates on by default

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

Implements \HelperInterface::setContainer().

inherited_from \Zend\View\Helper\Navigation\HelperInterface::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 = null) : void
InheritedStatic

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

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

Sets the default proxy to use in {@link render()}

setDefaultProxy(string $proxy) : \Zend\View\Helper\Navigation

Parameters

$proxy

string

default proxy

Returns

\Zend\View\Helper\Navigation

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

setDefaultRole(mixed $role = null) : void
InheritedStatic

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\EventManager\EventManagerAwareInterface::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|integer $indent) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Parameters

$indent

stringinteger

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Sets whether ACL should be injected when proxying

setInjectAcl(boolean $injectAcl = true) : \Zend\View\Helper\Navigation

Parameters

$injectAcl

boolean

Returns

\Zend\View\Helper\Navigation

Sets whether container should be injected when proxying

setInjectContainer(boolean $injectContainer = true) : \Zend\View\Helper\Navigation

Parameters

$injectContainer

boolean

Returns

\Zend\View\Helper\Navigation

Sets whether translator should be injected when proxying

setInjectTranslator(boolean $injectTranslator = true) : \Zend\View\Helper\Navigation

Parameters

$injectTranslator

boolean

Returns

\Zend\View\Helper\Navigation

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

setMaxDepth(integer $maxDepth = null) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Parameters

$maxDepth

integer

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(integer $minDepth = null) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Parameters

$minDepth

integer

Default is null, which sets no minimum depth.

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Set manager for retrieving navigation helpers

setPluginManager(\Zend\View\Helper\Navigation\PluginManager $plugins) : \Zend\View\Helper\Navigation

Parameters

$plugins

\Zend\View\Helper\Navigation\PluginManager

Returns

\Zend\View\Helper\Navigation

Render invisible items?

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

Parameters

$renderInvisible

boolean

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Sets ACL role(s) to use when iterating pages

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

Implements \HelperInterface::setRole().

inherited_from \Zend\View\Helper\Navigation\HelperInterface::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\ServiceManager\ServiceLocatorAwareInterface::setServiceLocator()

Parameters

$serviceLocator

\Zend\ServiceManager\ServiceLocatorInterface

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator = null, string $textDomain = null) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::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(boolean $enabled = true) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorEnabled()

Parameters

$enabled

boolean

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Set translation text domain

setTranslatorTextDomain(string $textDomain = 'default') : \Zend\View\Helper\Navigation\AbstractHelper
Inherited
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Sets whether ACL should be used

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

Implements \HelperInterface::setUseAcl().

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

Parameters

$useAcl

boolean

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\Navigation
fluent This method is part of a fluent interface and will return the same instance

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\Navigation

Set the View object

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

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

Retrieve whitespace representation of $indent

getWhitespace(integer|string $indent) : string
Inherited

Parameters

$indent

integerstring

Returns

string

Converts an associative array to a string of tag attributes.

htmlAttribs(array $attribs) : string
Inherited
access public

Parameters

$attribs

array

From this array, each key-value pair is converted to an attribute name and value.

Returns

stringThe XHTML for the attributes.

Injects container, ACL, and translator to the given $helper if this helper is configured to do so

inject(\Zend\View\Helper\Navigation\HelperInterface $helper) : void

Parameters

$helper

\Zend\View\Helper\Navigation\HelperInterface

helper instance

Determines whether a page should be allowed given certain parameters

isAllowed(array $params) : boolean
Inherited

Parameters

$params

array

Returns

boolean

Is doctype XHTML?

isXhtml() : boolean
Inherited

Returns

boolean

Normalize an ID

normalizeId(string $value) : string
Inherited

Parameters

$value

string

Returns

string

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

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

Parameters

$container

\Zend\Navigation\AbstractContainerstringnull

Exceptions

\Zend\View\Exception\InvalidArgumentException

Attaches default ACL listeners, if ACLs are in use

setDefaultListeners() 
Inherited

Translate a message (for label, title, …)

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

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

Default

 

The tag closing bracket

$closingBracket : string

Default

null
 

AbstractContainer to operate on by default

$container : \Zend\Navigation\AbstractContainer

Default

 

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

$defaultAcl : \Zend\Permissions\Acl\AclInterface

Default

Static
 

Default proxy to use in {@link render()}

$defaultProxy : string

Default

'menu'
 

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

Default

Static
 

$events

$events : \Zend\EventManager\EventManagerInterface

Default

 

Indentation string

$indent : string

Default

''
 

Whether ACL should be injected when proxying

$injectAcl : boolean

Default

true
 

Whether container should be injected when proxying

$injectContainer : boolean

Default

true
 

Whether translator should be injected when proxying

$injectTranslator : boolean

Default

true
 

Indicates whether or not a given helper has been injected

$injected : array

Default

array()
 

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

$maxDepth : integer

Default

 

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

$minDepth : integer

Default

 

$plugins

$plugins : \Zend\View\Helper\Navigation\PluginManager

Default

 

Whether invisible items should be rendered by this helper

$renderInvisible : boolean

Default

false
 

ACL role to use when iterating pages

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

Default

 

$serviceLocator

$serviceLocator : \Zend\ServiceManager\ServiceLocatorInterface

Default

 

Translator (optional)

$translator : \Zend\I18n\Translator\TranslatorInterface

Default

 

Whether translator should be used

$translatorEnabled : boolean

Default

true
 

Translator text domain (optional)

$translatorTextDomain : string

Default

'default'
 

Whether ACL should be used for filtering out pages

$useAcl : boolean

Default

true
 

View object instance

$view : \Zend\View\Renderer\RendererInterface

Default

null

 Constants

 

EOL character

EOL = PHP_EOL 
deprecated just use PHP_EOL
 

View helper namespace

NS = 'Zend\View\Helper\Navigation' : string