You are here

Home » API reference » Menu Select 2.0.x » MenuSelectTree.php

class MenuSelectTree in Menu Select 2.0.x

Same name and namespace in other branches
  1. 8 src/Element/MenuSelectTree.php \Drupal\menu_select\Element\MenuSelectTree

A form element for the select tree.

Plugin annotation

@FormElement("menu_select_tree");

Hierarchy

Expanded class hierarchy of MenuSelectTree

1 #type use of MenuSelectTree
MenuSelectParentFormSelector::parentSelectElement in src/MenuSelectParentFormSelector.php
Gets a form element to choose a menu and parent.

File

src/Element/MenuSelectTree.php, line 14

Namespace

Drupal\menu_select\Element
View source 
class MenuSelectTree extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#menu_parent' => NULL,
      '#menus' => [],
      '#current_link_id' => NULL,
      '#max_depth' => NULL,
      '#process' => [
        [
          static::class,
          'processElement',
        ],
      ],
      '#element_validate' => [
        [
          static::class,
          'validateMenuSelectTree',
        ],
      ],
      '#attached' => [
        'library' => [
          'menu_select/menu_select',
        ],
      ],
      '#tree' => TRUE,
      'tree' => [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'js-menu-select-tree',
          ],
        ],
        'menu_parent_id' => [
          '#type' => 'hidden',
          '#attributes' => [
            'class' => [
              'js-menu-select-tree-parent-id',
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * Process the element.
   */
  public static function processElement(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['tree']['menu_parent_id']['#default_value'] = $element['#menu_parent'];
    $element['tree']['parent_menu_position_preview'] = [
      '#type' => 'item',
      '#title' => t('Menu link position preview'),
      '#description' => t("Preview of the menu item's hierarchical position."),
    ];
    $element['tree']['parent_menu_position_preview']['children'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'menu-select-parent-position-preview',
          'js-menu-select-parent-position-preview',
        ],
      ],
    ];
    $config = \Drupal::config('menu_select.settings');
    $search_enabled = $config
      ->get('search_enabled');
    if ($search_enabled && \Drupal::currentUser()
      ->hasPermission('use menu select search')) {
      $element['tree']['parent_menu_item_search'] = [
        '#type' => 'textfield',
        '#title' => t('Search'),
        '#autocomplete_route_name' => 'menu_select.menu_select_autocomplete',
        '#autocomplete_route_parameters' => [
          'menus' => implode(':', array_keys($element['#menus'])),
          'max_depth' => $element['#max_depth'],
        ],
        '#description' => t("Alternatively, use this autocomplete search to find the menu item's parent and select it."),
        '#attributes' => [
          'class' => [
            'menu-select-parent-menu-item-search',
            'js-menu-select-parent-menu-item-search',
          ],
        ],
      ];
    }

    /** @var \Drupal\menu_select\MenuSelectTreeBuilder $tree_builder */
    $tree_builder = \Drupal::service('menu_select.tree_builder');
    $element['tree']['parent_menu_item'] = [];
    foreach ($element['#menus'] as $menu_machine_name => $menu_label) {
      $menu_tree = $tree_builder
        ->loadMenuTree($menu_machine_name, $element['#max_depth']);
      $element['tree']['parent_menu_item'][] = $tree_builder
        ->buildRenderedMenu($menu_tree, $menu_machine_name, $menu_label, $element['#current_link_id']);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    return $input ? $input['tree']['menu_parent_id'] : FALSE;
  }

  /**
   * Validate the element.
   *
   * Setting the form state value, in addition to ::valueCallback is required
   * for this element to return a single string, instead of an array.
   */
  public static function validateMenuSelectTree(&$element, FormStateInterface $form_state, &$complete_form) {
    $input_exists = FALSE;
    $input = NestedArray::getValue($form_state
      ->getValues(), $element['#parents'], $input_exists);
    if ($input_exists) {
      $form_state
        ->setValueForElement($element, $input['tree']['menu_parent_id']);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MenuSelectTree::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
MenuSelectTree::processElement public static function Process the element.
MenuSelectTree::validateMenuSelectTree public static function Validate the element.
MenuSelectTree::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.