You are here

Home » API reference » jQuery UI MultiSelect Widget 8 » JqueryUIMultiSelectWidget.php

class JqueryUIMultiSelectWidget in jQuery UI MultiSelect Widget 8

Plugin implementation of the 'boolean_checkbox' widget.

Plugin annotation


@FieldWidget(
  id = "jquery_ui_multiselect_widget",
  label = @Translation("Jquery UI Multi Select"),
  field_types = {
    "entity_reference",
    "list_integer",
    "list_float",
    "list_string"
  },
  multiple_values = TRUE
)

Hierarchy

Expanded class hierarchy of JqueryUIMultiSelectWidget

File

src/Plugin/Field/FieldWidget/JqueryUIMultiSelectWidget.php, line 30
Contains \Drupal\jquery_ui_multiselect_widget\Plugin\Field\FieldWidget\JqueryUIMultiSelectWidget.

Namespace

Drupal\jquery_ui_multiselect_widget\Plugin\Field\FieldWidget
View source 
class JqueryUIMultiSelectWidget extends OptionsSelectWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'jquery_ui_multiselect_widget_show_header' => FALSE,
      'jquery_ui_multiselect_widget_show_filter' => FALSE,
      'jquery_ui_multiselect_widget_filter_placeholder' => '',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $element, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $element['jquery_ui_multiselect_widget_show_header'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show header'),
      '#default_value' => $this
        ->getSetting('jquery_ui_multiselect_widget_show_header'),
    );
    $element['jquery_ui_multiselect_widget_show_filter'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show filter'),
      '#default_value' => $this
        ->getSetting('jquery_ui_multiselect_widget_show_filter'),
    );
    $element['jquery_ui_multiselect_widget_filter_placeholder'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Filter placeholder text'),
      '#default_value' => $this
        ->getSetting('jquery_ui_multiselect_widget_filter_placeholder'),
      '#states' => [
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][jquery_ui_multiselect_widget_show_filter]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ],
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element['#attached'] = [
      'library' => [
        'jquery_ui_multiselect_widget/jquery_ui_multiselect_widget.js',
        'jquery_ui_multiselect_widget/jquery_ui_multiselect_widget.css',
      ],
      'drupalSettings' => [
        'jquery_ui_multiselect_widget' => [
          $items
            ->getName() => [
            'header' => $this
              ->getSetting('jquery_ui_multiselect_widget_show_header'),
            'filter' => $this
              ->getSetting('jquery_ui_multiselect_widget_show_filter'),
            'filter_placeholder' => $this
              ->getSetting('jquery_ui_multiselect_widget_filter_placeholder'),
            'cardinality' => $this->fieldDefinition
              ->getFieldStorageDefinition()
              ->getCardinality(),
          ],
        ],
      ],
    ];
    return parent::formElement($items, $delta, $element, $form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {

    // Applicable only for items having cardinality more than 1.
    return $field_definition
      ->getFieldStorageDefinition()
      ->isMultiple();
  }

}

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
JqueryUIMultiSelectWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
JqueryUIMultiSelectWidget::formElement public function Returns the form for a single field widget. Overrides OptionsSelectWidget::formElement
JqueryUIMultiSelectWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
JqueryUIMultiSelectWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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::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
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::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::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