You are here

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

abstract class YamlFormCompositeBase in YAML Form 8

Same name in this branch
  1. 8 src/Element/YamlFormCompositeBase.php \Drupal\yamlform\Element\YamlFormCompositeBase
  2. 8 src/Plugin/YamlFormElement/YamlFormCompositeBase.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormCompositeBase

Provides an base composite form element.

Hierarchy

Expanded class hierarchy of YamlFormCompositeBase

File

src/Element/YamlFormCompositeBase.php, line 13

Namespace

Drupal\yamlform\Element
View source 
abstract class YamlFormCompositeBase extends FormElement {
  use CompositeFormElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processYamlFormComposite',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCompositeFormElement',
        ],
      ],
      '#theme' => str_replace('yamlform_', 'yamlform_composite_', $this
        ->getPluginId()),
      '#theme_wrappers' => [
        'container',
      ],
      '#title_display' => 'invisible',
      '#required' => FALSE,
      '#flexbox' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $composite_elements = static::getCompositeElements();
    $default_value = [];
    foreach ($composite_elements as $composite_key => $composite_element) {
      if (isset($composite_element['#type']) && $composite_element['#type'] != 'label') {
        $default_value[$composite_key] = '';
      }
    }
    if ($input === FALSE) {
      if (empty($element['#default_value']) || !is_array($element['#default_value'])) {
        $element['#default_value'] = [];
      }
      return $element['#default_value'] + $default_value;
    }
    return is_array($input) ? $input + $default_value : $default_value;
  }

  /**
   * Get a renderable array of form elements.
   *
   * @return array
   *   A renderable array of form elements, containing the base properties
   *   for the composite's form elements.
   */
  public static function getCompositeElements() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderCompositeFormElement($element) {
    $element = CompositeFormElementTrait::preRenderCompositeFormElement($element);

    // Add class name to wrapper attributes.
    $class_name = str_replace('_', '-', $element['#type']);
    $element['#attributes']['class'][] = 'js-' . $class_name;
    $element['#attributes']['class'][] = $class_name;
    return $element;
  }

  /**
   * Processes a composite form element.
   */
  public static function processYamlFormComposite(&$element, FormStateInterface $form_state, &$complete_form) {
    if (isset($element['#initialize'])) {
      return $element;
    }
    $element['#initialize'] = TRUE;
    $element['#tree'] = TRUE;
    $composite_elements = static::getCompositeElements();
    foreach ($composite_elements as $composite_key => &$composite_element) {

      // Transfer '#{composite_key}_{property}' from main element to composite
      // element.
      foreach ($element as $property_key => $property_value) {
        if (strpos($property_key, '#' . $composite_key . '__') === 0) {
          $composite_property_key = str_replace('#' . $composite_key . '__', '#', $property_key);
          $composite_element[$composite_property_key] = $property_value;
        }
      }
      if (isset($element['#value'][$composite_key])) {
        $composite_element['#value'] = $element['#value'][$composite_key];
      }

      // Always set #access which is used to hide/show the elements container.
      $composite_element += [
        '#access' => TRUE,
      ];

      // Never required hidden composite elements.
      if ($composite_element['#access'] == FALSE) {
        unset($composite_element['#required']);
      }

      // Load options.
      if (isset($composite_element['#options'])) {
        $composite_element['#options'] = YamlFormOptionsEntity::getElementOptions($composite_element);
      }

      // Handle #type specific customizations.
      if (isset($composite_element['#type'])) {
        switch ($composite_element['#type']) {
          case 'select':
          case 'yamlform_select_other':

            // Always include an empty option, even if the composite element
            // is not required.
            // @see https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Element!Select.php/class/Select/8.2.x
            // Use placeholder as empty option.
            if (!isset($composite_element['#empty_option'])) {
              if (isset($composite_element['#placeholder'])) {
                $composite_element['#empty_option'] = $composite_element['#placeholder'];
              }
              elseif (empty($composite_element['#required'])) {
                $composite_element['#empty_option'] = t('- None -');
              }
            }
            break;
        }
      }
    }
    $element += $composite_elements;
    $element['#element_validate'] = [
      [
        get_called_class(),
        'validateYamlFormComposite',
      ],
    ];
    if (!empty($element['#flexbox'])) {
      $element['#attached']['library'][] = 'yamlform/yamlform.element.flexbox';
    }
    return $element;
  }

  /**
   * Validates a composite element.
   */
  public static function validateYamlFormComposite(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $element['#value'];

    // Validate required composite elements.
    $composite_elements = static::getCompositeElements();
    foreach ($composite_elements as $composite_key => $composite_element) {
      if (!empty($element[$composite_key]['#required']) && $value[$composite_key] == '') {
        if (isset($element[$composite_key]['#title'])) {
          $form_state
            ->setError($element[$composite_key], t('@name field is required.', [
            '@name' => $element[$composite_key]['#title'],
          ]));
        }
      }
    }
  }

}

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.
YamlFormCompositeBase::getCompositeElements public static function Get a renderable array of form elements. 8
YamlFormCompositeBase::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
YamlFormCompositeBase::preRenderCompositeFormElement public static function Adds form element theming to an element if its title or description is set. Overrides CompositeFormElementTrait::preRenderCompositeFormElement 1
YamlFormCompositeBase::processYamlFormComposite public static function Processes a composite form element. 1
YamlFormCompositeBase::validateYamlFormComposite public static function Validates a composite element.
YamlFormCompositeBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback