/BreadcrumbsBundle

A small breadcrumbs bundle for Symfony2

Primary LanguagePHP

Installation

  1. Add this bundle to your vendor/ dir using the vendors script:
Add the following lines in your ``deps`` file:

    [WhiteOctoberBreadcrumbsBundle]
        git=git://github.com/whiteoctober/BreadcrumbsBundle.git
        target=/bundles/WhiteOctober/BreadcrumbsBundle

**Or** add the following to your composer.json:

	"whiteoctober/breadcrumbs-bundle": "master"

Run the vendors script:

    ./bin/vendors install

  1. Add the WhiteOctober namespace to your autoloader:

    // app/autoload.php $loader->registerNamespaces(array( 'WhiteOctober' => DIR.'/../vendor/bundles', ));

  2. Add this bundle to your application's kernel:

    // app/AppKernel.php public function registerBundles() { return array( // ... new WhiteOctober\BreadcrumbsBundle\WhiteOctoberBreadcrumbsBundle(), // ... ); }

  3. Configure the white_october_breadcrumbs service in your config.yml:

    white_october_breadcrumbs: ~

That's it for configuration.

Usage

In your application controller methods:

public function yourAction()
{
    $breadcrumbs = $this->get("white_october_breadcrumbs");
    $breadcrumbs->addItem("Home", $this->get("router")->generate("index"));
    $breadcrumbs->addItem("Register", $this->get("router")->generate("register"));
}

and then in your template:

{{ wo_render_breadcrumbs() }}

The last item in the breadcrumbs collection will automatically be rendered as plain text rather than a <a>...</a> tag.

Overriding the template

You can override the template used by copying the Resources/views/breadcrumbs.html.twig file out of the bundle and placing it into app/Resources/WhiteOctoberBreadcrumbsBundle/views, then customising as you see fit.