MenuPositionRuleOrderForm.php in Menu Position 8

Namespace

Drupal\menu_position\Form

File

src/Form/MenuPositionRuleOrderForm.php

<?php

namespace Drupal\menu_position\Form;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Routing\RouteBuilderInterface;
use Drupal\Core\Url;
use Drupal\Core\Menu\MenuLinkManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class MenuPositionRuleOrderForm.
 *
 * @package Drupal\menu_position\Form
 */
class MenuPositionRuleOrderForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The menu link manager.
   *
   * @var \Drupal\Core\Menu\MenuLinkManagerInterface
   */
  protected $menu_link_manager;

  /**
   * The Route Builder.
   *
   * @var \Drupal\Core\Routing\RouteBuilderInterface
   */
  protected $route_builder;

  /**
   * {@inheritdoc}
   */
  public function __construct(MenuLinkManagerInterface $menu_link_manager, EntityTypeManagerInterface $entity_type_manager, RouteBuilderInterface $route_builder, MessengerInterface $messenger) {
    $this->entityTypeManager = $entity_type_manager;
    $this->menu_link_manager = $menu_link_manager;
    $this->route_builder = $route_builder;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.menu.link'), $container
      ->get('entity_type.manager'), $container
      ->get('router.builder'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'menu_position_rule_order_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Get all the rules.
    $query = $this->entityTypeManager
      ->getStorage('menu_position_rule')
      ->getQuery();
    $results = $query
      ->sort('weight')
      ->execute();
    $rules = $this->entityTypeManager
      ->getStorage('menu_position_rule')
      ->loadMultiple($results);

    // Menu Position rules order (tabledrag).
    $form['#tree'] = TRUE;
    $form['rules'] = [
      '#type' => 'table',
      '#empty' => $this
        ->t('No rules have been created yet.'),
      '#title' => $this
        ->t('Rules processing order'),
      '#header' => [
        $this
          ->t('Rule'),
        $this
          ->t('Affected Menu'),
        $this
          ->t('Enabled'),
        $this
          ->t('Weight'),
        $this
          ->t('Operations'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'rules-weight',
        ],
      ],
    ];

    // Display table of rules.
    foreach ($rules as $rule) {

      /* @var \Drupal\menu_position\Entity\MenuPositionRule $rule */

      /* @var \Drupal\menu_position\Plugin\Menu\MenuPositionLink $menu_link */
      $menu_link = $rule
        ->getMenuLinkPlugin();
      $parent = $this->menu_link_manager
        ->createInstance($menu_link
        ->getParent());

      // @todo Because we're in a loop, try to cache this unless the entity
      //   manager handles all that for us. At least only get the storage once?
      $menu = $this->entityTypeManager
        ->getStorage('menu')
        ->load($menu_link
        ->getMenuName());
      $form['rules'][$rule
        ->getId()] = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
        ],
        'title' => [
          '#markup' => '<strong>' . $rule
            ->getLabel() . '</strong> (' . $this
            ->t('Positioned under: %title', [
            '%title' => $parent
              ->getTitle(),
          ]) . ')',
        ],
        'menu_name' => [
          '#markup' => $menu
            ->label(),
        ],
        'enabled' => [
          '#type' => 'checkbox',
          '#default_value' => $rule
            ->getEnabled(),
        ],
        'weight' => [
          '#type' => 'weight',
          '#title' => $this
            ->t('Weight for @title', [
            '@title' => $rule
              ->getLabel(),
          ]),
          '#title_display' => 'invisible',
          '#default_value' => $rule
            ->getWeight(),
          '#delta' => ceil(count($rules) / 2),
          '#attributes' => [
            'class' => [
              'rules-weight',
            ],
          ],
        ],
        'operations' => [
          '#type' => 'dropbutton',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('entity.menu_position_rule.edit_form', [
                'menu_position_rule' => $rule
                  ->getId(),
              ]),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity.menu_position_rule.delete_form', [
                'menu_position_rule' => $rule
                  ->getId(),
              ]),
            ],
          ],
        ],
      ];
    }
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];

    // By default, render the form using theme_system_config_form().
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $storage = $this->entityTypeManager
      ->getStorage('menu_position_rule');
    $values = $form_state
      ->getValue('rules');
    $rules = $storage
      ->loadMultiple(array_keys($values));
    foreach ($rules as $rule) {
      $value = $values[$rule
        ->getId()];
      $rule
        ->setEnabled((bool) $value['enabled']);
      $rule
        ->setWeight((double) $value['weight']);
      $storage
        ->save($rule);
    }

    // Flush appropriate menu cache.
    $this->route_builder
      ->rebuild();
    $this->messenger
      ->addMessage($this
      ->t('The new rules ordering has been applied.'));
  }

}

Classes

Name	Description
MenuPositionRuleOrderForm	Class MenuPositionRuleOrderForm.