You are here

Home » API reference » Opigno Learning path 3.x » EntitySelector.php

class EntitySelector in Opigno Learning path 3.x

Provides a form element for entity selection.

`#option_group` - allows you not to specify a list of options explicitly (in this case the #option array will be overridden) .

Plugin annotation

@FormElement("entity_selector");

Hierarchy

Expanded class hierarchy of EntitySelector

2 #type uses of EntitySelector
opigno_learning_path_form_alter in ./opigno_learning_path.module
Implements hook_form_alter().
RecipientsPlugin::getMembersForm in src/Plugin/LearningPathMembers/RecipientsPlugin.php
Get members form.

File

modules/opigno_user_selection/src/Element/EntitySelector.php, line 19

Namespace

Drupal\opigno_user_selection\Element
View source 
class EntitySelector extends Select {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#sort_options' => FALSE,
      '#sort_start' => NULL,
      '#process' => [
        [
          $class,
          'processSelect',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderSelect',
        ],
      ],
      '#theme' => 'entity_selector',
      '#theme_wrappers' => [
        'form_element',
      ],
      '#options' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if (!empty($element['#entity_selector_option']) && !empty($element['#entity_selector_parameters']) && ($group = $element['#entity_selector_parameters']['group']) instanceof Group) {

      /** @var \Drupal\opigno_user_selection\UserSelectionHelper $controller */

      /** @var \Drupal\Core\Controller\ControllerResolver $controller_resolver */
      $controller_resolver = \Drupal::service('controller_resolver');
      $callable = $controller_resolver
        ->getControllerFromDefinition($element['#entity_selector_option']);
      list($options, $default) = call_user_func_array($callable, [
        $group,
      ]);
      $element["#options"] = array_map(static function ($value) {
        return $value['value'];
      }, $options);
      if (empty($element['#show_exists'])) {
        $element["#options"] = array_filter($element["#options"], static function ($value, $key) use ($default) {
          return !in_array($key, $default, TRUE);
        }, ARRAY_FILTER_USE_BOTH);
        $element['#default_value'] = [];
      }
      elseif (!is_null($default) && !isset($element['#default_value'])) {
        $element['#default_value'] = $default;
      }
    }
    unset($element["#options"]["_none"]);
    return parent::valueCallback($element, $input, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderSelect($element) {
    $element = parent::preRenderSelect($element);
    $element['#attached']['library'] = [
      'opigno_user_selection/userselect',
    ];
    $element['#attributes']['data-user-load'] = TRUE;
    if (empty($element['#entity_selector_route_name'])) {
      $element['#entity_selector_route_name'] = 'user_selection_list';
    }
    $url = Url::fromRoute($element['#entity_selector_route_name'], [])
      ->toString(TRUE);

    /** @var \Drupal\Core\Access\AccessManagerInterface $access_manager */
    $access_manager = \Drupal::service('access_manager');
    $access = $access_manager
      ->checkNamedRoute($element['#entity_selector_route_name'], [], \Drupal::currentUser(), TRUE);
    if ($access) {
      $metadata = BubbleableMetadata::createFromRenderArray($element);
      if ($access
        ->isAllowed()) {
        $element['#attributes']['class'][] = 'form-autocomplete';
        $metadata
          ->addAttachments([
          'library' => [
            'opigno_user_selection/userselect',
          ],
        ]);

        // Provide a data attribute for the JavaScript behavior to bind to.
        $element['#attributes']['autocomplete-path'] = $url
          ->getGeneratedUrl();
        $metadata = $metadata
          ->merge($url);
      }
      $metadata
        ->merge(BubbleableMetadata::createFromObject($access))
        ->applyTo($element);
    }
    if (isset($element['#data_type'])) {
      $element['#attributes']['type'] = $element['#data_type'];
    }
    return $element;
  }

}

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
EntitySelector::getInfo public function Returns the element properties for this element. Overrides Select::getInfo
EntitySelector::preRenderSelect public static function Prepares a select render element. Overrides Select::preRenderSelect
EntitySelector::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides Select::valueCallback
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.
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
Select::processSelect public static function Processes a select list form element.
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.