API Documentation

Zend/View/Helper/Navigation/Breadcrumbs.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: Breadcrumbs.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_Navigation_Breadcrumbs

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedbool  $_linkLast= 'false'

Whether last page in breadcrumb should be hyperlinked

Default valuefalseDetails
Type
bool
Propertyprotectedint  $_minDepth= '1'

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

Default value1Details
Type
int
Propertyprotectedstring|array  $_partial= ''

Partial view script to use for rendering menu

Details
Type
stringarray
Propertyprotectedstring  $_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
Name Type Description
$container \Zend_Navigation_Container

[optional] container to operate on

Returns
Type Description
\Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self
methodpublicgetLinkLast( ) : bool

Returns whether last page in breadcrumbs should be hyperlinked

Returns
Type Description
bool whether last page in breadcrumbs should be hyperlinked
methodpublicgetPartial( ) : string|array|null

Returns partial view script to use for rendering menu

Returns
Type Description
string|array|null
methodpublicgetSeparator( ) : string

Returns breadcrumb separator

Returns
Type Description
string breadcrumb separator
methodpublicrender( \Zend_Navigation_Container $container = null ) : string

Renders helper

Implements {@link Zend_View_Helper_Navigation_Helper::render()}.

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
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
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
methodpublicrenderStraight( \Zend_Navigation_Container $container = null ) : string

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

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
methodpublicsetLinkLast( bool $linkLast ) : \Zend_View_Helper_Navigation_Breadcrumbs

Sets whether last page in breadcrumbs should be hyperlinked

Parameters
Name Type Description
$linkLast bool

whether last page should be hyperlinked

Returns
Type Description
\Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self
methodpublicsetPartial( string|array $partial ) : \Zend_View_Helper_Navigation_Breadcrumbs

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_Breadcrumbs fluent interface, returns self
methodpublicsetSeparator( string $separator ) : \Zend_View_Helper_Navigation_Breadcrumbs

Sets breadcrumb separator

Parameters
Name Type Description
$separator string

separator string

Returns
Type Description
\Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self
Documentation was generated by DocBlox 0.15.1.