micro_menu-8.x-1.0-alpha4/src/Plugin/Block/MicroMenuBlock.php

<?php

namespace Drupal\micro_menu\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Menu\MenuLinkTreeInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\current_menu\Cache\CurrentMenuCacheContext;
use Drupal\micro_site\SiteNegotiatorInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides the micro menu block
 *
 * @Block(
 *   id = "micro_menu_block",
 *   admin_label = @Translation("Micro menu block"),
 *   category = @Translation("Menus"),
 * )
 */
class MicroMenuBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Menu\MenuLinkTreeInterface
   */
  protected $menuTree;

  /**
   * @var string
   */
  protected $menuName;

  /**
   * @var \Drupal\micro_site\SiteNegotiatorInterface
   */
  protected $negotiator;

  /**
   * CurrentMenuBlock constructor.
   *
   * @param array $configuration
   * @param string $plugin_id
   * @param mixed $plugin_definition
   * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menuTree
   * @param \Drupal\micro_site\SiteNegotiatorInterface $site_negotiator
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MenuLinkTreeInterface $menuTree, SiteNegotiatorInterface $site_negotiator)  {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->menuTree = $menuTree;
    $this->negotiator = $site_negotiator;
  }


  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('menu.link_tree'),
      $container->get('micro_site.negotiator')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    if ($this->getMenuName()) {
      $parameters = $this->menuTree->getCurrentRouteMenuTreeParameters($this->getMenuName());
      $tree = $this->menuTree->load($this->getMenuName(), $parameters);
      $manipulators = [
        ['callable' => 'menu.default_tree_manipulators:checkAccess'],
        ['callable' => 'menu.default_tree_manipulators:generateIndexAndSort'],
      ];
      $tree = $this->menuTree->transform($tree, $manipulators);
      $build = $this->menuTree->build($tree);
      $build['#contextual_links'] = [
        'menu' => [
          'route_parameters' => ['menu' => $this->getMenuName()]
        ],
      ];
      return $build;
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    // Even when the menu block renders to the empty string for a user, we want
    // the cache tag for this menu to be set: whenever the menu is changed, this
    // menu block must also be re-rendered for that user, because maybe a menu
    // link that is accessible for that user has been added.
    $cache_tags = parent::getCacheTags();
    if ($this->getMenuName()) {
      $cache_tags[] = 'config:system.menu.' . $this->getMenuName();
    }
    return $cache_tags;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    // ::build() uses MenuLinkTreeInterface::getCurrentRouteMenuTreeParameters()
    // to generate menu tree parameters, and those take the active menu trail
    // into account. Therefore, we must vary the rendered menu by the active
    // trail of the rendered menu.
    // Additional cache contexts, e.g. those that determine link text or
    // accessibility of a menu, will be bubbled automatically.
    $cacheContexts = parent::getCacheContexts();
    if ($this->getMenuName()) {
      $cacheContexts = Cache::mergeContexts($cacheContexts, ['route.menu_active_trails:' . $this->getMenuName()]);
    }
    return $cacheContexts;
  }

  /**
   * @return string
   */
  protected function getMenuName() {
    if (!isset($this->menuName)) {
      $active_site = $this->negotiator->getActiveSite();
      if ($active_site) {
        $this->menuName = $active_site->getSiteMenu();
      }
    }
    return $this->menuName;
  }

}