NiceMenusBlock.php in Nice Menus 8

Namespace

Drupal\nice_menus\Plugin\Block

File

src/Plugin/Block/NiceMenusBlock.php

<?php

namespace Drupal\nice_menus\Plugin\Block;

use Drupal\Core\Cache\Cache;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

/**
 * Provides a 'Nice menus' block.
 *
 * @Block(
 *   id = "nice_menus_block",
 *   admin_label = @Translation("Nice menus"),
 *   category = @Translation("Menus")
 * )
 */
class NiceMenusBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The path alias manager.
   *
   * @var \Drupal\Core\Path\AliasManagerInterface
   */
  protected $menuSelector;

  /**
   * NiceMenusBlock constructor.
   *
   * @param array  $configuration
   * @param string $plugin_id
   * @param mixed  $plugin_definition
   * @param        $menuSelector
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $menuSelector) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->menuSelector = $menuSelector;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('menu.parent_form_selector'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'nice_menus_menu' => 'admin:',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['nice_menus_name'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Menu name'),
      '#default_value' => isset($config['nice_menus_name']) ? $config['nice_menus_name'] : '',
    );
    $form['nice_menus_menu'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Menu parent'),
      '#description' => $this
        ->t('The menu parent from which to show a Nice menu.'),
      '#default_value' => isset($config['nice_menus_menu']) ? $config['nice_menus_menu'] : 'navigation:0',
      '#options' => $this->menuSelector
        ->getParentSelectOptions(),
    );
    $form['nice_menus_depth'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Menu depth'),
      '#description' => $this
        ->t('The depth of the menu, i.e. the number of child levels starting with the parent selected above. Leave set to -1 to display all children and use 0 to display no children.'),
      '#default_value' => isset($config['nice_menus_depth']) ? $config['nice_menus_depth'] : -1,
      '#options' => array_combine(range(-1, 5), range(-1, 5)),
    );
    $form['nice_menus_type'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Menu style'),
      '#description' => $this
        ->t('right: menu items are listed on top of each other and expand to the right') . '<br />' . $this
        ->t('left: menu items are listed on top of each other and expand to the left') . '<br />' . $this
        ->t('down: menu items are listed side by side and expand down'),
      '#default_value' => isset($config['nice_menus_type']) ? $config['nice_menus_type'] : 'right',
      '#options' => array_combine(array(
        'right',
        'left',
        'down',
      ), array(
        'right',
        'left',
        'down',
      )),
    );
    $form['nice_menus_respect_expand'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Respect "Show as expanded" option'),
      '#description' => $this
        ->t('Menu items have a "Show as expanded" option, which is disabled by default. Since menu items do NOT have this option checked by default, you should choose Yes here once you have configured the menu items that you DO want to expand.'),
      '#options' => array(
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ),
      '#default_value' => isset($config['nice_menus_respect_expand']) ? $config['nice_menus_respect_expand'] : 0,
    );
    return $form;
  }

  /**
   * @param array                                $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfiguration([
      'label' => $form_state
        ->getValue('label'),
      'label_display' => $form_state
        ->getValue('label_display'),
      'nice_menus_name' => $form_state
        ->getValue('nice_menus_name'),
      'nice_menus_menu' => $form_state
        ->getValue('nice_menus_menu'),
      'nice_menus_depth' => $form_state
        ->getValue('nice_menus_depth'),
      'nice_menus_type' => $form_state
        ->getValue('nice_menus_type'),
      'nice_menus_respect_expand' => $form_state
        ->getValue('nice_menus_respect_expand'),
    ]);
  }

  /**
   * // add 'menuparent' class.
   *
   * @param $items
   *
   * @return mixed
   */
  public function _build_sub_menu_menuparent($items) {
    foreach ($items as $k => &$item) {
      if ($item['below']) {
        $item['attributes']
          ->addClass('menuparent');
        $item['below'] = $this
          ->_build_sub_menu_menuparent($item['below']);
      }
    }
    return $items;
  }

  /**
   * add class to nice menus.
   *
   * @param $tree
   * @param $block_config
   *
   * @return mixed
   */
  public function _build_menu_style($tree, $block_config) {

    // add default class.
    $tree['#attributes']['class'][] = 'nice-menu';
    $tree['#attributes']['class'][] = 'nice-menu-' . $block_config['menu_name'];
    $tree['#attributes']['class'][] = 'nice-menu-' . $block_config['nice_menus_type'];
    $tree['#attributes']['class'][] = 'menu';

    // add 'menuparent' class.
    if (!empty($tree['#items'])) {
      $tree['#items'] = $this
        ->_build_sub_menu_menuparent($tree['#items']);
    }
    return $tree;
  }

  /**
   * @return array
   */
  public function build() {
    $block_config = $this
      ->getBlockConfigExtended();
    $config = \Drupal::config('nice_menus.settings');

    // attach library.
    $library = [];

    // load nice_menus.css
    $library[] = 'nice_menus/nice_menus_css';
    if ($config
      ->get('nice_menus_js')) {
      $library[] = 'nice_menus/superfish';
      $library[] = 'nice_menus/jquery.hoverIntent';
      $library[] = 'nice_menus/nice_menus';
    }

    // load nice menus default css.
    if ($config
      ->get('nice_menus_default_css')) {
      $library[] = 'nice_menus/nice_menus_default';
    }

    // get menu tree.
    $tree = nice_menus_build_tree($block_config);

    // build menu class.
    $tree = $this
      ->_build_menu_style($tree, $block_config);

    /**
     * @TODO suupoert responsive.
     * @TODO display title.
     */
    return array(
      '#theme' => 'nice_menus',
      '#attached' => array(
        'library' => $library,
        'drupalSettings' => array(
          'nice_menus_options' => array(
            'delay' => $config
              ->get('nice_menus_sf_delay'),
            'speed' => $config
              ->get('nice_menus_sf_speed'),
          ),
        ),
      ),
      '#menu_output' => $tree,
    );
  }

  /**
   * {@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();
    $block_config = $this
      ->getBlockConfigExtended();
    $cache_tags[] = 'config:system.menu.' . $block_config['menu_name'];
    return $cache_tags;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {

    // ::build() uses MenuActiveTrail::getActiveTrailIds()
    // to extend 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.
    $block_config = $this
      ->getBlockConfigExtended();
    $menu_name = $block_config['menu_name'];
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'route.menu_active_trails:' . $menu_name,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getBlockConfigExtended() {

    // get config.
    $block_config = $this
      ->getConfiguration();

    // set default menu_name and menu_mlid.
    list($block_config['menu_name'], $block_config['menu_mlid']) = explode(':', $block_config['nice_menus_menu'], 2);
    return $block_config;
  }

}

Classes

Name	Description
NiceMenusBlock	Provides a 'Nice menus' block.