45 users Sign-in to change your status

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

• Repository
• Download package
• Browse source

Developers

Name	Status	Email
ISICS.fr	lead	rf.scisi <<ta>> tcatnoc

License

Copyright (c) 2O08 ISICS.fr

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Releases for sf 1.4

Version	License	API	Released
0.9.9beta	LGPL	0.9.9beta	23/06/2010
0.9.1beta	LGPL	0.9.1beta	29/07/2008
0.9.0beta	LGPL	0.9.0beta	23/06/2008

Releases for sf 1.3

Version	License	API	Released
0.9.9beta	LGPL	0.9.9beta	23/06/2010
0.9.1beta	LGPL	0.9.1beta	29/07/2008
0.9.0beta	LGPL	0.9.0beta	23/06/2008

Releases for sf 1.2

Version	License	API	Released
0.9.9beta	LGPL	0.9.9beta	23/06/2010
0.9.6beta	LGPL	0.9.6beta	25/05/2009
0.9.5beta	LGPL	0.9.5beta	19/05/2009
0.9.3beta	LGPL	0.9.3beta	02/02/2009
0.9.1beta	LGPL	0.9.1beta	29/07/2008
0.9.0beta	LGPL	0.9.0beta	23/06/2008

Releases for sf 1.1

Version	License	API	Released
0.9.9beta	LGPL	0.9.9beta	23/06/2010
0.9.6beta	LGPL	0.9.6beta	25/05/2009
0.9.5beta	LGPL	0.9.5beta	19/05/2009
0.9.3beta	LGPL	0.9.3beta	02/02/2009
0.9.1beta	LGPL	0.9.1beta	29/07/2008
0.9.0beta	LGPL	0.9.0beta	23/06/2008

Releases for sf 1.0

Version	License	API	Released
0.9.1beta	LGPL	0.9.1beta	29/07/2008
0.9.0beta	LGPL	0.9.0beta	23/06/2008

Join this plugin team

Other releases

Release 0.9.9 - 23/06/2010

Release 0.9.6 - 25/05/2009

Release 0.9.5 - 19/05/2009

Release 0.9.3 - 02/02/2009

Release 0.9.1 - 29/07/2008

Release 0.9.0 - 23/06/2008

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

License

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

Installation

• Install the plugin:

  $ symfony plugin:install isicsBreadcrumbsPlugin -s beta
  $ symfony cc

• Enable the module isicsBreadcrumbs in settings.yml:

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

Usage

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') ?>
</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, Array $options): 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

2010-06-23 | 0.9.9 beta

• Added support for escaping strategy
• Added options for root item in component

2010-06-23 | 0.9.8 beta

• Added missing comments
• Updated API

2010-06-23 | 0.9.7 beta

• Added plugin configuration class
• Added options to breadcrumbs items

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.