View/Helper/Navigation/Menu.php

Show:

inherited

Classes
- \Zend_View_Helper_Navigation_Menu

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_View
Subpackage: Helper
Version: $Id: Menu.php 25239 2013-01-22 09:45:01Z frosch $

\Zend_View_Helper_Navigation_Menu
jump to top

Package: Zend\View\Helper

Helper for rendering menus from navigation containers

Parent(s): \Zend_View_Helper_Navigation_HelperAbstract < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                EOL
                = "\n"

inherited

EOL character

Inherited from: \Zend_View_Helper_HtmlElement::EOL \Zend_View_Helper_Navigation_HelperAbstract::EOL

Inherited_from: \Zend_View_Helper_HtmlElement::EOL
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::EOL

Properties

\Zend_Acl $_acl =

inherited

ACL to use when iterating pages

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_acl

Details

Type: \Zend_Acl
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_acl

string $_activeClass = 'active'

CSS class to use for the active elements

Default value'active'Details

Type: string

bool $_addPageClassToLi = false

Adds CSS class from page to li element

Default valuefalseDetails

Type: bool

string $_closingBracket = null

inherited

The tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::$$_closingBracket \Zend_View_Helper_Navigation_HelperAbstract::$$_closingBracket

Default valuenullDetails

Type: string
Inherited_from: \Zend_View_Helper_HtmlElement::$$_closingBracket
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_closingBracket

\Zend_Navigation_Container $_container =

inherited

Container to operate on by default

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_container

Details

Type: \Zend_Navigation_Container
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_container

\Zend_Acl $_defaultAcl =

staticinherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_defaultAcl

Details

Type: \Zend_Acl
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_defaultAcl

string|\Zend_Acl_Role_Interface $_defaultRole =

staticinherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_defaultRole

Details

Type: string | \Zend_Acl_Role_Interface
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_defaultRole

bool $_expandSiblingNodesOfActiveBranch = false

Expand all sibling nodes of active branch nodes

Default valuefalseDetails

Type: bool

bool $_formatOutput = true

inherited

Whether HTML/XML output should be formatted

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_formatOutput

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_formatOutput

string $_indent = ''

inherited

Indentation string

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_indent

Default value''Details

Type: string
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_indent

string $_innerIndent = ' '

Inner indentation string

Default value' 'Details

Type: string

int $_maxDepth =

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_maxDepth

Details

Type: int
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_maxDepth

int $_minDepth =

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_minDepth

Details

Type: int
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_minDepth

bool $_onlyActiveBranch = false

Whether only active branch should be rendered

Default valuefalseDetails

Type: bool

string $_parentClass = 'menu-parent'

CSS class to use for the parent li element

Default value'menu-parent'Details

Type: string

string|array $_partial = null

Partial view script to use for rendering menu

Default valuenullDetails

Type: string | array

string|null $_prefixForId = null

inherited

Prefix for IDs when they are normalized

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_prefixForId

Default valuenullDetails

Type: string | null
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_prefixForId

bool $_renderInvisible = false

inherited

Wheter invisible items should be rendered by this helper

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_renderInvisible

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_renderInvisible

bool $_renderParentClass = false

Whether parent li elements should be rendered with parent class

Default valuefalseDetails

Type: bool

bool $_renderParents = true

Whether parents should be rendered when only rendering active branch

Default valuetrueDetails

Type: bool

string|\Zend_Acl_Role_Interface $_role =

inherited

ACL role to use when iterating pages

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_role

Details

Type: string | \Zend_Acl_Role_Interface
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_role

bool $_skipPrefixForId = false

inherited

Skip current prefix for IDs when they are normalized (flag)

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_skipPrefixForId

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_skipPrefixForId

\Zend_Translate_Adapter $_translator =

inherited

Translator

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_translator

Details

Type: \Zend_Translate_Adapter
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_translator

string $_ulClass = 'navigation'

CSS class to use for the ul element

Default value'navigation'Details

Type: string

string $_ulId = null

