API Documentation

View/Helper/Navigation/Breadcrumbs.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
subpackage
Helper
version
$Id: Breadcrumbs.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_View_Helper_Navigation_Breadcrumbs

Description

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.

Zend_View_Helper_Navigation_Breadcrumbs
jump to top

Extends from
Zend_View_Helper_Navigation_HelperAbstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
subpackage
Helper
Properties
$_separator
$_minDepth
$_linkLast
$_partial
Methods
breadcrumbs
setSeparator
getSeparator
setLinkLast
getLinkLast
setPartial
getPartial
renderStraight
renderPartial
render

Description

Helper for printing breadcrumbs

Properties

$_linkLast
jump to class

bool $_linkLast = 'false'

Whether last page in breadcrumb should be hyperlinked

Details

$_linkLast
bool
visibility
protected
default
false
final
false
static
false

$_minDepth
jump to class

int $_minDepth = '1'

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

Details

$_minDepth
int
visibility
protected
default
1
final
false
static
false

$_partial
jump to class

string|array $_partial = ''

Partial view script to use for rendering menu

Details

$_partial
string|array
visibility
protected
default
final
false
static
false

$_separator
jump to class

string $_separator = ' > '

Breadcrumbs separator string

Details

$_separator
string
visibility
protected
default
>
final
false
static
false

Methods

breadcrumbs
jump to class

breadcrumbs( Zend_Navigation_Container $container = null ) : Zend_View_Helper_Navigation_Breadcrumbs

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

Arguments
$container
Zend_Navigation_Container
[optional] container to operate on
Output
Zend_View_Helper_Navigation_Breadcrumbs
fluent interface, returns self
Details
visibility
public
final
false
static
false

getLinkLast
jump to class

getLinkLast( ) : bool

Returns whether last page in breadcrumbs should be hyperlinked

Output
bool
whether last page in breadcrumbs should be hyperlinked
Details
visibility
public
final
false
static
false

getPartial
jump to class

getPartial( ) : string|array|null

Returns partial view script to use for rendering menu

Output
string|array|null
Details
visibility
public
final
false
static
false

getSeparator
jump to class

getSeparator( ) : string

Returns breadcrumb separator

Output
string
breadcrumb separator
Details
visibility
public
final
false
static
false

render
jump to class

render( Zend_Navigation_Container $container = null ) : string

Renders helper

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

Arguments
$container
Zend_Navigation_Container
[optional] container to render. Default is to render the container registered in the helper.
Output
string
helper output
Details
visibility
public
final
false
static
false

renderPartial
jump to class

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, so in the script it will be available in $this->container.

Arguments
$container
Zend_Navigation_Container
[optional] container to pass to view script. Default is to use the container registered in the helper.
$partial
stringarray
[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.
Output
string
helper output
Details
visibility
public
final
false
static
false

renderStraight
jump to class

renderStraight( Zend_Navigation_Container $container = null ) : string

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

Arguments
$container
Zend_Navigation_Container
[optional] container to render. Default is to render the container registered in the helper.
Output
string
helper output
Details
visibility
public
final
false
static
false

setLinkLast
jump to class

setLinkLast( bool $linkLast ) : Zend_View_Helper_Navigation_Breadcrumbs

Sets whether last page in breadcrumbs should be hyperlinked

Arguments
$linkLast
bool
whether last page should be hyperlinked
Output
Zend_View_Helper_Navigation_Breadcrumbs
fluent interface, returns self
Details
visibility
public
final
false
static
false

setPartial
jump to class

setPartial( string|array $partial ) : Zend_View_Helper_Navigation_Breadcrumbs

Sets which partial view script to use for rendering menu

Arguments
$partial
stringarray
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.
Output
Zend_View_Helper_Navigation_Breadcrumbs
fluent interface, returns self
Details
visibility
public
final
false
static
false

setSeparator
jump to class

setSeparator( string $separator ) : Zend_View_Helper_Navigation_Breadcrumbs

Sets breadcrumb separator

Arguments
$separator
string
separator string
Output
Zend_View_Helper_Navigation_Breadcrumbs
fluent interface, returns self
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.