You are here

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

abstract class YamlFormExcludedBase in YAML Form 8

Provides a base form element for form excluded elements and columns.

This element is just intended to capture all the business logic around selecting excluded form elements which is used by the EmailYamlFormHandler and the YamlFormResultsExportForm forms.

Hierarchy

Expanded class hierarchy of YamlFormExcludedBase

File

src/Element/YamlFormExcludedBase.php, line 15

Namespace

Drupal\yamlform\Element
View source 
abstract class YamlFormExcludedBase extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processYamlFormExcluded',
        ],
      ],
      '#yamlform' => NULL,
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Processes a form elements form element.
   */
  public static function processYamlFormExcluded(&$element, FormStateInterface $form_state, &$complete_form) {
    $options = static::getYamlFormExcludedOptions($element);
    $default_value = array_diff(array_keys($options), array_keys($element['#default_value'] ?: []));
    $element['#tree'] = TRUE;
    $element['#element_validate'] = [
      [
        get_called_class(),
        'validateYamlFormExcluded',
      ],
    ];
    $element['tableselect'] = [
      '#type' => 'tableselect',
      '#header' => static::getYamlFormExcludedHeader(),
      '#options' => $options,
      '#js_select' => TRUE,
      '#empty' => t('No elements are available.'),
      '#default_value' => array_combine($default_value, $default_value),
    ];

    // Build tableselect element with selected properties.
    $properties = [
      '#title',
      '#title_display',
      '#description',
      '#description_display',
      '#ajax',
      '#states',
    ];
    $element['tableselect'] += array_intersect_key($element, array_combine($properties, $properties));
    return $element;
  }

  /**
   * Validates a tablelselect element.
   */
  public static function validateYamlFormExcluded(array &$element, FormStateInterface $form_state, &$complete_form) {
    $value = array_filter($element['tableselect']['#value']);

    // Converted value to excluded elements.
    $options = array_keys($element['tableselect']['#options']);
    $excluded = array_diff($options, $value);

    // Unset tableselect and set the element's value to excluded.
    $form_state
      ->setValueForElement($element['tableselect'], NULL);
    $form_state
      ->setValueForElement($element, array_combine($excluded, $excluded));
  }

  /**
   * Get options for excluded tableselect element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   generic element element.
   *
   * @return array
   *   An array of options containing title, name, and type of items for a
   *   tableselect element.
   */
  public static function getYamlFormExcludedOptions(array $element) {

    /** @var \Drupal\yamlform\YamlFormInterface $yamlform */
    $yamlform = $element['#yamlform'];

    /** @var \Drupal\yamlform\YamlFormElementManagerInterface $element_manager */
    $element_manager = \Drupal::service('plugin.manager.yamlform.element');
    $options = [];
    $elements = $yamlform
      ->getElementsInitializedAndFlattened();
    foreach ($elements as $key => $element) {
      $element_handler = $element_manager
        ->getElementInstance($element);
      if (!$element_handler
        ->isInput($element)) {
        continue;
      }
      $options[$key] = [
        [
          'title' => $element['#admin_title'] ?: $element['#title'] ?: $key,
        ],
        [
          'name' => $key,
        ],
        [
          'type' => isset($element['#type']) ? $element['#type'] : '',
        ],
      ];
    }
    return $options;
  }

  /**
   * Get header for the excluded tableselect element.
   *
   * @return array
   *   An array container the header for the excluded tableselect element.
   */
  public static function getYamlFormExcludedHeader() {
    return [
      t('Title'),
      t('Name'),
      t('Type'),
    ];
  }

}

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.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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.
YamlFormExcludedBase::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
YamlFormExcludedBase::getYamlFormExcludedHeader public static function Get header for the excluded tableselect element. 1
YamlFormExcludedBase::getYamlFormExcludedOptions public static function Get options for excluded tableselect element. 1
YamlFormExcludedBase::processYamlFormExcluded public static function Processes a form elements form element.
YamlFormExcludedBase::validateYamlFormExcluded public static function Validates a tablelselect element.