You are here

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

class Select2BoxesAutocompleteListWidget in Select2 Boxes 8

Class Select2BoxesAutocompleteList.

@FieldWidget( id = "select2boxes_autocomplete_list", label = @Translation("Select2 boxes"), description = @Translation("An autocomplete list field."), field_types = { "list_integer", "list_float", "list_string", "language_field", "language", "country", }, multiple_values = TRUE )

@package Drupal\select2boxes\Plugin\Field\FieldWidget

Hierarchy

Expanded class hierarchy of Select2BoxesAutocompleteListWidget

File

src/Plugin/Field/FieldWidget/Select2BoxesAutocompleteListWidget.php, line 32

Namespace

Drupal\select2boxes\Plugin\Field\FieldWidget
View source 
class Select2BoxesAutocompleteListWidget extends OptionsSelectWidget {
  use MinSearchLengthTrait;

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Since country field options are built in the different way
    // - we have to specify options array manually
    // using country manager service.
    // Same thing for language field.
    if ($this->fieldDefinition
      ->getType() === 'country') {
      $this
        ->setCountriesList();
    }
    elseif ($this->fieldDefinition
      ->getType() === 'language') {
      $this
        ->setLanguagesList();
    }
    $element = parent::formElement($items, $delta, $element, $form, $form_state);

    // Add required attributes for the select2 autocomplete.
    $element['#attributes'] = [
      // Disable core autocomplete.
      'data-jquery-once-autocomplete' => 'true',
      'data-select2-autocomplete-list-widget' => 'true',
      'class' => [
        'select2-widget',
      ],
    ];

    // Remove "- None -" option in case of multiple values field setting.
    if ($this->fieldDefinition
      ->getFieldStorageDefinition()
      ->isMultiple()) {
      unset($element['#options']['_none']);
      $element['#attributes']['data-select2-multiple'] = 'true';
    }

    // Small workaround for the core's built-in language field.
    if ($this->fieldDefinition
      ->getType() === 'language') {

      // Rebuild options list using full list of the language options.
      $languages = \Drupal::languageManager()
        ->getLanguages(LanguageInterface::STATE_ALL);
      $element['#options'] = array_map(function ($language) {

        /** @var \Drupal\Core\Language\LanguageInterface $language */
        return $language
          ->getName();
      }, $languages);

      // Set the default value from the editing entity.
      if ($items
        ->getEntity() instanceof EntityInterface) {
        $element['#default_value'] = $items
          ->getEntity()
          ->language()
          ->getId();
      }
    }

    // Handle country icons if needed for Flag's sub-modules.
    $this
      ->includeFlagsIcons($element);

    // Set the additional attribute for limiting
    // the search input visibility if specified.
    $this
      ->limitSearchByMinLength($element['#attributes']);

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

  /**
   * Include flags icons to the options.
   *
   * If the "Include flag icons" option is enabled.
   *
   * @param array &$element
   *   Element's render array.
   */
  protected function includeFlagsIcons(array &$element) {

    // Include flags is only possible if flags module enabled,
    // field type is one of the 'language_field', 'language', 'country'
    // and an appropriate setting in the fields widget form has been enabled.
    $types = [
      'language_field',
      'language',
      'country',
    ];
    if (\Drupal::moduleHandler()
      ->moduleExists('flags') && in_array($this->fieldDefinition
      ->getType(), $types) && $this
      ->getThirdPartySetting('select2boxes', 'enable_flags') == '1') {

      // Create a map of country or language dependent classes.
      $flags = [];
      $mapper = $this->fieldDefinition
        ->getType() == 'country' ? \Drupal::service('flags.mapping.country') : \Drupal::service('flags.mapping.language');
      foreach (array_keys($element['#options']) as $key) {
        $flags[$key] = [
          'flag',
          'flag-' . $mapper
            ->map($key),
          $mapper
            ->getExtraClasses()[0],
        ];
      }

      // Merge these values to have all countries
      // and languages flags in the same place to prevent missing flags icons.
      if (!isset($element['#attached']['drupalSettings']['flagsClasses'])) {
        $element['#attached']['drupalSettings']['flagsClasses'] = [];
      }
      $element['#attached']['drupalSettings']['flagsClasses'] += $flags;
      $element['#attached']['drupalSettings']['flagsFields'][$this->fieldDefinition
        ->getName()] = TRUE;
      $element['#attached']['library'][] = 'flags/flags';
    }
  }

  /**
   * Specifies the languages list options if needed.
   */
  protected function setLanguagesList() {
    if (!isset($this->options)) {

      // Specify the default "none" option in case of using single-value widget.
      $this->options = [
        '_none' => $this
          ->t('- None -'),
      ];

      // Add the languages list using language manager service.
      $this->options += array_map(function ($language) {

        /** @var \Drupal\Core\Language\LanguageInterface $language */
        return $language
          ->getName();
      }, \Drupal::languageManager()
        ->getLanguages());
    }
  }

  /**
   * Specifies the countries list options if needed.
   */
  protected function setCountriesList() {
    if (!isset($this->options)) {

      // Specify the default "none" option in case of using single-value widget.
      $this->options = [
        '_none' => $this
          ->t('- None -'),
      ];

      // Add the countries list using country manager service.
      $this->options += \Drupal::service('country_manager')
        ->getList();
    }
  }

}

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.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MinSearchLengthTrait::limitSearchByMinLength protected function Limit search input visibility by results length.
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
Select2BoxesAutocompleteListWidget::formElement public function Returns the form for a single field widget. Overrides OptionsSelectWidget::formElement
Select2BoxesAutocompleteListWidget::includeFlagsIcons protected function Include flags icons to the options.
Select2BoxesAutocompleteListWidget::setCountriesList protected function Specifies the countries list options if needed.
Select2BoxesAutocompleteListWidget::setLanguagesList protected function Specifies the languages list options if needed.
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