Public Member Functions | Protected Attributes

Zend_View_Helper_Navigation_Breadcrumbs Class Reference

Inheritance diagram for Zend_View_Helper_Navigation_Breadcrumbs:
Zend_View_Helper_Navigation_HelperAbstract Zend_View_Helper_HtmlElement Zend_View_Helper_Navigation_Helper Zend_View_Helper_Abstract Zend_View_Helper_Interface

Public Member Functions

 breadcrumbs (Zend_Navigation_Container $container=null)
 setSeparator ($separator)
 getSeparator ()
 setLinkLast ($linkLast)
 getLinkLast ()
 setPartial ($partial)
 getPartial ()
 renderStraight (Zend_Navigation_Container $container=null)
 renderPartial (Zend_Navigation_Container $container=null, $partial=null)
 render (Zend_Navigation_Container $container=null)

Protected Attributes

 $_separator = ' > '
 $_minDepth = 1
 $_linkLast = false
 $_partial

Detailed Description

Definition at line 37 of file Breadcrumbs.php.


Member Function Documentation

breadcrumbs ( Zend_Navigation_Container $  container = null )

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

Parameters:
Zend_Navigation_Container$container[optional] container to operate on
Returns:
Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self

Definition at line 77 of file Breadcrumbs.php.

getLinkLast (  )

Returns whether last page in breadcrumbs should be hyperlinked

Returns:
bool whether last page in breadcrumbs should be hyperlinked

Definition at line 133 of file Breadcrumbs.php.

getPartial (  )

Returns partial view script to use for rendering menu

Returns:
string|array|null

Definition at line 166 of file Breadcrumbs.php.

getSeparator (  )

Returns breadcrumb separator

Returns:
string breadcrumb separator

Definition at line 109 of file Breadcrumbs.php.

render ( Zend_Navigation_Container $  container = null )

Renders helper

Implements Zend_View_Helper_Navigation_Helper::render().

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

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 317 of file Breadcrumbs.php.

renderPartial ( Zend_Navigation_Container $  container = null,
partial = null 
)

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:
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.
Returns:
string helper output

Definition at line 250 of file Breadcrumbs.php.

renderStraight ( Zend_Navigation_Container $  container = null )

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

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

Definition at line 183 of file Breadcrumbs.php.

setLinkLast ( linkLast )

Sets whether last page in breadcrumbs should be hyperlinked

Parameters:
bool$linkLastwhether last page should be hyperlinked
Returns:
Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self

Definition at line 122 of file Breadcrumbs.php.

setPartial ( partial )

Sets which partial view script to use for rendering menu

Parameters:
string | array$partialpartial 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:
Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self

Definition at line 152 of file Breadcrumbs.php.

setSeparator ( separator )

Sets breadcrumb separator

Parameters:
string$separatorseparator string
Returns:
Zend_View_Helper_Navigation_Breadcrumbs fluent interface, returns self

Definition at line 95 of file Breadcrumbs.php.


The documentation for this class was generated from the following file: