Docs For Class Zend_View_Helper_Navigation

Description

Helper for printing breadcrumbs

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /View/Helper/Navigation/Breadcrumbs.php (line 37)

Zend_View_Helper_Abstract
   |
   --Zend_View_Helper_HtmlElement
      |
      --Zend_View_Helper_Navigation_HelperAbstract
         |
         --Zend_View_Helper_Navigation_Breadcrumbs

Variable Summary

bool $_linkLast

int $_minDepth

string|array $_partial

string $_separator

Method Summary

Zend_View_Helper_Navigation_Breadcrumbs breadcrumbs ([ $container = null])

bool getLinkLast ()

string|array|null getPartial ()

string getSeparator ()

string render ([ $container = null])

string renderPartial ([ $container = null], [string|array $partial = null])

string renderStraight ([ $container = null])

Zend_View_Helper_Navigation_Breadcrumbs setLinkLast (bool $linkLast)

Zend_View_Helper_Navigation_Breadcrumbs setPartial (string|array $partial)

Zend_View_Helper_Navigation_Breadcrumbs setSeparator (string $separator)

Variables

bool $_linkLast = false (line 59)

Whether last page in breadcrumb should be hyperlinked

access: protected

int $_minDepth = 1 (line 52)

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

access: protected

Redefinition of:

Zend_View_Helper_Navigation_HelperAbstract::$_minDepth: The minimum depth a page must have to be included when rendering

string|array $_partial (line 66)

Partial view script to use for rendering menu

access: protected

string $_separator = ' > ' (line 45)

Breadcrumbs separator string

access: protected

Inherited Variables

Inherited from Zend_View_Helper_Navigation_HelperAbstract

Zend_View_Helper_Navigation_HelperAbstract::$_acl
Zend_View_Helper_Navigation_HelperAbstract::$_container
Zend_View_Helper_Navigation_HelperAbstract::$_defaultAcl
Zend_View_Helper_Navigation_HelperAbstract::$_defaultRole
Zend_View_Helper_Navigation_HelperAbstract::$_indent
Zend_View_Helper_Navigation_HelperAbstract::$_maxDepth
Zend_View_Helper_Navigation_HelperAbstract::$_renderInvisible
Zend_View_Helper_Navigation_HelperAbstract::$_role
Zend_View_Helper_Navigation_HelperAbstract::$_translator
Zend_View_Helper_Navigation_HelperAbstract::$_useAcl
Zend_View_Helper_Navigation_HelperAbstract::$_useTranslator

Inherited from Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::$_closingBracket

Inherited from Zend_View_Helper_Abstract

Zend_View_Helper_Abstract::$view

Methods

breadcrumbs (line 77)

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

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Breadcrumbs breadcrumbs ([ $container = null])

Zend_Navigation_Container $container: [optional] container to operate on

getLinkLast (line 133)

Returns whether last page in breadcrumbs should be hyperlinked

return: whether last page in breadcrumbs should be hyperlinked
access: public

bool getLinkLast ()

getPartial (line 166)

Returns partial view script to use for rendering menu

access: public

string|array|null getPartial ()

getSeparator (line 109)

Returns breadcrumb separator

return: breadcrumb separator
access: public

string getSeparator ()

render (line 323)

Renders helper

Implements Zend_View_Helper_Navigation_Helper::render().

return: helper output
access: public

string render ([ $container = null])

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

renderPartial (line 250)

Renders the given $container by invoking the partial view helper

The container will simply be passed on as a model to the view script, so in the script it will be available in

$this->container

.

return: helper output
access: public

string renderPartial ([ $container = null], [string|array $partial = null])

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

renderStraight (line 183)

Renders breadcrumbs by chaining 'a' elements with the separator registered in the helper

return: helper output
access: public

string renderStraight ([ $container = null])

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

setLinkLast (line 122)

Sets whether last page in breadcrumbs should be hyperlinked

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Breadcrumbs setLinkLast (bool $linkLast)

bool $linkLast: whether last page should be hyperlinked

setPartial (line 152)

Sets which partial view script to use for rendering menu

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Breadcrumbs setPartial (string|array $partial)

string|array $partial: 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.

setSeparator (line 95)

Sets breadcrumb separator

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Breadcrumbs setSeparator (string $separator)

string $separator: separator string

Inherited Methods

Inherited From Zend_View_Helper_Navigation_HelperAbstract

Zend_View_Helper_Navigation_HelperAbstract::accept()
Zend_View_Helper_Navigation_HelperAbstract::findActive()
Zend_View_Helper_Navigation_HelperAbstract::getAcl()
Zend_View_Helper_Navigation_HelperAbstract::getContainer()
Zend_View_Helper_Navigation_HelperAbstract::getIndent()
Zend_View_Helper_Navigation_HelperAbstract::getMaxDepth()
Zend_View_Helper_Navigation_HelperAbstract::getMinDepth()
Zend_View_Helper_Navigation_HelperAbstract::getRenderInvisible()
Zend_View_Helper_Navigation_HelperAbstract::getRole()
Zend_View_Helper_Navigation_HelperAbstract::getTranslator()
Zend_View_Helper_Navigation_HelperAbstract::getUseAcl()
Zend_View_Helper_Navigation_HelperAbstract::getUseTranslator()
Zend_View_Helper_Navigation_HelperAbstract::hasAcl()
Zend_View_Helper_Navigation_HelperAbstract::hasContainer()
Zend_View_Helper_Navigation_HelperAbstract::hasRole()
Zend_View_Helper_Navigation_HelperAbstract::hasTranslator()
Zend_View_Helper_Navigation_HelperAbstract::htmlify()
Zend_View_Helper_Navigation_HelperAbstract::setAcl()
Zend_View_Helper_Navigation_HelperAbstract::setContainer()
Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl()
Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole()
Zend_View_Helper_Navigation_HelperAbstract::setIndent()
Zend_View_Helper_Navigation_HelperAbstract::setMaxDepth()
Zend_View_Helper_Navigation_HelperAbstract::setMinDepth()
Zend_View_Helper_Navigation_HelperAbstract::setRenderInvisible()
Zend_View_Helper_Navigation_HelperAbstract::setRole()
Zend_View_Helper_Navigation_HelperAbstract::setTranslator()
Zend_View_Helper_Navigation_HelperAbstract::setUseAcl()
Zend_View_Helper_Navigation_HelperAbstract::setUseTranslator()
Zend_View_Helper_Navigation_HelperAbstract::_acceptAcl()
Zend_View_Helper_Navigation_HelperAbstract::_getWhitespace()
Zend_View_Helper_Navigation_HelperAbstract::_htmlAttribs()
Zend_View_Helper_Navigation_HelperAbstract::_normalizeId()
Zend_View_Helper_Navigation_HelperAbstract::__call()
Zend_View_Helper_Navigation_HelperAbstract::__toString()

Inherited From Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::getClosingBracket()
Zend_View_Helper_HtmlElement::_htmlAttribs()
Zend_View_Helper_HtmlElement::_isXhtml()
Zend_View_Helper_HtmlElement::_normalizeId()

Inherited From Zend_View_Helper_Abstract

Zend_View_Helper_Abstract::direct()
Zend_View_Helper_Abstract::setView()

Class Constants

Inherited Constants

Inherited from Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::EOL