WebformVariant.php in Webform 8.5

Namespace

Drupal\webform\Element

File

src/Element/WebformVariant.php

<?php

namespace Drupal\webform\Element;

use Drupal\Core\Render\Element\FormElement;
use Drupal\Core\Form\FormStateInterface;
use Drupal\webform\WebformSubmissionForm;

/**
 * Provides a webform variant element.
 *
 * @FormElement("webform_variant")
 */
class WebformVariant extends FormElement {

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

  /**
   * #process callback for webform variant.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   generic input element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processWebformVariant(&$element, FormStateInterface $form_state, &$complete_form) {
    $form_object = $form_state
      ->getFormObject();
    if ($element['#value']) {
      $element['#children'] = $element['#value'];
      if ($form_object instanceof WebformSubmissionForm) {

        // Display variant label.

        /** @var \Drupal\webform\WebformInterface $webform */
        $webform = $form_object
          ->getWebform();
        if ($webform
          ->hasVariant($element['#value'])) {
          $variant_plugin = $webform
            ->getVariant($element['#value']);
          $element['#children'] = $variant_plugin
            ->label();
        }
      }
    }
    return $element;
  }

}

Classes

Name	Description
WebformVariant	Provides a webform variant element.