You are here

Home » API reference » CCK Select Other 8 » SelectOtherWidget.php

class SelectOtherWidget in CCK Select Other 8

Plugin implementation of the 'cck_select_other' widget.

Plugin annotation


@FieldWidget(
  id = "cck_select_other",
  label = @Translation("Select other list"),
  field_types = {
    "list_integer",
    "list_float",
    "list_string"
  }
)

Hierarchy

Expanded class hierarchy of SelectOtherWidget

File

src/Plugin/Field/FieldWidget/SelectOtherWidget.php, line 25

Namespace

Drupal\cck_select_other\Plugin\Field\FieldWidget
View source 
class SelectOtherWidget extends OptionsWidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'other_label' => t('Other'),
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('other_label')) {
      $summary[] = t('Other label is @label', [
        '@label' => $this
          ->getSetting('other_label'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['other_label'] = [
      '#type' => 'textfield',
      '#title' => t('Other label'),
      '#description' => t('Provide an alternate label for "Other".'),
      '#default_value' => $this
        ->getSetting('other_label'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $defaults = $this
      ->getDefaultValue($items, $element['#delta']);
    $field_item_name = str_replace('_', '-', $this->fieldDefinition
      ->getName() . '-' . $element['#delta']);

    // Setup select other wrapper.
    $element += [
      '#attributes' => [
        'class' => [
          'form-select-other-wrapper',
          'cck-select-other-wrapper',
        ],
      ],
      '#attached' => [
        'library' => [
          'cck_select_other/widget',
        ],
        'drupalSettings' => [
          'CCKSelectOther' => [
            $this->fieldDefinition
              ->getName() => [
              $delta => $field_item_name,
            ],
          ],
        ],
      ],
    ];

    // Setup select list.
    $element['select_other_list'] = [
      '#title' => $element['#title'],
      '#description' => $element['#description'],
      '#type' => 'select',
      '#options' => $this
        ->getOptions($items
        ->getEntity()),
      '#default_value' => $defaults['select'],
      '#required' => $this->fieldDefinition
        ->isRequired(),
      '#attributes' => [
        'class' => [
          'form-text form-select',
          'form-select-other-list',
        ],
      ],
    ];

    // Setup text input.
    $element['select_other_text_input'] = [
      '#type' => 'textfield',
      '#title' => t('Provide other option'),
      '#title_display' => 'invisible',
      '#default_value' => $defaults['textfield'],
      '#size' => 60,
      '#attributes' => [
        'class' => [
          'form-text',
          'form-select-other-text-input',
        ],
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function validateElement(array $element, FormStateInterface $form_state) {
    $form_state_values = $form_state
      ->getValues();
    $values = NestedArray::getValue($form_state_values, $element['#parents']);
    if (!$element['select_other_list']['#required'] && $values['select_other_list'] == '_none') {

      // Empty select list option.
      $form_state
        ->setValueForElement($element, [
        'value' => NULL,
      ]);
    }
    elseif ($element['select_other_list']['#required'] && $values['select_other_list'] == '') {

      // Empty select list option for required field.
      $form_state
        ->setValueForElement($element, [
        'value' => '',
      ])
        ->setError($element, t('You must select an option.'));
    }
    elseif ($element['select_other_list']['#required'] && $values['select_other_list'] == 'other' && !$values['select_other_text_input']) {

      // Empty text input for required field.
      $form_state
        ->setValueForElement($element, [
        'value' => NULL,
      ])
        ->setError($element['select_other_text_input'], t('You must provide a value for this option.'));
    }
    elseif ($values['select_other_list'] == 'other' && $values['select_other_text_input']) {

      // Non-empty text input value.
      $form_state
        ->setValueForElement($element, [
        'value' => $values['select_other_text_input'],
      ]);
    }
    elseif ($values['select_other_list'] == 'other' && !$values['select_other_text_input']) {

      // Empty text for non-required field.
      $form_state
        ->setValueForELement($element, [
        'value' => NULL,
      ]);
    }
    elseif (!isset($element['select_other_list']['#options'][$values['select_other_list']])) {

      // Non-empty select list value is not in #options. Fail validation before
      // Field constraint can get to it as we MUST override that completely
      // because DrupalWTF.
      $form_state
        ->setError($element['select_other_list'], t('The value you selected is not a valid choice.'));
    }
    else {

      // Non-empty select list value.
      $form_state
        ->setValueForElement($element, [
        'value' => $values['select_other_list'],
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function sanitizeLabel(&$label) {

    // Select form inputs allow unencoded HTML entities, but no HTML tags.
    $label = strip_tags($label);
  }

  /**
   * {@inheritdoc}
   */
  protected function supportsGroups() {
    return TRUE;
  }

  /**
   * Get the default values from the items for the form elements.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   FieldInterface items.
   * @param int $delta
   *   The field item to extract.
   *
   * @return array
   *   An associative array containing the default value for the select element
   *   the default value for the textfield element.
   */
  protected function getDefaultValue(FieldItemListInterface $items, $delta = 0) {
    $item =& $items[$delta];
    $option_keys = [];
    $options = $this
      ->getOptions($items
      ->getEntity());
    if (!empty($options)) {
      $option_keys = array_keys($options);
    }
    if (!$item->{$this->column}) {
      $values = [
        'select' => $this->fieldDefinition
          ->isRequired() ? '' : '_none',
        'textfield' => '',
      ];
    }
    elseif (in_array($item->{$this->column}, $option_keys)) {
      $values = [
        'select' => $item->{$this->column},
        'textfield' => '',
      ];
    }
    else {
      $values = [
        'select' => 'other',
        'textfield' => $item->{$this->column},
      ];
    }
    return $values;
  }

  /**
   * {@inheritdoc}
   *
   * Add the Other option to the allowed values to form the select list option
   * array.
   *
   * This method MUST override OptionsWidgetBase because that class is tightly
   * coupled with its options widgets. DrupalWTF.
   */
  protected function getOptions(FieldableEntityInterface $entity) {
    if (!isset($this->options)) {

      // Limit the settable options for the current user account.
      $options = $this->fieldDefinition
        ->getFieldStorageDefinition()
        ->getOptionsProvider($this->column, $entity)
        ->getSettableOptions(\Drupal::currentUser());
      $options['other'] = Html::escape($this
        ->getSetting('other_label'));

      // Add an empty option if the widget needs one.
      if ($empty_option = $this
        ->getEmptyOption()) {
        $options = [
          '_none' => $empty_option,
        ] + $options;
      }
      $module_handler = \Drupal::moduleHandler();
      $context = [
        'fieldDefinition' => $this->fieldDefinition,
        'entity' => $entity,
      ];
      $module_handler
        ->alter('options_list', $options, $context);
      array_walk_recursive($options, [
        $this,
        'sanitizeLabel',
      ]);

      // Options might be nested ("optgroups"). If the widget does not support
      // nested options, flatten the list.
      if (!$this
        ->supportsGroups()) {
        $options = $this
          ->flattenOptions($options);
      }
      $this->options = $options;
    }
    return $this->options;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEmptyOption() {
    if (!$this->required) {
      return t('- None -');
    }
    if (!$this->has_value) {
      return t('- Select a value -');
    }
  }

}

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.
OptionsWidgetBase::$column protected property Abstract over the actual field columns, to allow different field types to reuse those widgets.
OptionsWidgetBase::getEmptyLabel protected function Returns the empty option label to add to the list of options, if any. 2
OptionsWidgetBase::getSelectedOptions protected function Determines selected options from the incoming field values.
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
SelectOtherWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SelectOtherWidget::formElement public function Returns the form for a single field widget. Overrides OptionsWidgetBase::formElement
SelectOtherWidget::getDefaultValue protected function Get the default values from the items for the form elements.
SelectOtherWidget::getEmptyOption protected function
SelectOtherWidget::getOptions protected function Add the Other option to the allowed values to form the select list option array. Overrides OptionsWidgetBase::getOptions
SelectOtherWidget::sanitizeLabel protected function Sanitizes a string label to display as an option. Overrides OptionsWidgetBase::sanitizeLabel
SelectOtherWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
SelectOtherWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
SelectOtherWidget::supportsGroups protected function Indicates whether the widgets support optgroups. Overrides OptionsWidgetBase::supportsGroups
SelectOtherWidget::validateElement public static function Form validation handler for widget elements. Overrides OptionsWidgetBase::validateElement
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::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState