You are here

Home » API reference » YAML Form 8 » YamlFormElementOptions.php

class YamlFormElementOptions in YAML Form 8

Provides a form element for managing form element options.

This element is used by select, radios, checkboxes, and likert elements.

Plugin annotation

@FormElement("yamlform_element_options");

Hierarchy

Expanded class hierarchy of YamlFormElementOptions

3 #type uses of YamlFormElementOptions
OptionsBase::form in src/Plugin/YamlFormElement/OptionsBase.php
Gets the actual configuration form array to be built.
YamlFormAutocomplete::form in src/Plugin/YamlFormElement/YamlFormAutocomplete.php
Gets the actual configuration form array to be built.
YamlFormLikert::form in src/Plugin/YamlFormElement/YamlFormLikert.php
Gets the actual configuration form array to be built.

File

src/Element/YamlFormElementOptions.php, line 19

Namespace

Drupal\yamlform\Element
View source 
class YamlFormElementOptions extends FormElement {
  const CUSTOM_OPTION = '';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#likert' => FALSE,
      '#process' => [
        [
          $class,
          'processYamlFormElementOptions',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#custom__type' => 'yamlform_options',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input === FALSE) {
      if (isset($element['#default_value'])) {
        if (is_string($element['#default_value'])) {
          return YamlFormOptionsEntity::load($element['#default_value']) ? $element['#default_value'] : [];
        }
        else {
          return $element['#default_value'];
        }
      }
      else {
        return [];
      }
    }
    elseif (!empty($input['options'])) {
      return $input['options'];
    }
    elseif (isset($input['custom']['options'])) {
      return $input['custom']['options'];
    }
    else {
      return [];
    }
  }

  /**
   * Processes a form element options element.
   */
  public static function processYamlFormElementOptions(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#tree'] = TRUE;

    // Predefined options.
    // @see (/admin/structure/yamlform/settings/options/manage)
    $options = [];
    $yamlform_options = YamlFormOptionsEntity::loadMultiple();
    foreach ($yamlform_options as $id => $yamlform_option) {

      // Filter likert options for answers to the likert element.
      if ($element['#likert'] && strpos($id, 'likert_') !== 0) {
        continue;
      }
      $options[$id] = $yamlform_option
        ->label();
    }
    asort($options);
    $t_args = [
      '@type' => $element['#likert'] ? t('answers') : t('options'),
      ':href' => Url::fromRoute('entity.yamlform_options.collection')
        ->toString(),
    ];

    // Select options.
    $element['options'] = [
      '#type' => 'select',
      '#description' => t('Please select <a href=":href">predefined @type</a> or enter custom @type.', $t_args),
      '#options' => [
        self::CUSTOM_OPTION => t('Custom...'),
      ] + $options,
      '#attributes' => [
        'class' => [
          'js-' . $element['#id'] . '-options',
        ],
      ],
      '#error_no_message' => TRUE,
      '#default_value' => isset($element['#default_value']) && !is_array($element['#default_value']) ? $element['#default_value'] : '',
    ];

    // Custom options.
    if ($element['#custom__type'] === 'yamlform_multiple') {
      $element['custom'] = [
        '#type' => 'yamlform_multiple',
        '#title' => $element['#title'],
        '#title_display' => 'invisible',
        '#states' => [
          'visible' => [
            'select.js-' . $element['#id'] . '-options' => [
              'value' => '',
            ],
          ],
        ],
        '#error_no_message' => TRUE,
        '#default_value' => isset($element['#default_value']) && !is_string($element['#default_value']) ? $element['#default_value'] : [],
      ];
    }
    else {
      $element['custom'] = [
        '#type' => 'yamlform_options',
        '#title' => $element['#title'],
        '#title_display' => 'invisible',
        '#label' => $element['#likert'] ? t('answer') : t('option'),
        '#labels' => $element['#likert'] ? t('answers') : t('options'),
        '#states' => [
          'visible' => [
            'select.js-' . $element['#id'] . '-options' => [
              'value' => '',
            ],
          ],
        ],
        '#error_no_message' => TRUE,
        '#default_value' => isset($element['#default_value']) && !is_string($element['#default_value']) ? $element['#default_value'] : [],
      ];
    }
    $element['#element_validate'] = [
      [
        get_called_class(),
        'validateYamlFormElementOptions',
      ],
    ];
    return $element;
  }

  /**
   * Validates a form element options element.
   */
  public static function validateYamlFormElementOptions(&$element, FormStateInterface $form_state, &$complete_form) {
    $options_value = NestedArray::getValue($form_state
      ->getValues(), $element['options']['#parents']);
    $custom_value = NestedArray::getValue($form_state
      ->getValues(), $element['custom']['#parents']);
    $value = $options_value;
    if ($options_value == self::CUSTOM_OPTION) {
      try {
        $value = is_string($custom_value) ? Yaml::decode($custom_value) : $custom_value;
      } catch (\Exception $exception) {

        // Do nothing since the 'yamlform_codemirror' element will have already
        // captured the validation error.
      }
    }
    $has_access = !isset($element['#access']) || $element['#access'] === TRUE;
    if ($element['#required'] && empty($value) && $has_access) {
      if (isset($element['#required_error'])) {
        $form_state
          ->setError($element, $element['#required_error']);
      }
      elseif (isset($element['#title'])) {
        $form_state
          ->setError($element, t('@name field is required.', [
          '@name' => $element['#title'],
        ]));
      }
      else {
        $form_state
          ->setError($element);
      }
    }
    $form_state
      ->setValueForElement($element['options'], NULL);
    $form_state
      ->setValueForElement($element['custom'], NULL);
    $form_state
      ->setValueForElement($element, $value);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
YamlFormElementOptions::CUSTOM_OPTION constant
YamlFormElementOptions::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
YamlFormElementOptions::processYamlFormElementOptions public static function Processes a form element options element.
YamlFormElementOptions::validateYamlFormElementOptions public static function Validates a form element options element.
YamlFormElementOptions::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback