You are here

Home » API reference » Select2 Boxes 8 » MultiSelect2BoxesAutocompleteWidget.php

class MultiSelect2BoxesAutocompleteWidget in Select2 Boxes 8

Plugin implementation of the 'entity_reference autocomplete-tags' widget.

Plugin annotation


@FieldWidget(
  id = "select2boxes_autocomplete_multi",
  label = @Translation("Select2 boxes (Multiple values)"),
  description = @Translation("An autocomplete entity reference field using AJAX."),
  field_types = {
    "entity_reference",
  },
  multiple_values = TRUE
)

Hierarchy

Expanded class hierarchy of MultiSelect2BoxesAutocompleteWidget

File

src/Plugin/Field/FieldWidget/MultiSelect2BoxesAutocompleteWidget.php, line 29

Namespace

Drupal\select2boxes\Plugin\Field\FieldWidget
View source 
class MultiSelect2BoxesAutocompleteWidget extends OptionsSelectWidget {
  use PreloadBuildTrait;
  use FlatteningOptionsTrait;
  use AutoCreationProcessTrait;

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $this
      ->flatteningOptions($element['#options']);
    $field_name = $this->fieldDefinition
      ->getName();

    // Because this field might be used in a paragraph, we have to make sure
    // that the identifier sent to initValues is based on the parent field.
    $identifiers = isset($element['#field_parents']) ? $element['#field_parents'] : [];
    $identifiers[] = $field_name;
    $fieldIdentifier = implode('_', $identifiers);
    $element['#attributes'] = [
      // Disable core autocomplete.
      'data-jquery-once-autocomplete' => 'true',
      'data-select2-multiple' => 'true',
      'data-autocomplete-path' => $this
        ->getAutocompletePath(),
      'class' => [
        'select2-widget',
        'select2-boxes-widget',
      ],
      'data-field-name' => $fieldIdentifier,
    ];

    // Pass an additional data attribute
    // to let select2 JS know whether it should handle input
    // for auto-create or not.
    $settings = $this
      ->getFieldSettings();
    if (isset($settings['handler_settings']['auto_create']) && $settings['handler_settings']['auto_create'] == TRUE) {
      $element['#attributes']['data-auto-create-entity'] = 'enabled';
    }

    // Process the auto-creation when the input data is being gathered.
    $element['#select2'] = [
      'fieldName' => $field_name,
    ] + $settings;
    $element['#value_callback'] = [
      get_class($this),
      'processAutoCreation',
    ];

    // Attach library.
    $element['#attached']['library'][] = 'select2boxes/widget';

