mj/breadcrumb

A simple breadcrumb generator for Laravel 4

Laravel 4 Breadcrumbs

** If you have problems running setSeperator (typo'd) after update, I changed the function name to setSeperator., _(*1)

A small and easy customizable breadcrumb generator for Laravel 4., _(*2)

edit the .json

Edit your .json file and add the following line to your "require", _(*3)

"mj/breadcrumb": "dev-master", _(*4)

After this run the composer update to update your framework and get the breadcrumb class loaded into your files., _(*5)

Setup

Open app.php in your config folder, _(*6)

1. Add the line 'Mj\Breadcrumb\BreadcrumbServiceProvider' to the providers array., _(*7)

2. To make use of the Facade that comes with Laravel 4, make sure you register the alias in the file 'app/config/app.php'., _(*8)

Like this: 'Breadcrumb' => 'Mj\Breadcrumb\Facades\breadcrumb', _(*9)

Usage

To create breadcrumbs use the following code:, _(*10)

Breadcrumb::addbreadcrumb('linkname', 'url');, _(*11)

You can add multiple breadcrumbs by repeating the code above., _(*12)

To set an seperator you can use:, _(*13)

Breadcrumb::setSeparator('yourseperator'), _(*14)

At last send your breadcrumbs to your template (or just generate them) with the following command:, _(*15)

Breadcrumb::generate(), _(*16)

Example

Note: Use real url's (like /this/page) and not Laravel's URL helper. Not setting a URL at all will also work., _(*17)

//Controller

public function page()
{
  //Those are required to set some breadcrumbs first.
  Breadcrumb::addBreadcrumb('home', '/');
  Breadcrumb::addBreadcrumb('some page', '/some-page');
  Breadcrumb::addBreadcrumb('last piece'); //Does not need a url because it's the last breadcrumb segment

    Breadcrumb::setSeparator('/'); //Set some seperator you think is nicest (not required)

  $data = array(
      'breadcrumbs' => Breadcrumb::generate() //Breadcrumbs UL is generated and stored in an array.
  )

  //return the view with the $data array to use it in the view
  return View::make('some/page', $data);
}

//View

{{$breadcrumbs}} // -> UL with list-items with the links :)