Unique identifier (id) for the ul element

Default valuenullDetails

Type: string

bool $_useAcl = true

inherited

Whether ACL should be used for filtering out pages

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_useAcl

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_useAcl

bool $_useTranslator = true

inherited

Whether translator should be used for page labels and titles

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::$$_useTranslator

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$_useTranslator

\Zend_View_Interface $view = null

inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view \Zend_View_Helper_HtmlElement::$$view \Zend_View_Helper_Navigation_HelperAbstract::$$view

Default valuenullDetails

Type: \Zend_View_Interface
Inherited_from: \Zend_View_Helper_Abstract::$$view
Inherited_from: \Zend_View_Helper_HtmlElement::$$view
Inherited_from: \Zend_View_Helper_Navigation_HelperAbstract::$$view

Methods

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

inherited

Magic overload: Proxy calls to the navigation container

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::__call()

Parameters

Name	Type	Description
$method	string	method name in container
$arguments	array	[optional] arguments to pass

Returns

Type	Description
mixed	returns what the container returns

Throws

Exception	Description
\Zend_Navigation_Exception	if method does not exist in container

__toString() : string

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::__toString()

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

Implements Zend_View_Helper_Navigation_Helper::__toString().

Returns

Type	Description
string

_acceptAcl(\Zend_Navigation_Page $page) : bool

inherited

Determines whether a page should be accepted by ACL when iterating

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::_acceptAcl()

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

Parameters

Name	Type	Description
$page	\Zend_Navigation_Page	page to check

Returns

Type	Description
bool	whether page is accepted by ACL

_getWhitespace(int | string $indent) : string

inherited

Retrieve whitespace representation of $indent

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::_getWhitespace()

Parameters

Name	Type	Description
$indent	int \| string

Returns

Type	Description
string

_htmlAttribs(array $attribs) : string

inherited

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::_htmlAttribs()

Overloads Zend_View_Helper_HtmlElement::_htmlAttribs().

Parameters

Name	Type	Description
$attribs	array	an array where each key-value pair is converted to an attribute name and value

Returns

Type	Description
string	an attribute string

_isStrictDoctype() : boolean

inherited

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()\Zend_View_Helper_Navigation_HelperAbstract::_isStrictDoctype()

Returns

Type	Description
boolean

_isXhtml() : boolean

inherited

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()\Zend_View_Helper_Navigation_HelperAbstract::_isXhtml()

Returns

Type	Description
boolean

_normalizeId(string $value) : string

inherited

Normalize an ID

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::_normalizeId()

Extends Zend_View_Helper_HtmlElement::_normalizeId().

Parameters

Name	Type	Description
$value	string	ID

Returns

Type	Description
string	Normalized ID

_normalizeOptions(array $options = array()) : array

Normalizes given render options

Parameters

Name	Type	Description
$options	array	[optional] options to normalize

Returns

Type	Description
array	normalized options

_renderDeepestMenu(\Zend_Navigation_Container $container, string $ulClass, string $indent, string $innerIndent, int | null $minDepth, int | null $maxDepth, string | null $ulId, bool $addPageClassToLi, string | null $activeClass, string $parentClass, bool $renderParentClass) : string

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

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	container to render
$ulClass	string	CSS class for first UL
$indent	string	initial indentation
$innerIndent	string	inner indentation
$minDepth	int \| null	minimum depth
$maxDepth	int \| null	maximum depth
$ulId	string \| null	unique identifier (id) for first UL
$addPageClassToLi	bool	adds CSS class from page to li element
$activeClass	string \| null	CSS class for active element
$parentClass	string	CSS class for parent li's
$renderParentClass	bool	Render parent class?

Returns

Type	Description
string	rendered menu (HTML)

