Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itnelo/yii2-breadcrumbs-filter
Filter for the Yii2 Framework which automatically append module as breadcrumbs item
https://github.com/itnelo/yii2-breadcrumbs-filter
Last synced: about 2 months ago
JSON representation
Filter for the Yii2 Framework which automatically append module as breadcrumbs item
- Host: GitHub
- URL: https://github.com/itnelo/yii2-breadcrumbs-filter
- Owner: itnelo
- License: mit
- Created: 2016-02-04T08:14:29.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-24T08:46:13.000Z (almost 9 years ago)
- Last Synced: 2024-10-13T12:45:02.525Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Yii2 Breadcrumbs ActionFilter
[](https://packagist.org/packages/itnelo/yii2-breadcrumbs-filter)
[](LICENSE.md)
[](https://scrutinizer-ci.com/g/itnelo/yii2-breadcrumbs-filter)
[](https://packagist.org/packages/itnelo/yii2-breadcrumbs-filter)
Yii2 ActionFilter which automatically append module as breadcrumb item if his id exists in requested route.
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```bash
$ composer require itnelo/yii2-breadcrumbs-filter:~1.0
```
or add
```
"itnelo/yii2-breadcrumbs-filter": "~1.0"
```
to the `require` section of your `composer.json` file.
## Usage
[Attach behavior](http://www.yiiframework.com/doc-2.0/guide-concept-behaviors.html#attaching-behaviors) to module:
```PHP
public function behaviors()
{
return array_merge(parent::behaviors(), [
'breadcrumbs' => [
'class' => \itnelo\filters\BreadcrumbsFilter::className(),
]
]);
}
```
In [view](https://github.com/yiisoft/yii2/blob/master/docs/guide/structure-views.md) file (perhaps, layout):
```PHP
= \yii\widgets\Breadcrumbs::widget([
'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
]) ?>
```
## Best practices
You can unify building of site breadcrumbs navigation by extending [yii\base\Module](http://www.yiiframework.com/doc-2.0/yii-base-module.html).
It will guarantee what all modules in requested route gets their place in breadcrumbs widget. Example:
```PHP
use yii\base\Module as BaseModule;
use itnelo\filters\BreadcrumbsFilter;
class Module extends BaseModule
{
/**
* Module name
* @var string
*/
public $name = 'My Module';
/**
* Enable/Disable breadcrumbs natigation via app\components\filters\BreadcrumbsFilter
* For module and submodules, without affects on parent module
* @var bool
*/
public $breadcrumbs = true;
/**
* Array of [routes|controllers|actions] names which shouldn't have breadcrumbs
* ['*'] means what breadcrumbs navigation disabled for all controllers and actions (direct childs)
* For module and submodules, without affects on parent module
* @var bool
*/
public $breadcrumbsExceptRoutes = [];
/**
* @inheritdoc
*/
public function behaviors()
{
$behaviors = [];
if ($this->breadcrumbs) {
$behaviors['breadcrumbs'] = [
'class' => BreadcrumbsFilter::className(),
'label' => $this->name,
'defaultRoute' => $this->defaultRoute,
'exceptRoutes' => $this->breadcrumbsExceptRoutes,
];
}
return array_merge(parent::behaviors(), $behaviors);
}
}
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.