Building breadcrumbs automatically with modules - yii2

Question

My web page has multiple modules, and i want to know if there is a way to add breadcrumbs the modules home url, without have to add manually to all files.
ex:
Home > MyModule > MyController

Answer 1

The question is definetely too broad, but here is solution I used:
<?php
namespace backend\modules\tests\components;
use yii\helpers\ArrayHelper;
use yii\web\Controller as BaseController;
use yii\web\View;
class Controller extends BaseController
{
/**
* #inheritdoc
*/
public function beforeAction($action)
{
if (parent::beforeAction($action)) {
Yii::$app->view->on(View::EVENT_BEGIN_BODY, function () {
$this->fillBreadcrumbs();
});
return true;
} else {
return false;
}
}
/**
* Fill common breadcrumbs
*/
protected function fillBreadcrumbs()
{
$breadcrumbs = [];
// Add needed elements to $breadcrumbs below
$label = 'Tests';
$breadcrumbs[] = $this->route == '/tests/default/index' ? $label : [
'label' => $label,
'url' => ['/tests/default/index'],
];
// ...
$this->mergeBreadCrumbs($breadcrumbs);
}
/**
* Prepend common breadcrumbs to existing ones
* #param array $breadcrumbs
*/
protected function mergeBreadcrumbs($breadcrumbs)
{
$existingBreadcrumbs = ArrayHelper::getValue($this->view->params, 'breadcrumbs', []);
$this->view->params['breadcrumbs'] = array_merge($breadcrumbs, $existingBreadcrumbs);
}
}
As you can see, it's based on view events and custom controller (extending from yii\web\Controller).
All you need next is to extend needed controllers from custom one.

Answer 2

Note for Pjax Users
If you are using Pjax on index views etc. ensure you add the 'data-pjax'=>'0' option as follows or the request will refresh the new context in your existing view:
Html::a('AnotherView',
['another-view', 'id' => $model->$id], [
'data-pjax' => '0', // !important when using pjax.
]);
app/config/main.php
'modules' => [
/*
* Admin => [...], // in common for frontend/backend access.
*/
'estimator' => [
'class' => 'your\namespace\Module',
'defaultUrl' => '/estimator/',
'defaultUrlLabel' => 'Estimator',
//'layout' => 'left-menu',
//'mainLayout' => '#app/views/layouts/main.php',
],
],
your-app/Module.php
<?php
namespace yourapp\namespace;
use Yii;
use yii\helpers\Inflector;
use yii\helpers\ArrayHelper;
/**
* Entry for module...
*/
class Module extends \yii\base\Module
{
/**
* #var string Layout applied for views in module.
* Comment out $layout to use default parent layout.
* When $layout is enabled, the mainLayout will be utilized instead of the default layout for the site.
*/
//public $layout = "top-menu.php"; // comment out to disable module layout.
/**
* #var string Main layout using for module. Default to layout of parent module.
* The mainLayout is used when `layout` set to 'top-menu'.
*/
//public $mainLayout = '#frontend/views/layouts/main.php';
/**
* #inheritdoc
*/
public $defaultRoute = 'project';
/**
* #var string Default url for breadcrumb
*/
public $defaultUrl;
/**
* #var string Default url label for breadcrumb
*/
public $defaultUrlLabel;
/**
* #inheritdoc
*/
public function beforeAction($action)
{
if (parent::beforeAction($action)) {
/* #var $action \yii\base\Action */
$view = $action->controller->getView();
$view->params['breadcrumbs'][] = [
'label' => ($this->defaultUrlLabel ?: 'Warehouse'),
'url' => ['/' . ($this->defaultUrl ?: $this->uniqueId)],
];
$view->params['breadcrumbs'][] = [
'label' => Inflector::pluralize(Inflector::camelize($action->controller->id)),
'url' => ['/' . ($this->defaultUrl ?: $this->uniqueId) . '/' . $action->controller->id],
];
$view->params['breadcrumbs'][] = [
'label' => Inflector::camelize($action->id),
];
return true;
}
return false;
}
}