Base class for navigational helpers

package Default
inherited_from \Zend\View\Helper\AbstractHtmlElement

 Methods

Magic overload: Proxy calls to the navigation container

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

Parameters

$method

string

method name in container

$arguments

array

rguments to pass

Exceptions

\Zend\Navigation\Exception\ExceptionInterface

Returns

mixed

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

__toString() : string

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

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

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 ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}

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

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

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

Get the event manager.

getEventManager() : \Zend\EventManager\EventManagerInterface

Returns

\Zend\EventManager\EventManagerInterface

Returns indentation

getIndent() : string

Returns

string

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

getMaxDepth() : integer | null

Returns

integernull

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

getMinDepth() : integer | null

Returns

integernull

Return renderInvisible flag

getRenderInvisible() : boolean
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

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_from \Zend\ServiceManager\ServiceLocatorAwareInterface::getServiceLocator()

Returns

\Zend\ServiceManager\ServiceLocatorInterface

Returns translator used in helper

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

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

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

Returns

string

Returns whether ACL should be used

getUseAcl() : boolean

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

Implements \HelperInterface::hasAcl().

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

Returns

boolean

Checks if the helper has a container

hasContainer() : boolean

Implements \HelperInterface::hasContainer().

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

Returns

boolean

Checks if the helper has an ACL role

hasRole() : boolean

Implements \HelperInterface::hasRole().

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

Returns

boolean

Checks if the helper has a translator

hasTranslator() : boolean
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

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_from \Zend\I18n\Translator\TranslatorAwareInterface::isTranslatorEnabled()

Returns

boolean

Sets ACL to use when iterating pages

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

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

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
Static

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 = null) : void
Static

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_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

Parameters

$indent

stringinteger

Returns

\Zend\View\Helper\Navigation\AbstractHelper

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

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

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

Parameters

$minDepth

integer

Default is null, which sets no minimum depth.

Returns

\Zend\View\Helper\Navigation\AbstractHelper

Render invisible items?

setRenderInvisible(boolean $renderInvisible = true) : \Zend\View\Helper\Navigation\AbstractHelper
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

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_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_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_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_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

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\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

Parameters

$indent

integerstring

Returns

string

Converts an associative array to a string of tag attributes.

htmlAttribs(array $attribs) : string
inherited_from \Zend\View\Helper\AbstractHtmlElement::htmlAttribs()

Parameters

$attribs

array

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

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.

Determines whether a page should be allowed given certain parameters

isAllowed(array $params) : boolean

Parameters

$params

array

Returns

boolean

Is doctype XHTML?

isXhtml() : boolean
Inherited

Returns

boolean

Normalize an ID

normalizeId(string $value) : string
inherited_from \Zend\View\Helper\AbstractHtmlElement::normalizeId()

Parameters

$value

string

Returns

string

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

Parameters

$container

\Zend\Navigation\AbstractContainerstringnull

Exceptions

\Zend\View\Exception\InvalidArgumentException

Attaches default ACL listeners, if ACLs are in use

setDefaultListeners() 

Translate a message (for label, title, …)

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

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 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

''
 

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

 

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