You are here

Home » API reference » Webform 6.x » WebformCheckboxValue.php

class WebformCheckboxValue in Webform 6.x

Same name and namespace in other branches
  1. 8.5 src/Element/WebformCheckboxValue.php \Drupal\webform\Element\WebformCheckboxValue

Provides a webform element for checking a box before entering a value.

Plugin annotation

@FormElement("webform_checkbox_value");

Hierarchy

Expanded class hierarchy of WebformCheckboxValue

3 #type uses of WebformCheckboxValue
TextBase::form in src/Plugin/WebformElement/TextBase.php
Gets the actual configuration webform array to be built.
WebformExampleCustomFormSettingsForm::buildForm in modules/webform_example_custom_form/src/Form/WebformExampleCustomFormSettingsForm.php
Form constructor.
WebformManagedFileBase::form in src/Plugin/WebformElement/WebformManagedFileBase.php
Gets the actual configuration webform array to be built.

File

src/Element/WebformCheckboxValue.php, line 15

Namespace

Drupal\webform\Element
View source 
class WebformCheckboxValue extends FormElement {

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

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $element += [
      '#default_value' => NULL,
    ];
    if ($input === FALSE) {
      return [
        'checkbox' => $element['#default_value'] ? TRUE : FALSE,
        'value' => $element['#default_value'],
      ];
    }
    else {
      return $input;
    }
  }

  /**
   * Processes a 'webform_checkbox_value' element.
   */
  public static function processWebformCheckboxValue(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#tree'] = TRUE;
    $properties = [
      '#title' => '#title',
      '#description' => '#description',
      '#help' => '#help',
    ];

    // Build checkbox element.
    $element['checkbox'] = [
      '#type' => 'checkbox',
      '#default_value' => !empty($element['#default_value']) ? TRUE : FALSE,
    ];
    $element['checkbox'] += array_intersect_key($element, $properties);

    // Build value element.
    $selector = 'edit-' . str_replace('_', '-', implode('-', $element['#parents'])) . '-checkbox';
    $element['value'] = [
      '#default_value' => $element['#default_value'],
      '#states' => [
        'visible' => [
          ':input[data-drupal-selector="' . $selector . '"]' => [
            'checked' => TRUE,
          ],
        ],
        'required' => [
          ':input[data-drupal-selector="' . $selector . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Pass '#value__*' properties to the value element.
    foreach ($element as $key => $value) {
      if (strpos($key, '#value__') === 0) {
        $value_key = str_replace('#value__', '#', $key);
        $element['value'][$value_key] = $value;
      }
    }

    // Pass entire element to the value element.
    if (isset($element['#element'])) {
      $element['value'] += $element['#element'];
    }

    // Make sure the value element has a #type.
    $element['value'] += [
      '#type' => 'textfield',
    ];

    // Always add a title to the value element for validation.
    if (!isset($element['value']['#title']) && isset($element['#title'])) {
      $element['value']['#title'] = $element['#title'];
      $element['value']['#title_display'] = 'invisible';
    }

    // Attach libraries.
    $element['#attached']['library'][] = 'webform/webform.element.checkbox_value';

    // Add validate callback.
    $element += [
      '#element_validate' => [],
    ];
    array_unshift($element['#element_validate'], [
      get_called_class(),
      'validateWebformCheckboxValue',
    ]);

    // Remove properties from the element.
    $element = array_diff_key($element, $properties);
    return $element;
  }

  /**
   * Validates a checkbox value element.
   */
  public static function validateWebformCheckboxValue(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = NestedArray::getValue($form_state
      ->getValues(), $element['#parents']);

    // Always require a value when the checkbox is checked.
    if (!empty($value['checkbox']) && empty($value['value'])) {
      WebformElementHelper::setRequiredError($element['value'], $form_state);
    }

    // If checkbox is not checked then empty the value.
    if (empty($value['checkbox'])) {
      $value['value'] = '';
    }
    $form_state
      ->setValueForElement($element['checkbox'], NULL);
    $form_state
      ->setValueForElement($element['value'], NULL);
    $element['#value'] = $value['value'];
    $form_state
      ->setValueForElement($element, $value['value']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 98
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. 4
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.
WebformCheckboxValue::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformCheckboxValue::processWebformCheckboxValue public static function Processes a 'webform_checkbox_value' element.
WebformCheckboxValue::validateWebformCheckboxValue public static function Validates a checkbox value element.
WebformCheckboxValue::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback