SelectList.php in Plugin 8.2

Namespace

Drupal\plugin\Plugin\Plugin\PluginSelector

File

src/Plugin/Plugin/PluginSelector/SelectList.php

<?php

namespace Drupal\plugin\Plugin\Plugin\PluginSelector;

use Drupal\Core\Form\FormStateInterface;
use Drupal\plugin\PluginDefinition\PluginLabelDefinitionInterface;
use Drupal\plugin\PluginHierarchyTrait;

/**
 * Provides a plugin selector using a <select> element.
 *
 * @PluginSelector(
 *   id = "plugin_select_list",
 *   label = @Translation("Drop-down selection list")
 * )
 */
class SelectList extends AdvancedPluginSelectorBase {
  use PluginHierarchyTrait;

  /**
   * {@inheritdoc}
   */
  protected function buildSelector(array $root_element, FormStateInterface $form_state, array $plugins) {
    $element = parent::buildSelector($root_element, $form_state, $plugins);

    /** @var \Drupal\Component\Plugin\PluginInspectionInterface[] $plugins */
    $element['container']['plugin_id'] = [
      '#ajax' => [
        'callback' => [
          get_class(),
          'ajaxRebuildForm',
        ],
        'effect' => 'fade',
        'event' => 'change',
        'trigger_as' => [
          'name' => $element['container']['change']['#name'],
        ],
      ],
      '#default_value' => $this
        ->getSelectedPlugin() ? $this
        ->getSelectedPlugin()
        ->getPluginId() : NULL,
      '#empty_value' => '',
      '#options' => $this
        ->buildOptionsLevel($this
        ->buildPluginHierarchy($this->selectablePluginDiscovery)),
      '#required' => $this
        ->isRequired(),
      '#title' => $this
        ->getLabel(),
      '#description' => $this
        ->getDescription(),
      '#type' => 'select',
    ];
    return $element;
  }

  /**
   * Helper function for self::options().
   *
   * @param array $hierarchy
   *   A plugin ID hierarchy as returned by self::hierarchy().
   * @param integer $depth
   *   The depth of $hierarchy's top-level items as seen from the original
   *   hierarchy's root (this function is recursive), starting with 0.
   *
   * @return string[]
   *   Keys are plugin IDs.
   */
  protected function buildOptionsLevel(array $hierarchy, $depth = 0) {
    $plugin_definitions = $this->selectablePluginDiscovery
      ->getDefinitions();
    $options = [];
    $prefix = $depth ? str_repeat('-', $depth) . ' ' : '';
    foreach ($hierarchy as $plugin_id => $child_plugin_ids) {
      $plugin_definition = $plugin_definitions[$plugin_id];
      $label = $plugin_definition instanceof PluginLabelDefinitionInterface ? $plugin_definition
        ->getLabel() : $plugin_definition
        ->getId();
      $options[$plugin_id] = $prefix . $label;
      $options += $this
        ->buildOptionsLevel($child_plugin_ids, $depth + 1);
    }
    return $options;
  }

}

Classes

Name	Description
SelectList	Provides a plugin selector using a <select> element.