_renderMenu(\Zend_Navigation_Container $container, string $ulClass, string $indent, string $innerIndent, int | null $minDepth, int | null $maxDepth, bool $onlyActive, bool $expandSibs, string | null $ulId, bool $addPageClassToLi, string | null $activeClass, string $parentClass, bool $renderParentClass) : string

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

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	container to render
$ulClass	string	CSS class for first UL
$indent	string	initial indentation
$innerIndent	string	inner indentation
$minDepth	int \| null	minimum depth
$maxDepth	int \| null	maximum depth
$onlyActive	bool	render only active branch?
$expandSibs	bool	render siblings of active branch nodes?
$ulId	string \| null	unique identifier (id) for first UL
$addPageClassToLi	bool	adds CSS class from page to li element
$activeClass	string \| null	CSS class for active element
$parentClass	string	CSS class for parent li's
$renderParentClass	bool	Render parent class?

Returns

Type	Description
string	rendered menu (HTML)

accept(\Zend_Navigation_Page $page, bool $recursive = true) : bool

inherited

Determines whether a page should be accepted when iterating

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::accept()

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.

Parameters

Name	Type	Description
$page	\Zend_Navigation_Page	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

Type	Description
bool	whether page should be accepted

addPageClassToLi(bool $flag = true) : \Zend_View_Helper_Navigation_Menu

Adds CSS class from page to li element

Before:

Bar

After:

Bar

Parameters

Name	Type	Description
$flag	bool	[optional] adds CSS class from page to li element

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

direct() : void

inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_HtmlElement::direct()\Zend_View_Helper_Navigation_HelperAbstract::direct()

findActive(\Zend_Navigation_Container $container, int | null | int | null $minDepth = null, $maxDepth = -1) : array

inherited

