Phalcon Breadcrumbs 
Phalcon Breadcrumbs is a powerful and flexible component for building site breadcrumbs. You can adapt it to your own needs or improve it if you want.
Please write us if you have any feedback.
Thanks!
NOTE
The master branch will always contain the latest stable version. If you wish to check older versions or newer ones currently under development, please switch to the relevant branch/tag.
Getting Started
Requirements
To use this component, you need at least:
- Composer
- PHP >= 5.5
- Phalcon Framework release extension enabled >= 2.x < 4.x
NOTE: Support for legacy PHP versions (down to 7.0) is provided on a best-effort basis.
Installing
$ composer require sergeyklay/breadcrumbs
Define your breadcrumbs
We recommend registering it with your application's services for even easier use:
<?php
use Phalcon\Breadcrumbs;
// Initialize the Breadcrumbs component.
$di->setShared('breadcrumbs', function () {
return new Breadcrumbs;
});
Adding a crumb with a link:
<?php
$this->breadcrumbs->add('Home', '/');
Adding a crumb without a link (normally the last one):
<?php
$this->breadcrumbs->add('User', null, ['linked' => false]);
Output crumbs:
Php Engine
<ol class="breadcrumb">
<?php $this->breadcrumbs->output(); ?>
</ol>
Volt Engine
<ol class="breadcrumb">
{{ breadcrumbs.output() }}
</ol>
Change crumb separator:
<?php
$this->breadcrumbs->setSeparator(' » ');
Make The last element is always not a link:
<?php
$this->breadcrumbs->setLastNotLinked(true);
Delete a crumb (by url):
<?php
$this->breadcrumbs->remove('/admin/user/create');
// remove a crumb without an url
$this->breadcrumbs->remove(null);
Update an existing crumb:
<?php
$this->breadcrumbs->update('/admin/user/remove', ['label' => '<strong class="red">Remove</strong>']);
Count crumbs:
<?php
$this->breadcrumbs->count();
Sets rendering template:
<?php
$this->breadcrumbs->setTemplate(
'<li><a href="{{link}}">{{icon}}{{label}}</a></li>', // linked
'<li class="active">{{icon}}{{label}}</li>', // not linked
'<i class="fa fa-dashboard"></i>' // first icon
);
Multi-language support:
<?php
use Phalcon\Translate\Adapter\NativeArray as Translator;
use Phalcon\Breadcrumbs;
$messages = [
'crumb-home' => 'Home',
'crumb-user' => 'User',
'crumb-settings' => 'Settings',
'crumb-profile' => 'Profile',
];
// Initialize the Translate adapter.
$di->setShared('translate', function () use ($messages) {
return new Translator(['content' => $messages]);
});
// Initialize the Breadcrumbs component.
$di->setShared('breadcrumbs', function () {
return new Breadcrumbs;
});
Errors logging:
<?php
use Phalcon\Logger\Formatter\Line as FormatterLine;
use Phalcon\Logger\Adapter\File as FileLogger;
use Phalcon\Breadcrumbs;
/**
* Initialize the Logger.
*
* @var $config array
* @var $di \Phalcon\Di
*/
$di->setShared('logger', function ($filename = null, $format = null) use ($config) {
$formatter = new FormatterLine($config->get('logger')->format, $config->get('logger')->date);
$logger = new FileLogger($config->get('logger')->path . $config->get('logger')->filename);
$logger->setFormatter($formatter);
$logger->setLogLevel($config->get('logger')->logLevel);
return $logger;
});
// Initialize the Breadcrumbs component.
$di->setShared('breadcrumbs', function () {
return new Breadcrumbs;
});
Events
<?php
use Phalcon\Breadcrumbs;
use Phalcon\Events\Manager as EventsManager;
// Initialize the Events Manager.
$di->setShared('eventsManager', function () {
return new EventsManager;
});
// Initialize the Breadcrumbs component.
$di->setShared('breadcrumbs', function () use ($di) {
$manager = $di->getShared('eventsManager');
$manager->attach('breadcrumbs', function ($event, $connection) {
// We stop the event if it is cancelable
if ($event->isCancelable()) {
// Stop the event, so other listeners will not be notified about this
$event->stop();
}
// Receiving the data from the event context
print_r($event->getData());
});
$breadcrumbs = new Breadcrumbs;
$breadcrumbs->setEventsManager($manager);
return $breadcrumbs;
});
Available events:
breadcrumbs:beforeAdd
breadcrumbs:afterAdd
breadcrumbs:beforeOutput
breadcrumbs:afterOutput
breadcrumbs:beforeTranslate
breadcrumbs:afterTranslate
breadcrumbs:beforeLogging
breadcrumbs:afterLogging
breadcrumbs:beforeRemove
breadcrumbs:afterRemove
breadcrumbs:beforeUpdate
breadcrumbs:afterUpdate
breadcrumbs:beforeSetTemplate
breadcrumbs:afterSetTemplate
Copyright
Phalcon Breadcrumbs is open-sourced software licensed under the New BSD License. © Serghei Iakovlev
![Change CHANGELOG [ci skip]](https://avatars.githubusercontent.com/u/26042973?v=4)
1 Jan 10, 2022
299 May 29, 2022
9.6k Jan 1, 2023
212 Dec 30, 2022
11 Dec 29, 2022
1.7k Dec 24, 2022
1.2k Nov 9, 2022
812 Dec 30, 2022
44 Sep 22, 2022
28 Jul 15, 2022
28 Jul 15, 2022
31 Nov 11, 2020
3 Nov 27, 2022
6 Apr 30, 2022
110 Dec 30, 2022
5 Jun 1, 2023
11 Jul 14, 2022
3 Mar 20, 2022
3 Jan 20, 2017