isicsBreadcrumbsPlugin - 0.9.5

A simple way to handle breadcrumbs.

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to the Plugins Home


Forgot your password?
Create an account



advanced search
Information Readme Releases Changelog Contribute
Show source

isicsBreadcrumbsPlugin plugin

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

isicsBreadcrumbsPlugin is working on Symfony 1.1 or greater.

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


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


  • Install the plugin:

    $ symfony plugin:install isicsBreadcrumbsPlugin -s beta
    $ symfony cc
  • Enable the module isicsBreadcrumbs in settings.yml:

        enabled_modules: [default, isicsBreadcrumbsPlugin]


Define the path in your templates:

<?php $breadcrumbs->addItem('My action', 'myModule/myAction') ?>
=> Home > My action

If the action is deeper:

<?php $breadcrumbs->addItem('My previous action', 'myModule/myPreviousAction') ?>
<?php $breadcrumbs->addItem('My action', 'myModule/myAction') ?>
=> Home > My previous action > My action

Define the path in your actions:

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

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

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

You can set your own root:

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


  • 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).


2009-05-19 | 0.9.5 beta

  • Fixed package.xml
  • Updated README to markdown

2009-02-02 | 0.9.2 beta

  • Added breadcrumbs template shorcut (break compatibility with sf 1.0).
  • Added output escaping support.
  • Removed I18N support (hasn't to be handled here).

2008-07-29 | 0.9.1 beta

  • Added action caching support.

2008-06-23 | 0.9.0 beta

  • Initial public release.