NumericBase.php in Webform 8.5

Namespace

Drupal\webform\Plugin\WebformElement

File

src/Plugin/WebformElement/NumericBase.php

<?php

namespace Drupal\webform\Plugin\WebformElement;

use Drupal\Core\Form\FormStateInterface;
use Drupal\webform\Plugin\WebformElementBase;
use Drupal\webform\WebformInterface;
use Drupal\webform\WebformSubmissionInterface;

/**
 * Provides a base 'numeric' class.
 */
abstract class NumericBase extends WebformElementBase {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    return [
      // Form validation.
      'readonly' => FALSE,
      'size' => '',
      'placeholder' => '',
      'autocomplete' => 'on',
    ] + parent::defineDefaultProperties();
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    parent::prepare($element, $webform_submission);
    if ($this
      ->hasProperty('step') && !isset($element['#step'])) {
      $element['#step'] = $this
        ->getDefaultProperty('step') ?: 'any';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
    $element += [
      '#min' => 1,
      '#max' => 10,
    ];
    if (is_string($element['#min'])) {
      $element['#min'] = $this->tokenManager
        ->replace($element['#min'], $webform);
    }
    if (is_string($element['#max'])) {
      $element['#max'] = $this->tokenManager
        ->replace($element['#max'], $webform);
    }
    return [
      $element['#min'],
      floor(($element['#max'] - $element['#min']) / 2 + $element['#min']),
      $element['#max'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['number'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Number settings'),
    ];
    $form['number']['number_container'] = $this
      ->getFormInlineContainer();
    $form['number']['number_container']['min'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum'),
      '#description' => $this
        ->t('Specifies the minimum value.'),
      '#step' => 'any',
      '#size' => 4,
    ];
    $form['number']['number_container']['max'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum'),
      '#description' => $this
        ->t('Specifies the maximum value.'),
      '#step' => 'any',
      '#size' => 4,
    ];
    $form['number']['number_container']['step'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Steps'),
      '#description' => $this
        ->t('Specifies the legal number intervals. Leave blank to support any number interval. Decimals are supported.'),
      '#step' => 'any',
      '#size' => 4,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);

    // Validate min/max value.
    $min = $form_state
      ->getValue('min');
    $max = $form_state
      ->getValue('max');
    if ($min === '' || !isset($min) || ($max === '' || !isset($max))) {
      return;
    }
    if ($min >= $max) {
      $form_state
        ->setErrorByName('min', $this
        ->t('Minimum value can not exceed the maximum value.'));
    }
  }

}

Classes

Name	Description
NumericBase	Provides a base 'numeric' class.