isicsBreadcrumbsPlugin plugin

The isicsBreadcrumbsPlugin is a simple way to handle breadcrumbs in your applications.

isicsBreadcrumbsPlugin is working on Symfony 1.0 and 1.1.

At a glance

• A singleton who manages breadcrumbsItems. By default, a root item is present (text: Home, uri: @homepage)
• A component who display the breadcrumbs

License

The isicsBreadcrumbsPlugin is licensed under the GNU Lesser General Public License (LGPL).

Installation

• Install the plugin:

 $ symfony plugin-install http://plugins.symfony-project.com/isicsBreadcrumbsPlugin
 $ symfony cc

• Enable the module isicsBreadcrumbs in settings.yml:

 all:
   .settings:
     enabled_modules:        [default, isicsBreadcrumbsPlugin]

Usage

Define the path in your actions:

public function executeMyAction()
{
  isicsBreadcrumbs::getInstance()->addItem('My action', 'myModule/myAction');

  => Home > My action

If the action is more deep:

public function executeMyAction()
{
  isicsBreadcrumbs::getInstance()->addItem('My previous action', 'myModule/myPreviousAction');
  isicsBreadcrumbs::getInstance()->addItem('My action', 'myModule/myAction');
  
  => Home > My previous action > My action

Include the breadcrumbs component (in the layout for instance):

<p id="breadcrumbs">
  You are here :
  <?php include_component('isicsBreadcrumbs', 'show') ?>
</p>

You can set your own root:

<p id="breadcrumbs">
  You are here :
  <?php include_component('isicsBreadcrumbs', 'show', array(
    'root' => array('text' => 'Home', 'uri' => '@myHomepage'))) ?>
</p>

API

• void addItem(String $test, String $uri): add an item at the end of the breadcrumbs
• void clearItems(): erase all items
• isicsBreadcrumbs getInstance(): retrieve the singleton instance
• array getItems(): return an array of isicsBreadcrumbsItem
• void setRoot(String $test, String $uri): set root item. By default, a root item is already present (text: Home, uri: @homepage).

Changelog

2008-07-29 | 0.9.1 beta

• Added action caching support.

2008-06-23 | 0.9.0 beta

• Initial public release.