st3ph/cakephp-breadcrumb

CakePHP 3.x plugin to handle Breadcrumb

dev-master 2016-08-27 15:41 UTC

Requires

• php: >=5.4.16
• cakephp/cakephp: ~3.0

Requires (Dev)

• cakephp/cakephp-codesniffer: dev-master
• phpunit/phpunit: 5.3.*

MIT

• Stéphane Litou

• plugin
• cakephp
• component
• helper
• breadcrumb

README

===============================================

CakePHP-breadcrumb is here to help you manage your breadcrumbs

It is compatible with CakePHP 3 only.

• Installation
  • Configuration
• Usage
  • Controllers
  • Views

Installing with Composer

The package is available on Packagist. You can install it using this Composer command in the root of your project:

composer require st3ph/cakephp-breadcrumb

# In config/bootstrap.php
Plugin::load('Breadcrumb');

# In src/Controller/AppController.php (or any controller)
public function initialize()
{
    parent::initialize();
    $this->loadComponent('Breadcrumb.Breadcrumb');
}

Loading the Helper:

# In View/AppView.php
public function initialize()
{
    parent::initialize();
    $this->loadHelper('Breadcrumb', ['className' => 'Breadcrumb.Breadcrumb']);
}

Configuration

None, yet.

Usage

Controllers

$this->Breadcrumb->push([
    'title' => 'Awesome title',
    'url' => Router::url(['controller' => 'MyController', 'action' => 'MyAction']),
]);

Views

The plugin automatically create a view variable with the breadcrumb array in the beforeRender event named $BreadCrumbCrumbs.

echo $this->Breadcrumb->display($BreadCrumbCrumbs);