OptionsBase.php in Webform 8.5

Same filename and directory in other branches
6.x src/Plugin/WebformElement/OptionsBase.php
Namespace

File

src/Plugin/WebformElement/OptionsBase.php
View source
<?php

namespace Drupal\webform\Plugin\WebformElement;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Form\OptGroup;
use Drupal\Core\Mail\MailFormatHelper;
use Drupal\Core\Render\Markup;
use Drupal\webform\Utility\WebformArrayHelper;
use Drupal\webform\Utility\WebformElementHelper;
use Drupal\webform\Utility\WebformOptionsHelper;
use Drupal\webform\Plugin\WebformElementBase;
use Drupal\webform\Plugin\WebformElementEntityReferenceInterface;
use Drupal\webform\Plugin\WebformElementOtherInterface;
use Drupal\webform\WebformSubmissionConditionsValidator;
use Drupal\webform\WebformSubmissionInterface;

/**
 * Provides a base 'options' element.
 */
abstract class OptionsBase extends WebformElementBase {
  use TextBaseTrait;

  /**
   * Export delta for multiple options.
   *
   * @var bool
   */
  protected $exportDelta = FALSE;

  /**
   * The other option base element type.
   *
   * @var string
   */
  protected $otherOptionType;

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = [
      // Options settings.
      'options' => [],
      'options_randomize' => FALSE,
    ] + parent::defineDefaultProperties();

    // Add other properties to elements that include the other text field.
    if ($this
      ->isOptionsOther()) {
      $properties += [
        'other__option_label' => $this
          ->t('Other…'),
        'other__type' => 'textfield',
        'other__title' => '',
        'other__placeholder' => $this
          ->t('Enter other…'),
        'other__description' => '',
        // Text field or textarea.
        'other__size' => '',
        'other__maxlength' => '',
        'other__field_prefix' => '',
        'other__field_suffix' => '',
        // Textarea.
        'other__rows' => '',
        // Number.
        'other__min' => '',
        'other__max' => '',
        'other__step' => '',
        // Counter.
        'other__counter_type' => '',
        'other__counter_minimum' => '',
        'other__counter_minimum_message' => '',
        'other__counter_maximum' => '',
        'other__counter_maximum_message' => '',
        // Wrapper.
        'wrapper_type' => 'fieldset',
      ];
    }
    return $properties;
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function isMultiline(array $element) {
    $items_format = $this
      ->getItemsFormat($element);
    if (strpos($items_format, 'checklist:') === 0) {
      return TRUE;
    }
    else {
      return parent::isMultiline($element);
    }
  }

  /**
   * Determine if the element plugin type includes an other option text field.
   *
   * @return bool
   *   TRUE if the element plugin type includes an other option text field.
   */
  protected function isOptionsOther() {
    return $this
      ->getOptionsOtherType() ? TRUE : FALSE;
  }

  /**
   * Get the other option base element type.
   *
   * @return string|null
   *   The base element type (select|radios|checkboxes|buttons).
   */
  protected function getOptionsOtherType() {
    if (isset($this->otherOptionType)) {
      return $this->otherOptionType;
    }
    if (preg_match('/webform_(select|radios|checkboxes|buttons)_other$/', $this
      ->getPluginId(), $match)) {
      $this->otherOptionType = $match[1];
    }
    else {
      $this->otherOptionType = FALSE;
    }
    return $this->otherOptionType;
  }