    // Get third party settings.
    $settings = $this
      ->getThirdPartySettings('select2boxes');
    if (isset($settings['enable_preload']) && $settings['enable_preload'] == '1') {
      $this
        ->attachPreload($element['#attached'], $settings['preload_count'], $this->fieldDefinition);
    }
    $element['#needs_validation'] = FALSE;
    $element['#multiple'] = $element['#validated'] = TRUE;
    $element['#attached']['drupalSettings']['initValues'][$fieldIdentifier] = $this
      ->buildInitValues($items);
    $element['#options'] = array_intersect_key($element['#options'], array_flip($this
      ->getSelectedOptions($items)));
    return $element;
  }

  /**
   * Build initial values.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   Field items object.
   *
   * @return array
   *   Initial values array.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function buildInitValues(FieldItemListInterface $items) {

    // Prepare required keys, from the entity type definitions.
    $target_type = $this
      ->getFieldSetting('target_type');
    $definition = \Drupal::entityTypeManager()
      ->getDefinition($target_type);
    $id_key = $definition
      ->getKey('id');
    $label_key = $definition
      ->getKey('label');

    // Workaround for User entity type since it doesn't have label entity key.
    if ($target_type == 'user') {
      $label_key = 'name';
    }
    $ids = [];
    $data_table = $definition
      ->getDataTable();

    /** @var \Drupal\Core\Field\EntityReferenceFieldItemList $items */

    /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item */
    foreach ($items
      ->getIterator() as $item) {
      $value = $item
        ->getValue();
      if (!empty($value) && isset($value['target_id'])) {
        $ids[] = $item
          ->getValue()['target_id'];
      }
    }
    if (empty($ids)) {
      return [];
    }
    $select = \Drupal::database()
      ->select($data_table, 'init');
    $select
      ->fields('init', [
      $id_key,
      $label_key,
    ]);
    $select
      ->condition($id_key, $ids, 'IN');
    $entities = $select
      ->execute()
      ->fetchAllKeyed();

    // Additional fix for User entity - Anonymous users
    // has no value for "name" column in the database, so we attach it manually.
    if ($target_type == 'user' && !empty($entities) && isset($entities[0])) {
      $entities[0] = $this
        ->t('Anonymous');
    }
    return !empty($entities) ? $entities : [];
  }

  /**
   * Get entity autocomplete path.
   *
   * @return \Drupal\Core\GeneratedUrl|string
   *   Entity autocomplete path.
   */
  protected function getAutocompletePath() {

    // Store the selection settings in the key/value store and pass a hashed key
    // in the route parameters.
    $selection_settings = $this
      ->getFieldSetting('handler_settings');
    $data = serialize($selection_settings) . $this
      ->getFieldSetting('target_type') . $this
      ->getFieldSetting('handler');
    $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
    $key_value_storage = \Drupal::keyValue('entity_autocomplete');
    if (!$key_value_storage
      ->has($selection_settings_key)) {
      $key_value_storage
        ->set($selection_settings_key, $selection_settings);
    }
    $params = [
      'target_type' => $this
        ->getFieldSetting('target_type'),
      'selection_handler' => $this
        ->getFieldSetting('handler'),
      'selection_settings_key' => $selection_settings_key,
    ];
    return Url::fromRoute('system.entity_autocomplete', $params)
      ->toString();
  }

  /**
   * Attach preloaded data.
   *
   * @param array &$attached
   *   Attached form element.
   * @param int $count
   *   Number of entries will be preloaded.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $fieldDefinition
   *   The field definition.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function attachPreload(array &$attached, $count, FieldDefinitionInterface $fieldDefinition) {
    $attached['drupalSettings']['preloaded_entries'][$fieldDefinition
      ->getName()] = $this
      ->buildPreLoaded($count, $fieldDefinition);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
AutoCreationProcessTrait::processAutoCreation public static function Process the auto-creations and then normalise the input.
AutoCreationProcessTrait::processValueItem private static function Process value item.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityCreationTrait::getEntity protected static function Get an entity by its ID and entity type.
EntityCreationTrait::getEntityStorage private static function Get entity storage handler for specified entity type.
EntityCreationTrait::getOrCreateEntity protected static function Get an entity by its properties, or create it if it doesn't exist.
FlatteningOptionsTrait::flatteningOptions protected function Flattening multi-bundled options to prevent possible collisions.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MultiSelect2BoxesAutocompleteWidget::attachPreload protected function Attach preloaded data.
MultiSelect2BoxesAutocompleteWidget::buildInitValues protected function Build initial values.
MultiSelect2BoxesAutocompleteWidget::formElement public function Returns the form for a single field widget. Overrides OptionsSelectWidget::formElement
MultiSelect2BoxesAutocompleteWidget::getAutocompletePath protected function Get entity autocomplete path.
OptionsSelectWidget::getEmptyLabel protected function Returns the empty option label to add to the list of options, if any. Overrides OptionsWidgetBase::getEmptyLabel
OptionsSelectWidget::sanitizeLabel protected function Sanitizes a string label to display as an option. Overrides OptionsWidgetBase::sanitizeLabel
OptionsSelectWidget::supportsGroups protected function Indicates whether the widgets support optgroups. Overrides OptionsWidgetBase::supportsGroups
OptionsWidgetBase::$column protected property Abstract over the actual field columns, to allow different field types to reuse those widgets.
OptionsWidgetBase::getOptions protected function Returns the array of options for the widget.
OptionsWidgetBase::getSelectedOptions protected function Determines selected options from the incoming field values.
OptionsWidgetBase::validateElement public static function Form validation handler for widget elements. 1
OptionsWidgetBase::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct 1
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 3
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
PreloadBuildTrait::buildPreLoaded protected function Build preloaded entries list.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState