Breadcrumbs.php

Go to the documentation of this file.

<?php
namespace Magento\Theme\Block\Html;

use Magento\Framework\Serialize\Serializer\Json;
use Magento\Framework\View\Element\Template;

class Breadcrumbs extends \Magento\Framework\View\Element\Template
{
    protected $_template = 'Magento_Theme::html/breadcrumbs.phtml';

    protected $_properties = ['label', 'title', 'link', 'first', 'last', 'readonly'];

    protected $_crumbs;

    protected $_cacheKeyInfo;

    private $serializer;

    public function __construct(
        Template\Context $context,
        array $data = [],
        Json $serializer = null
    ) {
        parent::__construct($context, $data);
        $this->serializer =
            $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()->get(Json::class);
    }

    public function addCrumb($crumbName, $crumbInfo)
    {
        foreach ($this->_properties as $key) {
            if (!isset($crumbInfo[$key])) {
                $crumbInfo[$key] = null;
            }
        }

        if (!isset($this->_crumbs[$crumbName]) || !$this->_crumbs[$crumbName]['readonly']) {
            $this->_crumbs[$crumbName] = $crumbInfo;
        }

        return $this;
    }

    public function getCacheKeyInfo()
    {
        if ($this->_cacheKeyInfo === null) {
            $this->_cacheKeyInfo = parent::getCacheKeyInfo() + [
                'crumbs' => base64_encode($this->serializer->serialize($this->_crumbs)),
                'name' => $this->getNameInLayout()
            ];
        }
        return $this->_cacheKeyInfo;
    }

    protected function _toHtml()
    {
        if (is_array($this->_crumbs)) {
            reset($this->_crumbs);
            $this->_crumbs[key($this->_crumbs)]['first'] = true;
            end($this->_crumbs);
            $this->_crumbs[key($this->_crumbs)]['last'] = true;
        }
        $this->assign('crumbs', $this->_crumbs);

        return parent::_toHtml();
    }
}