  /**
   * {@inheritdoc}
   */
  protected function defineTranslatableProperties() {
    return array_merge(parent::defineTranslatableProperties(), [
      'options',
      'empty_option',
      'option_label',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getRelatedTypes(array $element) {
    $related_types = parent::getRelatedTypes($element);

    // Remove entity reference elements.
    $elements = $this->elementManager
      ->getInstances();
    foreach ($related_types as $type => $related_type) {
      $element_instance = $elements[$type];
      if ($element_instance instanceof WebformElementEntityReferenceInterface) {
        unset($related_types[$type]);
      }
    }
    return $related_types;
  }

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    $is_wrapper_fieldset = in_array($element['#type'], [
      'checkboxes',
      'radios',
      'webform_entity_checkboxes',
      'webform_entity_radios',
      'webform_term_checkboxes',
      'webform_toggles',
      'webform_buttons',
    ]);
    if ($is_wrapper_fieldset) {

      // Issue #2396145: Option #description_display for webform element fieldset
      // is not changing anything.
      // @see core/modules/system/templates/fieldset.html.twig
      $is_description_display = isset($element['#description_display']) ? TRUE : FALSE;
      $has_description = !empty($element['#description']) ? TRUE : FALSE;
      if ($is_description_display && $has_description) {
        $description = WebformElementHelper::convertToString($element['#description']);
        switch ($element['#description_display']) {
          case 'before':
            $element += [
              '#field_prefix' => '',
            ];
            $element['#field_prefix'] = '<div class="description">' . $description . '</div>' . $element['#field_prefix'];
            unset($element['#description']);
            unset($element['#description_display']);
            break;
          case 'tooltip':
            $element += [
              '#field_suffix' => '',
            ];
            $element['#field_suffix'] .= '<div class="description visually-hidden">' . $description . '</div>';

            // @see \Drupal\Core\Render\Element\CompositeFormElementTrait
            // @see \Drupal\webform\Plugin\WebformElementBase::prepare
            $element['#attributes']['class'][] = 'js-webform-tooltip-element';
            $element['#attributes']['class'][] = 'webform-tooltip-element';
            $element['#attached']['library'][] = 'webform/webform.tooltip';
            unset($element['#description']);
            unset($element['#description_display']);
            break;
          case 'invisible':
            $element += [
              '#field_suffix' => '',
            ];
            $element['#field_suffix'] .= '<div class="description visually-hidden">' . $description . '</div>';
            unset($element['#description']);
            unset($element['#description_display']);
            break;
        }
      }
    }
    parent::prepare($element, $webform_submission);

    // Randomize options.
    if (isset($element['#options']) && !empty($element['#options_randomize'])) {
      $element['#options'] = WebformElementHelper::randomize($element['#options']);
    }

    // Options description display must be set to trigger the description display.
    if ($this
      ->hasProperty('options_description_display') && empty($element['#options_description_display'])) {
      $element['#options_description_display'] = $this
        ->getDefaultProperty('options_description_display');
    }

    // Options display must be set to trigger the options display.
    if ($this
      ->hasProperty('options_display') && empty($element['#options_display'])) {
      $element['#options_display'] = $this
        ->getDefaultProperty('options_display');
    }

    // Make sure submitted value is not lost if the element's #options were
    // altered after the submission was completed.
    // This only applies to the main webforom element with a #webform_key
    // and not a webform composite's sub elements.
    $is_completed = $webform_submission && $webform_submission
      ->isCompleted();
    $has_default_value = isset($element['#default_value']) && $element['#default_value'] !== '' && $element['#default_value'] !== NULL;
    if ($is_completed && $has_default_value && !$this
      ->isOptionsOther() && isset($element['#webform_key'])) {
      if ($element['#default_value'] === $webform_submission
        ->getElementData($element['#webform_key'])) {
        $options = OptGroup::flattenOptions($element['#options']);
        $default_values = (array) $element['#default_value'];
        foreach ($default_values as $default_value) {
          if (!isset($options[$default_value])) {
            $element['#options'][$default_value] = $default_value;
          }
        }
      }
    }

    // If the element is #required and the #default_value is an empty string
    // we need to unset the #default_value to prevent the below error.
    // 'An illegal choice has been detected'.
    if (!empty($element['#required']) && isset($element['#default_value']) && $element['#default_value'] === '') {
      unset($element['#default_value']);
    }

    // Process custom options properties.
    if ($this
      ->hasProperty('options__properties')) {
      $this
        ->setElementDefaultCallback($element, 'process');
      $element['#process'][] = [
        get_class($this),
        'processOptionsProperties',
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareElementValidateCallbacks(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    if ($this
      ->hasMultipleValues($element)) {
      $element['#element_validate'][] = [
        get_class($this),
        'validateMultipleOptions',
      ];
    }
    parent::prepareElementValidateCallbacks($element, $webform_submission);
  }

  /**
   * Processes options (custom) properties.
   */
  public static function processOptionsProperties(&$element, FormStateInterface $form_state, &$complete_form) {
    if (empty($element['#options__properties'])) {
      return $element;
    }
    foreach ($element['#options__properties'] as $option_key => $options__properties) {
      if (!isset($element[$option_key]) || !is_array($options__properties)) {
        continue;
      }

      // Remove ignored properties.
      $options__properties = WebformElementHelper::removeIgnoredProperties($options__properties);
      foreach ($options__properties as $property => $value) {
        $option_element =& $element[$option_key];
        if (in_array($property, [
          '#attributes',
          '#wrapper_attributes',
          '#label_attributes',
        ])) {

          // Apply attributes.
          $option_element += [
            $property => [],
          ];
          foreach ($value as $attribute_name => $attribute_value) {

            // Merge attributes class.
            if ($attribute_name === 'class' && isset($element[$option_key][$property][$attribute_name])) {
              $option_element[$property][$attribute_name] = array_merge($element[$option_key][$property][$attribute_name], $attribute_value);
            }
            else {
              $option_element[$property][$attribute_name] = $attribute_value;
            }
          }
        }
        else {
          $option_element[$property] = $value;
        }
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function hasMultipleWrapper() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultValue(array &$element) {
    if (!isset($element['#default_value'])) {
      return;
    }

    // Compensate for #default_value not being an array, for elements that
    // allow for multiple #options to be selected/checked.
    if ($this
      ->hasMultipleValues($element) && !is_array($element['#default_value'])) {
      $element['#default_value'] = [
        $element['#default_value'],
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function formatHtmlItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $value = $this
      ->getValue($element, $webform_submission, $options);
    $format = $this
      ->getItemFormat($element);
    switch ($format) {
      case 'raw':
        return $value;
      case 'description':
        if (isset($element['#options'])) {
          $options_description = $this
            ->hasProperty('options_description_display');
          if ($options_description) {
            $description = WebformOptionsHelper::getOptionDescription($value, $element['#options'], $options_description);
            return [
              '#markup' => $description,
            ];
          }
        }
        return '';
      case 'value':
      default:
        if (isset($element['#options'])) {
          $options_description = $this
            ->hasProperty('options_description_display');
          $value = WebformOptionsHelper::getOptionText($value, $element['#options'], $options_description);
        }

        // Build a render array that uses #plain_text so that
        // HTML characters are escaped.
        // @see \Drupal\Core\Render\Renderer::ensureMarkupIsSafe
        if ($value === '0') {

          // Issue #2765609: #plain_text doesn't render empty-like values
          // (e.g. 0 and "0").
          // Workaround: Use #markup until this issue is fixed.
          // @todo Remove workaround once only Drupal 8.7.x is supported.
          $build = [
            '#markup' => $value,
          ];
        }
        else {
          $build = [
            '#plain_text' => $value,
          ];
        }
        $options += [
          'prefixing' => TRUE,
        ];
        if ($options['prefixing']) {
          if (isset($element['#field_prefix'])) {
            $build['#prefix'] = $element['#field_prefix'];
          }
          if (isset($element['#field_suffix'])) {
            $build['#suffix'] = $element['#field_suffix'];
          }
        }
        return $build;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function formatTextItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $value = $this
      ->getValue($element, $webform_submission, $options);
    $format = $this
      ->getItemFormat($element);
    switch ($format) {
      case 'raw':
        return $value;
      case 'description':
        if (isset($element['#options'])) {
          $options_description = $this
            ->hasProperty('options_description_display');
          if ($options_description) {
            $description = WebformOptionsHelper::getOptionDescription($value, $element['#options'], $options_description);
            if ($description) {
              return MailFormatHelper::htmlToText($description);
            }
          }
        }
        return '';
      case 'value':
      default:
        if (isset($element['#options'])) {
          $options_description = $this
            ->hasProperty('options_description_display');
          $value = WebformOptionsHelper::getOptionText($value, $element['#options'], $options_description);
        }
        $options += [
          'prefixing' => TRUE,
        ];
        if ($options['prefixing']) {
          if (isset($element['#field_prefix'])) {
            $value = strip_tags($element['#field_prefix']) . $value;
          }
          if (isset($element['#field_suffix'])) {
            $value .= strip_tags($element['#field_suffix']);
          }
        }
        return $value;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getItemFormats() {
    return parent::getItemFormats() + [
      'description' => $this
        ->t('Option description'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getItemsDefaultFormat() {
    return 'comma';
  }

  /**
   * {@inheritdoc}
   */
  protected function formatHtmlItems(array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $format = $this
      ->getItemsFormat($element);
    if (strpos($format, 'checklist:') === 0) {

      // Get checked/unchecked icons.
      list(, $checked_type) = explode(':', $format);
      switch ($checked_type) {
        case 'crosses':
          $checked = '✖ ';
          $unchecked = '⚬ ';
          break;
        default:
        case 'boxes':
          $checked = Markup::create('<span style="font-size: 1.4em; line-height: 1em">☑</span> ');
          $unchecked = Markup::create('<span style="font-size: 1.4em; line-height: 1em">☐</span> ');
          break;
      }
      $value = (array) $this
        ->getValue($element, $webform_submission, $options);
      $values = array_combine($value, $value);

      // Build list of checked and unchecked options.
      $build = [];
      $options_description = $this
        ->hasProperty('options_description_display');
      $flattened_options = OptGroup::flattenOptions($element['#options']);
      foreach ($flattened_options as $option_value => $option_text) {
        if ($options_description && WebformOptionsHelper::hasOptionDescription($option_text)) {
          list($option_text) = WebformOptionsHelper::splitOption($option_text);
        }
        $build[$option_value] = [
          '#prefix' => isset($values[$option_value]) ? $checked : $unchecked,
          '#markup' => $option_text,
          '#suffix' => '<br/>',
        ];
        unset($values[$option_value]);
      }

      // Append all remaining option values.
      foreach ($values as $value) {
        $build[$value] = [
          '#prefix' => $checked,
          '#markup' => $value,
          '#suffix' => '<br/>',
        ];
      }
      return $build;
    }
    else {
      return parent::formatHtmlItems($element, $webform_submission, $options);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function formatTextItems(array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $format = $this
      ->getItemsFormat($element);
    if (strpos($format, 'checklist:') === 0) {

      // Get checked/unchecked icons.
      list(, $checked_type) = explode(':', $format);
      switch ($checked_type) {
        case 'crosses':
          $checked = '✖';
          $unchecked = '⚬';
          break;
        default:
        case 'boxes':
          $checked = '☑';
          $unchecked = '☐';
          break;
      }
      $value = (array) $this
        ->getValue($element, $webform_submission, $options);
      $values = array_combine($value, $value);

      // Build list of checked and unchecked options.
      $list = [];
      $options_description = $this
        ->hasProperty('options_description_display');
      $flattened_options = OptGroup::flattenOptions($element['#options']);
      foreach ($flattened_options as $option_value => $option_text) {
        if ($options_description && WebformOptionsHelper::hasOptionDescription($option_text)) {
          list($option_text) = WebformOptionsHelper::splitOption($option_text);
        }
        $list[] = (isset($values[$option_value]) ? $checked : $unchecked) . ' ' . $option_text;
        unset($values[$option_value]);
      }

      // Append all remaining option values.
      foreach ($values as $value) {
        $list[] = $checked . ' ' . $value;
      }
      return implode(PHP_EOL, $list);
    }
    else {
      return parent::formatTextItems($element, $webform_submission, $options);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getItemsFormats() {
    return parent::getItemsFormats() + [
      'checklist:boxes' => $this
        ->t('Checklist (☑/☐)'),
      'checklist:crosses' => $this
        ->t('Checklist (gi)'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    $element = parent::preview();
    if ($this
      ->hasProperty('options')) {
      $element['#options'] = [
        'one' => 'One',
        'two' => 'Two',
        'three' => 'Three',
      ];
    }
    if ($this
      ->hasProperty('options_display')) {
      $element['#options_display'] = 'side_by_side';
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getTableColumn(array $element) {
    $key = $element['#webform_key'];
    $columns = parent::getTableColumn($element);
    $columns['element__' . $key]['sort'] = !$this
      ->hasMultipleValues($element);
    return $columns;
  }

  /**
   * {@inheritdoc}
   */
  public function getExportDefaultOptions() {
    return [
      'options_single_format' => 'compact',
      'options_multiple_format' => 'compact',
      'options_item_format' => 'label',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportOptionsForm(array &$form, FormStateInterface $form_state, array $export_options) {
    parent::buildExportOptionsForm($form, $form_state, $export_options);
    if (isset($form['options'])) {
      return;
    }

    // Build format options with help.
    $options_format_options = [
      'compact' => $this
        ->t('Compact, with the option values delimited by commas in one column.') . WebformOptionsHelper::DESCRIPTION_DELIMITER . $this
        ->t('Compact options are more suitable for importing data into other systems.'),
      'separate' => $this
        ->t('Separate, with each possible option value in its own column.') . WebformOptionsHelper::DESCRIPTION_DELIMITER . $this
        ->t('Separate options are more suitable for building reports, graphs, and statistics in a spreadsheet application. Ranking will be included for sortable option elements.'),
    ];
    $form['options'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Select menu, radio buttons, and checkboxes options'),
      '#open' => TRUE,
      '#weight' => -10,
    ];
    $form['options']['options_single_format'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Options single value format'),
      '#description' => $this
        ->t('Elements that collect a single option value include select menus, radios, and buttons.'),
      '#options' => $options_format_options,
      '#options_description_display' => 'help',
      '#default_value' => $export_options['options_single_format'],
    ];
    $form['options']['options_multiple_format'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Options multiple values format'),
      '#description' => $this
        ->t('Elements that collect multiple option values include multi-select, checkboxes, and toggles.'),
      '#options' => $options_format_options,
      '#options_description_display' => 'help',
      '#default_value' => $export_options['options_multiple_format'],
    ];
    $form['options']['options_item_format'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Options item format'),
      '#options' => [
        'label' => $this
          ->t('Option labels, the human-readable value (label)'),
        'key' => $this
          ->t('Option values, the raw value stored in the database (key)'),
      ],
      '#default_value' => $export_options['options_item_format'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportHeader(array $element, array $options) {
    $options_format = $element['#webform_multiple'] ? $options['options_multiple_format'] : $options['options_single_format'];
    if ($options_format === 'separate' && isset($element['#options'])) {
      $header = [];
      foreach ($element['#options'] as $option_value => $option_text) {

        // Note: If $option_text is an array (typically a tableselect row)
        // always use $option_value.
        $title = $options['options_item_format'] === 'key' || is_array($option_text) ? $option_value : $option_text;
        $header[] = $title;
      }

      // Add 'Other' option to header.
      if ($this instanceof WebformElementOtherInterface) {
        $header[] = $options['options_item_format'] === 'key' ? 'other' : $this
          ->t('Other');
      }
      return $this
        ->prefixExportHeader($header, $element, $options);
    }
    else {
      return parent::buildExportHeader($element, $options);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportRecord(array $element, WebformSubmissionInterface $webform_submission, array $export_options) {
    $element_options = isset($element['#options']) ? $element['#options'] : [];
    $options_format = $element['#webform_multiple'] ? $export_options['options_multiple_format'] : $export_options['options_single_format'];
    if ($options_format === 'separate') {
      $value = $this
        ->getRawValue($element, $webform_submission);
      $record = [];

      // Combine the values so that isset can be used instead of in_array().
      // http://stackoverflow.com/questions/13483219/what-is-faster-in-array-or-isset
      $deltas = FALSE;
      if (is_array($value)) {
        $value = array_combine($value, $value);
        $deltas = $this->exportDelta ? array_flip(array_values($value)) : FALSE;
      }

      // Separate multiple values (i.e. options).
      foreach ($element_options as $option_value => $option_text) {
        if (is_array($value) && isset($value[$option_value])) {
          unset($value[$option_value]);
          $record[] = $deltas ? $deltas[$option_value] + 1 : 'X';
        }
        elseif ($value === $option_value) {
          $value = '';
          $record[] = $deltas ? $deltas[$option_value] + 1 : 'X';
        }
        else {
          $record[] = '';
        }
      }

      // Add 'Other' option to record.
      if ($this instanceof WebformElementOtherInterface) {
        $record[] = is_array($value) ? implode($export_options['multiple_delimiter'], $value) : $value;
      }
      return $record;
    }
    else {
      if ($export_options['options_item_format'] === 'key') {
        $element['#format'] = 'raw';
      }
      return parent::buildExportRecord($element, $webform_submission, $export_options);
    }
  }

  /**
   * Form API callback. Remove unchecked options from value array.
   */
  public static function validateMultipleOptions(array &$element, FormStateInterface $form_state, array &$completed_form) {
    $values = $element['#value'] ?: [];

    // Filter unchecked/unselected options whose value is 0.
    $values = array_filter($values, function ($value) {
      return $value !== 0;
    });
    $values = array_values($values);
    $form_state
      ->setValueForElement($element, $values);
  }

  /**
   * {@inheritdoc}
   */
  protected function getElementSelectorInputsOptions(array $element) {
    if ($other_type = $this
      ->getOptionsOtherType()) {
      list($type) = explode(' ', $this
        ->getPluginLabel());
      $title = $this
        ->getAdminLabel($element);
      $name = $other_type;
      $inputs = [];
      $inputs[$name] = $title . ' [' . $type . ']';
      $inputs['other'] = $title . ' [' . $this
        ->t('Other field') . ']';
      return $inputs;
    }
    else {
      return [];
    }
  }

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\webform\Entity\Webform::getElementsSelectorOptions
   */
  public function getElementSelectorOptions(array $element) {
    if ($this
      ->hasMultipleValues($element) && $this
      ->hasMultipleWrapper()) {
      return [];
    }
    $plugin_id = $this
      ->getPluginId();
    $title = $this
      ->getAdminLabel($element) . ' [' . $this
      ->getPluginLabel() . ']';
    $name = $element['#webform_key'];
    if ($inputs = $this
      ->getElementSelectorInputsOptions($element)) {
      $selectors = [];
      foreach ($inputs as $input_name => $input_title) {
        $multiple = $this
          ->hasMultipleValues($element) && $input_name === 'select' ? '[]' : '';
        $selectors[":input[name=\"{$name}[{$input_name}]{$multiple}\"]"] = $input_title;
      }
      return [
        $title => $selectors,
      ];
    }
    else {
      $multiple = $this
        ->hasMultipleValues($element) && strpos($plugin_id, 'select') !== FALSE ? '[]' : '';
      return [
        ":input[name=\"{$name}{$multiple}\"]" => $title,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorSourceValues(array $element) {
    if ($this
      ->hasMultipleValues($element) && $this
      ->hasMultipleWrapper()) {
      return [];
    }
    $plugin_id = $this
      ->getPluginId();
    $name = $element['#webform_key'];
    $options = OptGroup::flattenOptions($element['#options']);
    if ($this
      ->getElementSelectorInputsOptions($element)) {
      $other_type = $this
        ->getOptionsOtherType();
      $multiple = $this
        ->hasMultipleValues($element) && $other_type === 'select' ? '[]' : '';
      return [
        ":input[name=\"{$name}[{$other_type}]{$multiple}\"]" => $options,
      ];
    }
    else {
      $multiple = $this
        ->hasMultipleValues($element) && strpos($plugin_id, 'select') !== FALSE ? '[]' : '';
      return [
        ":input[name=\"{$name}{$multiple}\"]" => $options,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorInputValue($selector, $trigger, array $element, WebformSubmissionInterface $webform_submission) {
    if ($this
      ->isOptionsOther()) {
      $input_name = WebformSubmissionConditionsValidator::getSelectorInputName($selector);
      $other_type = WebformSubmissionConditionsValidator::getInputNameAsArray($input_name, 1);
      $value = $this
        ->getRawValue($element, $webform_submission);

      // Handle edge case where the other element's value has
      // not been processed.
      // @see https://www.drupal.org/project/webform/issues/3000202

      /** @var \Drupal\webform\Element\WebformOtherBase $class */
      $class = $this
        ->getFormElementClassDefinition();
      $type = $class::getElementType();
      if (is_array($value) && count($value) === 2 && isset($value[$type]) && isset($value['other'])) {
        $value = $class::processValue($element, $value);
      }
      $options = OptGroup::flattenOptions($element['#options']);
      if ($other_type === 'other') {
        if ($this
          ->hasMultipleValues($element)) {
          $other_value = array_diff($value, array_keys($options));
          return $other_value ? implode(', ', $other_value) : NULL;
        }
        else {

          // Make sure other value is not valid option.
          return $value && !isset($options[$value]) ? $value : NULL;
        }
      }
      else {

        // If the trigger is 'filled or 'empty' then return the value.
        if ($trigger === 'filled' || $trigger === 'empty') {
          return $value;
        }
        if ($this
          ->hasMultipleValues($element)) {

          // Return array of valid #options.
          return array_intersect($value, array_keys($options));
        }
        else {

          // Return valid #option.
          return isset($options[$value]) ? $value : NULL;
        }
      }
    }
    else {
      return parent::getElementSelectorInputValue($selector, $trigger, $element, $webform_submission);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['default']['default_value']['#description'] .= ' ' . $this
      ->t('The default value of the field identified by its key.');

    // Issue #2836374: Wrapper attributes are not supported by composite
    // elements, this includes radios, checkboxes, and buttons.
    if (preg_match('/(radios|checkboxes|buttons)/', $this
      ->getPluginId())) {
      $t_args = [
        '@name' => mb_strtolower($this
          ->getPluginLabel()),
        ':href' => 'https://www.drupal.org/node/2836364',
      ];
      $form['element_attributes']['#description'] = $this
        ->t('Please note: That the below custom element attributes will also be applied to the @name fieldset wrapper. (<a href=":href">Issue #2836374</a>)', $t_args);
    }

    // Options.
    $form['options'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Element options'),
      '#open' => TRUE,
    ];
    $form['options']['options'] = [
      '#type' => 'webform_element_options',
      '#title' => $this
        ->t('Options'),
      '#options_description' => $this
        ->hasProperty('options_description_display'),
      '#required' => TRUE,
    ];
    $form['options']['options_display_container'] = $this
      ->getFormInlineContainer();
    $form['options']['options_display_container']['options_display'] = [
      '#title' => $this
        ->t('Options display'),
      '#type' => 'select',
      '#options' => [
        'one_column' => $this
          ->t('One column'),
        'two_columns' => $this
          ->t('Two columns'),
        'three_columns' => $this
          ->t('Three columns'),
        'side_by_side' => $this
          ->t('Side by side'),
        'buttons' => $this
          ->t('Buttons - flexbox'),
        'buttons_horizontal' => $this
          ->t('Buttons - horizontal'),
        'buttons_vertical' => $this
          ->t('Buttons - vertical'),
      ],
    ];
    $form['options']['options_display_container']['options_description_display'] = [
      '#title' => $this
        ->t('Options description display'),
      '#type' => 'select',
      '#options' => [
        'description' => $this
          ->t('Description'),
        'help' => $this
          ->t('Help text'),
      ],
    ];
    $form['options']['empty_option'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Empty option label'),
      '#description' => $this
        ->t('The label to show for the initial option denoting no selection in a select element.'),
      '#states' => [
        'visible' => [
          ':input[name="properties[multiple][container][cardinality]"]' => [
            'value' => 'number',
          ],
          ':input[name="properties[multiple][container][cardinality_number]"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $default_empty_option = $this->configFactory
      ->get('webform.settings')
      ->get('element.default_empty_option');
    if ($default_empty_option) {
      $default_empty_option_required = $this->configFactory
        ->get('webform.settings')
        ->get('element.default_empty_option_required') ?: $this
        ->t('- Select -');
      $form['options']['empty_option']['#description'] .= '<br />' . $this
        ->t('Required elements defaults to: %required', [
        '%required' => $default_empty_option_required,
      ]);
      $default_empty_option_optional = $this->configFactory
        ->get('webform.settings')
        ->get('element.default_empty_option_optional') ?: $this
        ->t('- None -');
      $form['options']['empty_option']['#description'] .= '<br />' . $this
        ->t('Optional elements defaults to: %optional', [
        '%optional' => $default_empty_option_optional,
      ]);
    }
    $form['options']['empty_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Empty option value'),
      '#description' => $this
        ->t('The value for the initial option denoting no selection in a select element, which is used to determine whether the user submitted a value or not.'),
      '#states' => [
        'visible' => [
          ':input[name="properties[multiple][container][cardinality]"]' => [
            'value' => 'number',
          ],
          ':input[name="properties[multiple][container][cardinality_number]"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];

    // Sort options (only applies to select menus).
    // @see template_preprocess_select()
    // @see webform_preprocess_select()
    $form['options']['sort_options'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Sort options'),
      '#description' => $this
        ->t('Sort the options by their (translated) labels.'),
      '#return_value' => TRUE,
    ];
    $form['options']['options_randomize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Randomize options'),
      '#description' => $this
        ->t('Randomizes the order of the options when they are displayed in the webform.'),
      '#return_value' => TRUE,
    ];
    if ($this
      ->hasProperty('options_randomize') && $this
      ->hasProperty('sort_options')) {
      $form['options']['options_randomize']['#states']['visible'] = [
        ':input[name="properties[sort_options]"]' => [
          'checked' => FALSE,
        ],
      ];
    }

    // Other.
    $states_textfield_or_number = [
      'visible' => [
        [
          ':input[name="properties[other__type]"]' => [
            'value' => 'textfield',
          ],
        ],
        'or',
        [
          ':input[name="properties[other__type]"]' => [
            'value' => 'number',
          ],
        ],
      ],
    ];
    $states_textbase = [
      'visible' => [
        [
          ':input[name="properties[other__type]"]' => [
            'value' => 'textfield',
          ],
        ],
        'or',
        [
          ':input[name="properties[other__type]"]' => [
            'value' => 'textarea',
          ],
        ],
      ],
    ];
    $states_textarea = [
      'visible' => [
        ':input[name="properties[other__type]"]' => [
          'value' => 'textarea',
        ],
      ],
    ];
    $states_number = [
      'visible' => [
        ':input[name="properties[other__type]"]' => [
          'value' => 'number',
        ],
      ],
    ];
    $form['options_other'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Other option settings'),
    ];
    $form['options_other']['other__type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Other type'),
      '#options' => [
        'textfield' => $this
          ->t('Text field'),
        'textarea' => $this
          ->t('Textarea'),
        'number' => $this
          ->t('Number'),
      ],
    ];
    $form['options_other']['other__option_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other option label'),
    ];
    $form['options_other']['other__title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other title'),
    ];
    $form['options_other']['other__placeholder'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other placeholder'),
    ];
    $form['options_other']['other__description'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other description'),
    ];
    $form['options_other']['other__field_container'] = $this
      ->getFormInlineContainer();
    $form['options_other']['other__field_container']['other__field_prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other field prefix'),
      '#description' => $this
        ->t('Text or code that is placed directly in front of the input. This can be used to prefix an input with a constant string. Examples: $, #, -.'),
      '#size' => 10,
      '#states' => $states_textfield_or_number,
    ];
    $form['options_other']['other__field_container']['other__field_suffix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other field suffix'),
      '#description' => $this
        ->t('Text or code that is placed directly after the input. This can be used to add a unit to an input. Examples: lb, kg, %.'),
      '#size' => 10,
      '#states' => $states_textfield_or_number,
    ];
    $form['options_other']['other__size_container'] = $this
      ->getFormInlineContainer();
    $form['options_other']['other__size_container']['other__size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other size'),
      '#description' => $this
        ->t('Leaving blank will use the default size.'),
      '#min' => 1,
      '#size' => 4,
      '#states' => $states_textfield_or_number,
    ];
    $form['options_other']['other__size_container']['other__maxlength'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other maxlength'),
      '#description' => $this
        ->t('Leaving blank will use the default maxlength.'),
      '#min' => 1,
      '#size' => 4,
      '#states' => $states_textfield_or_number,
    ];
    $form['options_other']['other__size_container']['other__rows'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other rows'),
      '#description' => $this
        ->t('Leaving blank will use the default rows.'),
      '#min' => 1,
      '#size' => 4,
      '#states' => $states_textarea,
    ];
    $form['options_other']['other__number_container'] = $this
      ->getFormInlineContainer();
    $form['options_other']['other__number_container']['other__min'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other minimum'),
      '#description' => $this
        ->t('Specifies the minimum value.'),
      '#step' => 'any',
      '#size' => 4,
      '#states' => $states_number,
    ];
    $form['options_other']['other__number_container']['other__max'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other maximum'),
      '#description' => $this
        ->t('Specifies the maximum value.'),
      '#step' => 'any',
      '#size' => 4,
      '#states' => $states_number,
    ];
    $form['options_other']['other__number_container']['other__step'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Other steps'),
      '#description' => $this
        ->t('Specifies the legal number intervals. Leave blank to support any number interval.'),
      '#step' => 'any',
      '#size' => 4,
      '#states' => $states_number,
    ];
    $form['options_other']['other__textbase_container'] = [
      '#type' => 'container',
      '#states' => $states_textbase,
    ] + $this
      ->buildCounterForm('other__', 'Other count');

    // Add hide/show #format_items based on #multiple.
    if ($this
      ->supportsMultipleValues() && $this
      ->hasProperty('multiple')) {
      $form['display']['format_items']['#states'] = [
        'visible' => [
          [
            ':input[name="properties[multiple]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    $form['options_properties'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Options (custom) properties'),
      '#access' => $this
        ->hasProperty('options__properties') && $this->currentUser
        ->hasPermission('edit webform source'),
    ];
    $form['options_properties']['options__properties'] = [
      '#type' => 'webform_codemirror',
      '#mode' => 'yaml',
      '#title' => $this
        ->t('Options properties'),
      '#description' => $this
        ->t("Custom options properties must include the 'Option value' followed by option (element) properties prepended with a hash (#) character.") . "<pre>option_value:\n  '#wrapper_attributes':\n    class:\n      - disabled\n  '#disabled': true</pre>" . '<br /><br />' . $this
        ->t('These properties and callbacks are not allowed: @properties', [
        '@properties' => WebformArrayHelper::toString(WebformArrayHelper::addPrefix(WebformElementHelper::$ignoredProperties)),
      ]),
    ];
    return $form;
  }

}
Classes

Name	Description
OptionsBase	Provides a base 'options' element.
You are here

OptionsBase.php in Webform 8.5

Namespace

File

Classes

API Navigation