Finds the deepest active page in the given container

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::findActive()

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	container to search
$minDepth	int \| null \| int \| null	[optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required.
$maxDepth

Returns

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

getAcl() : \Zend_Acl | null

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getAcl()

Implements Zend_View_Helper_Navigation_Helper::getAcl().

Returns

Type	Description
\Zend_Acl \| null	ACL object or null

getActiveClass() : string

Returns CSS class to use for the active elements when rendering

Returns

Type	Description
string	CSS class

getAddPageClassToLi() : bool

Returns a flag indicating whether the CSS class from page to be added to li element

Returns

Type	Description
bool

getClosingBracket() : string

inherited

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()\Zend_View_Helper_Navigation_HelperAbstract::getClosingBracket()

Returns

Type	Description
string

getContainer() : \Zend_Navigation_Container

inherited

Returns the navigation container helper operates on by default

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getContainer()

Implements Zend_View_Helper_Navigation_Interface::getContainer().

If a helper is not explicitly set in this helper instance by calling setContainer() or by passing it through the helper entry point, this method will look in Zend_Registry for a container by using the key 'Zend_Navigation'.

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

Returns

Type	Description
\Zend_Navigation_Container	navigation container

getEOL() : string

inherited

Returns the EOL character (format output is respected)

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getEOL()

Returns

Type	Description
string	standard EOL charater or an empty string

Details

See: \global\self::EOL
See: \global\getFormatOutput()

getExpandSiblingNodesOfActiveBranch() : bool

Returns a flag indicating whether to expand all sibling nodes of the active branch

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

Returns

Type	Description
bool	whether siblings of nodes in the active branch should be expanded

getFormatOutput() : bool

inherited

Returns whether HTML/XML output should be formatted

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getFormatOutput()

Returns

Type	Description
bool	whether HTML/XML output should be formatted

getIndent() : string

inherited

Returns indentation (format output is respected)

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getIndent()

Returns

Type	Description
string	indentation string or an empty string

getInnerIndent() : string

Returns inner indentation (format output is respected)

Returns

Type	Description
string	indentation string or an empty string

Details

See: \global\getFormatOutput()

getMaxDepth() : int | null

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getMaxDepth()

Returns

Type	Description
int \| null	maximum depth or null

getMinDepth() : int | null

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getMinDepth()

Returns

Type	Description
int \| null	minimum depth or null

getOnlyActiveBranch() : bool

Returns a flag indicating whether only active branch should be rendered

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

Returns

Type	Description
bool	whether only active branch should be rendered

getParentClass() : string

Returns CSS class to use for the parent lie elements when rendering

Returns

Type	Description
string	CSS class

getPartial() : string | array | null

Returns partial view script to use for rendering menu

Returns

Type	Description
string \| array \| null

getPrefixForId() : string

inherited

Returns prefix for IDs when they are normalized

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getPrefixForId()

Returns

Type	Description
string	Prefix for

getRenderInvisible() : bool

inherited

Return renderInvisible flag

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getRenderInvisible()

Returns

Type	Description
bool

getRenderParentClass() : bool

Returns flag indicating whether parent class should be rendered to the li element

Returns

Type	Description
bool	whether parent class should be rendered

getRenderParents() : bool

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

By default, this value is true.

Returns

Type	Description
bool	whether parents should be rendered

getRole() : string | \Zend_Acl_Role_Interface | null

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getRole()

Implements Zend_View_Helper_Navigation_Helper::getRole().

Returns

Type	Description
string \| \Zend_Acl_Role_Interface \| null	role or null

getTranslator() : \Zend_Translate_Adapter | null

inherited

Returns translator used in helper

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getTranslator()

Implements Zend_View_Helper_Navigation_Helper::getTranslator().

Returns

Type	Description
\Zend_Translate_Adapter \| null	translator or null

getUlClass() : string

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

Returns

Type	Description
string	CSS class

getUlId() : string | null

Returns unique identifier (id) to use for the first 'ul' element when rendering

Returns

Type	Description
string \| null	Unique identifier (id); Default is 'null'

getUseAcl() : bool

inherited

Returns whether ACL should be used

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getUseAcl()

Implements Zend_View_Helper_Navigation_Helper::getUseAcl().

Returns

Type	Description
bool	whether ACL should be used

getUseTranslator() : bool

inherited

Returns whether translator should be used

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::getUseTranslator()

Implements Zend_View_Helper_Navigation_Helper::getUseTranslator().

Returns

Type	Description
bool	whether translator should be used

hasAcl() : bool

inherited

Checks if the helper has an ACL instance

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::hasAcl()

Implements Zend_View_Helper_Navigation_Helper::hasAcl().

Returns

Type	Description
bool	whether the helper has a an ACL instance or not

hasContainer() : bool

inherited

Checks if the helper has a container

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::hasContainer()

Implements Zend_View_Helper_Navigation_Helper::hasContainer().

Returns

Type	Description
bool	whether the helper has a container or not

hasRole() : bool

inherited

Checks if the helper has an ACL role

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::hasRole()

Implements Zend_View_Helper_Navigation_Helper::hasRole().

Returns

Type	Description
bool	whether the helper has a an ACL role or not

hasTranslator() : bool

inherited

Checks if the helper has a translator

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::hasTranslator()

Implements Zend_View_Helper_Navigation_Helper::hasTranslator().

Returns

Type	Description
bool	whether the helper has a translator or not

htmlify(\Zend_Navigation_Page $page) : string

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

Overrides Zend_View_Helper_Navigation_Abstract::htmlify().

Parameters

Name	Type	Description
$page	\Zend_Navigation_Page	page to generate HTML for

Returns

Type	Description
string	HTML string for the given page

menu(\Zend_Navigation_Container $container = null) : \Zend_View_Helper_Navigation_Menu

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

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to operate on

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

render(\Zend_Navigation_Container $container = null) : string

Renders menu

Implements Zend_View_Helper_Navigation_Helper::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.

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to render. Default is to render the container registered in the helper.

Returns

Type	Description
string	helper output

Throws

Exception	Description
\Zend_View_Exception	if unable to render

Details

See: \global\renderPartial()
See: \global\renderMenu()

renderMenu(\Zend_Navigation_Container $container = null, array $options = array()) : string

Renders helper

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

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to create menu from. Default is to use the container retrieved from {@link getContainer()}.
$options	array	[optional] options for controlling rendering

Returns

Type	Description
string	rendered menu

renderPartial(\Zend_Navigation_Container $container = null, string | array $partial = null) : string

Renders the given $container by invoking the partial view helper

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

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to pass to view script. Default is to use the container registered in the helper.
$partial	string \| array	[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.

Returns

Type	Description
string	helper output

Throws

Exception	Description
\Zend_View_Exception	When no partial script is set

renderSubMenu(\Zend_Navigation_Container $container = null, string | null $ulClass = null, string | int $indent = null, string | null $ulId = null, bool $addPageClassToLi = false, string | int $innerIndent = null) : string

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

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

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to render. Default is to render the container registered in the helper.
$ulClass	string \| null	[optional] CSS class to use for UL element. Default is to use the value from {@link getUlClass()}.
$indent	string \| int	[optional] indentation as a string or number of spaces. Default is to use the value retrieved from {@link getIndent()}.
$ulId	string \| null	[optional] Unique identifier (id) use for UL element
$addPageClassToLi	bool	adds CSS class from page to li element
$innerIndent	string \| int	[optional] inner indentation as a string or number of spaces. Default is to use the {@link getInnerIndent()}.

Returns

Type	Description
string	rendered content

setAcl(\Zend_Acl $acl = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets ACL to use when iterating pages

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setAcl()

Implements Zend_View_Helper_Navigation_Helper::setAcl().

Parameters

Name	Type	Description
$acl	\Zend_Acl	[optional] ACL object. Default is null.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setActiveClass(string $activeClass) : \Zend_View_Helper_Navigation_Menu

Sets CSS class to use for the active elements when rendering

Parameters

Name	Type	Description
$activeClass	string	CSS class to set

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setContainer(\Zend_Navigation_Container $container = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets navigation container the helper operates on by default

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setContainer()

Implements Zend_View_Helper_Navigation_Interface::setContainer().

Parameters

Name	Type	Description
$container	\Zend_Navigation_Container	[optional] container to operate on. Default is null, meaning container will be reset.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setDefaultAcl(\Zend_Acl $acl = null) : void

staticinherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl()

Parameters

Name	Type	Description
$acl	\Zend_Acl	[optional] ACL object. Default is null, which sets no ACL object.

setDefaultRole(\midex $role = null) : void

staticinherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole()

Parameters

Name	Type	Description
$role	\midex	[optional] role to set. Expects null, string, or an instance of {@link Zend_Acl_Role_Interface}. Default is null, which sets no default role.

Throws

Exception	Description
\Zend_View_Exception	if role is invalid

setExpandSiblingNodesOfActiveBranch(bool $flag = true) : \Zend_View_Helper_Navigation_Menu

Sets a flag indicating whether to expand all sibling nodes of the active branch

Parameters

Name	Type	Description
$flag	bool	[optional] expand all siblings of nodes in the active branch. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setFormatOutput(bool $formatOutput = true) : \Zend_View_Helper_Navigation_Sitemap

inherited

Sets whether HTML/XML output should be formatted

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setFormatOutput()

Parameters

Name	Type	Description
$formatOutput	bool	[optional] whether output should be formatted. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_Sitemap	fluent interface, returns self

setIndent(string | int $indent) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setIndent()

Parameters

Name	Type	Description
$indent	string \| int	indentation string or number of spaces

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setInnerIndent(string | int $indent) : \Zend_View_Helper_Navigation_HelperAbstract

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

Parameters

Name	Type	Description
$indent	string \| int	indentation string or number of spaces

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setMaxDepth(int $maxDepth = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setMaxDepth()

Parameters

Name	Type	Description
$maxDepth	int	[optional] maximum depth. Default is null, which sets no maximum depth.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setMinDepth(int $minDepth = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

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

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setMinDepth()

Parameters

Name	Type	Description
$minDepth	int	[optional] minimum depth. Default is null, which sets no minimum depth.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setOnlyActiveBranch(bool $flag = true) : \Zend_View_Helper_Navigation_Menu

Sets a flag indicating whether only active branch should be rendered

Parameters

Name	Type	Description
$flag	bool	[optional] render only active branch. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setParentClass(string $parentClass) : \Zend_View_Helper_Navigation_Menu

Sets CSS class to use for the parent li elements when rendering

Parameters

Name	Type	Description
$parentClass	string	CSS class to set to parents

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setPartial(string | array $partial) : \Zend_View_Helper_Navigation_Menu

Sets which partial view script to use for rendering menu

Parameters

Name	Type	Description
$partial	string \| array	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

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setPrefixForId(string $prefix) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets prefix for IDs when they are normalized

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setPrefixForId()

Parameters

Name	Type	Description
$prefix	string	Prefix for IDs

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setRenderInvisible(bool $renderInvisible = true) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Render invisible items?

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setRenderInvisible()

Parameters

Name	Type	Description
$renderInvisible	bool	[optional] boolean flag

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface returns self

setRenderParentClass(bool $flag = true) : \Zend_View_Helper_Navigation_Menu

Enables/disables rendering of parent class to the li element

Parameters

Name	Type	Description
$flag	bool	[optional] render with parent class. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setRenderParents(bool $flag = true) : \Zend_View_Helper_Navigation_Menu

Enables/disables rendering of parents when only rendering active branch

See setOnlyActiveBranch() for more information.

Parameters

Name	Type	Description
$flag	bool	[optional] render parents when rendering active branch. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setRole(mixed $role = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets ACL role(s) to use when iterating pages

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setRole()

Implements Zend_View_Helper_Navigation_Helper::setRole().

Parameters

Name	Type	Description
$role	mixed	[optional] role to set. Expects a string, an instance of type {@link Zend_Acl_Role_Interface}, or null. Default is null, which will set no role.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

Throws

Exception	Description
\Zend_View_Exception	if $role is invalid

setTranslator(mixed $translator = null) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets translator to use in helper

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setTranslator()

Implements Zend_View_Helper_Navigation_Helper::setTranslator().

Parameters

Name	Type	Description
$translator	mixed	[optional] translator. Expects an object of type {@link Zend_Translate_Adapter} or {@link Zend_Translate}, or null. Default is null, which sets no translator.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setUlClass(string $ulClass) : \Zend_View_Helper_Navigation_Menu

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

Parameters

Name	Type	Description
$ulClass	string	CSS class to set

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setUlId(string | null $ulId) : \Zend_View_Helper_Navigation_Menu

Sets unique identifier (id) to use for the first 'ul' element when rendering

Parameters

Name	Type	Description
$ulId	string \| null	Unique identifier (id) to set

Returns

Type	Description
\Zend_View_Helper_Navigation_Menu	fluent interface, returns self

setUseAcl(bool $useAcl = true) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets whether ACL should be used

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setUseAcl()

Implements Zend_View_Helper_Navigation_Helper::setUseAcl().

Parameters

Name	Type	Description
$useAcl	bool	[optional] whether ACL should be used. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setUseTranslator(bool $useTranslator = true) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Sets whether translator should be used

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::setUseTranslator()

Implements Zend_View_Helper_Navigation_Helper::setUseTranslator().

Parameters

Name	Type	Description
$useTranslator	bool	[optional] whether translator should be used. Default is true.

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract

inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_HtmlElement::setView()\Zend_View_Helper_Navigation_HelperAbstract::setView()

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_View_Helper_Abstract

skipPrefixForId(bool $flag = true) : \Zend_View_Helper_Navigation_HelperAbstract

inherited

Skip the current prefix for IDs when they are normalized

Inherited from: \Zend_View_Helper_Navigation_HelperAbstract::skipPrefixForId()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_View_Helper_Navigation_HelperAbstract	fluent interface, returns self

View/Helper/Navigation/Menu.php

\Zend_View_Helper_Navigation_Menujump to top

Constants

Properties

Methods

\Zend_View_Helper_Navigation_Menu
jump to top