View/Helper/Navigation/Breadcrumbs.php

Show: PublicProtectedPrivateinherited
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 license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id$  

\Zend_View_Helper_Navigation_Breadcrumbs
jump to top

Package: Zend_View\Helper
Helper for printing breadcrumbs
Parent(s)
\Zend_View_Helper_Navigation_HelperAbstract < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedbool $_linkLast = false
Whether last page in breadcrumb should be hyperlinked
Default valuefalseDetails
Type
bool
>VPropertyprotectedint $_minDepth = 1
The minimum depth a page must have to be included when rendering
Default value1Details
Type
int
>VPropertyprotectedstring|array $_partial
Partial view script to use for rendering menu
Details
Type
string | array
>VPropertyprotectedstring $_separator = ' &gt; '
Breadcrumbs separator string
Default value' &gt; 'Details
Type
string

Methods

methodpublicbreadcrumbs(\Zend_Navigation_Container $container = null) : \Zend_View_Helper_Navigation_Breadcrumbs

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

Parameters
NameTypeDescription
$container\Zend_Navigation_Container

[optional] container to

                                             operate on
Returns
TypeDescription
\Zend_View_Helper_Navigation_Breadcrumbsfluent interface, returns self
methodpublicgetLinkLast() : bool

Returns whether last page in breadcrumbs should be hyperlinked

Returns
TypeDescription
boolwhether last page in breadcrumbs should be hyperlinked
methodpublicgetPartial() : string | array | null

Returns partial view script to use for rendering menu

Returns
TypeDescription
string | array | null
methodpublicgetSeparator() : string

Returns breadcrumb separator

Returns
TypeDescription
stringbreadcrumb separator
methodpublicrender(\Zend_Navigation_Container $container = null) : string

Renders helper

Implements {@link Zend_View_Helper_Navigation_Helper::render()}.
Parameters
NameTypeDescription
$container\Zend_Navigation_Container

[optional] container to

                                          render. Default is to
                                          render the container
                                          registered in the helper.
Returns
TypeDescription
stringhelper output
methodpublicrenderPartial(\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, so in the script it will be available in $this->container.
Parameters
NameTypeDescription
$container\Zend_Navigation_Container

[optional] container to

                                          pass to view script.
                                          Default is to use the
                                          container registered in the
                                          helper.
$partialstring | 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
TypeDescription
stringhelper output
methodpublicrenderStraight(\Zend_Navigation_Container $container = null) : string

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

Parameters
NameTypeDescription
$container\Zend_Navigation_Container

[optional] container to

                                          render. Default is to
                                          render the container
                                          registered in the helper.
Returns
TypeDescription
stringhelper output
methodpublicsetLinkLast(bool $linkLast) : \Zend_View_Helper_Navigation_Breadcrumbs

Sets whether last page in breadcrumbs should be hyperlinked

Parameters
NameTypeDescription
$linkLastbool

whether last page should be hyperlinked

Returns
TypeDescription
\Zend_View_Helper_Navigation_Breadcrumbsfluent interface, returns self
methodpublicsetPartial(string | array $partial) : \Zend_View_Helper_Navigation_Breadcrumbs

Sets which partial view script to use for rendering menu

Parameters
NameTypeDescription
$partialstring | 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
TypeDescription
\Zend_View_Helper_Navigation_Breadcrumbsfluent interface, returns self
methodpublicsetSeparator(string $separator) : \Zend_View_Helper_Navigation_Breadcrumbs

Sets breadcrumb separator

Parameters
NameTypeDescription
$separatorstring

separator string

Returns
TypeDescription
\Zend_View_Helper_Navigation_Breadcrumbsfluent interface, returns self
Documentation was generated by phpDocumentor 2.2.0 .