You are here

Home » API reference » Field Validation 8 » NumericFieldValidationRule.php

class NumericFieldValidationRule in Field Validation 8

NumericFieldValidationRule.

Plugin annotation


@FieldValidationRule(
  id = "numeric_field_validation_rule",
  label = @Translation("Numeric"),
  description = @Translation("Verifies that user-entered values are numeric, with the option to specify min/max/step.")
)

Hierarchy

Expanded class hierarchy of NumericFieldValidationRule

File

src/Plugin/FieldValidationRule/NumericFieldValidationRule.php, line 18

Namespace

Drupal\field_validation\Plugin\FieldValidationRule
View source 
class NumericFieldValidationRule extends ConfigurableFieldValidationRuleBase {

  /**
   * {@inheritdoc}
   */
  public function addFieldValidationRule(FieldValidationRuleSetInterface $field_validation_rule_set) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'min' => NULL,
      'max' => NULL,
      'step' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['min'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum value'),
      '#default_value' => $this->configuration['min'],
      '#required' => TRUE,
    ];
    $form['max'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum value'),
      '#default_value' => $this->configuration['max'],
      '#required' => TRUE,
    ];
    $form['step'] = [
      '#title' => $this
        ->t('Step'),
      '#description' => $this
        ->t('The step scale factor. Must be positive.'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['step'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['min'] = $form_state
      ->getValue('min');
    $this->configuration['max'] = $form_state
      ->getValue('max');
    $this->configuration['step'] = $form_state
      ->getValue('step');
  }
  public function validate($params) {
    $value = isset($params['value']) ? $params['value'] : '';
    $rule = isset($params['rule']) ? $params['rule'] : null;
    $context = isset($params['context']) ? $params['context'] : null;
    $settings = array();
    if (!empty($rule) && !empty($rule->configuration)) {
      $settings = $rule->configuration;
    }

    //$settings = $this->rule->settings;
    if ($value !== '' && !is_null($value)) {
      $flag = TRUE;
      if (!is_numeric($value)) {
        $flag = FALSE;
      }
      else {
        if (isset($settings['min']) && $settings['min'] != '') {
          $min = $settings['min'];
          if ($value < $min) {
            $flag = FALSE;
          }
        }
        if (isset($settings['max']) && $settings['max'] != '') {
          $max = $settings['max'];
          if ($value > $max) {
            $flag = FALSE;
          }
        }
        if (isset($settings['step']) && strtolower($settings['step']) != 'any') {

          // Check that the input is an allowed multiple of #step (offset by #min if
          // #min is set).
          $offset = isset($settings['min']) ? $settings['min'] : 0.0;
          $step = $settings['step'];

          //The logic code was copied from Drupal 8 core.
          if ($step > 0 && !$this
            ->valid_number_step($value, $step, $offset)) {
            $flag = FALSE;
          }
        }
      }
      if (!$flag) {
        $context
          ->addViolation($rule
          ->getErrorMessage());
      }
    }

    //return true;
  }

  /**
   * Verifies that a number is a multiple of a given step.
   *
   * The implementation assumes it is dealing with IEEE 754 double precision
   * floating point numbers that are used by PHP on most systems.
   *
   * This is based on the number/range verification methods of webkit.
   *
   * @param $value
   *   The value that needs to be checked.
   * @param $step
   *   The step scale factor. Must be positive.
   * @param $offset
   *   (optional) An offset, to which the difference must be a multiple of the
   *   given step.
   *
   * @return bool
   *   TRUE if no step mismatch has occured, or FALSE otherwise.
   *
   * @see http://opensource.apple.com/source/WebCore/WebCore-1298/html/NumberInputType.cpp
   */
  public function valid_number_step($value, $step, $offset = 0.0) {
    $double_value = (double) abs($value - $offset);

    // The fractional part of a double has 53 bits. The greatest number that could
    // be represented with that is 2^53. If the given value is even bigger than
    // $step * 2^53, then dividing by $step will result in a very small remainder.
    // Since that remainder can't even be represented with a single precision
    // float the following computation of the remainder makes no sense and we can
    // safely ignore it instead.
    if ($double_value / pow(2.0, 53) > $step) {
      return TRUE;
    }

    // Now compute that remainder of a division by $step.
    $remainder = (double) abs($double_value - $step * round($double_value / $step));

    // $remainder is a double precision floating point number. Remainders that
    // can't be represented with single precision floats are acceptable. The
    // fractional part of a float has 24 bits. That means remainders smaller than
    // $step * 2^-24 are acceptable.
    $computed_acceptable_error = (double) ($step / pow(2.0, 24));
    return $computed_acceptable_error >= $remainder || $remainder >= $step - $computed_acceptable_error;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableFieldValidationRuleBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
FieldValidationRuleBase::$column protected property The column of the FieldValidationRule.
FieldValidationRuleBase::$error_message protected property The error message of the FieldValidationRule.
FieldValidationRuleBase::$field_name protected property The field name of the FieldValidationRule.
FieldValidationRuleBase::$logger protected property A logger instance.
FieldValidationRuleBase::$title protected property The title of the FieldValidationRule.
FieldValidationRuleBase::$uuid protected property The FieldValidationRule ID.
FieldValidationRuleBase::$weight protected property The weight of the FieldValidationRule.
FieldValidationRuleBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FieldValidationRuleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldValidationRuleBase::getColumn public function Returns the column of the field_validation_rule. Overrides FieldValidationRuleInterface::getColumn
FieldValidationRuleBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldValidationRuleBase::getDerivativeExtension public function Returns the extension the derivative would have have after adding this field_validation_rule. Overrides FieldValidationRuleInterface::getDerivativeExtension
FieldValidationRuleBase::getErrorMessage public function Returns the error message of the field_validation_rule. Overrides FieldValidationRuleInterface::getErrorMessage
FieldValidationRuleBase::getFieldName public function Returns the field name of the field_validation_rule. Overrides FieldValidationRuleInterface::getFieldName
FieldValidationRuleBase::getTitle public function Returns the title of the field_validation_rule. Overrides FieldValidationRuleInterface::getTitle
FieldValidationRuleBase::getUuid public function Returns the unique ID representing the field_validation_rule. Overrides FieldValidationRuleInterface::getUuid
FieldValidationRuleBase::getWeight public function Returns the weight of the field_validation_rule. Overrides FieldValidationRuleInterface::getWeight
FieldValidationRuleBase::label public function Returns the field_validation_rule label. Overrides FieldValidationRuleInterface::label
FieldValidationRuleBase::setColumn public function Sets the column for this field_validation_rule. Overrides FieldValidationRuleInterface::setColumn
FieldValidationRuleBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldValidationRuleBase::setErrorMessage public function Sets the error message for this field_validation_rule. Overrides FieldValidationRuleInterface::setErrorMessage
FieldValidationRuleBase::setFieldName public function Sets the field name for this field_validation_rule. Overrides FieldValidationRuleInterface::setFieldName
FieldValidationRuleBase::setTitle public function Sets the title for this field_validation_rule. Overrides FieldValidationRuleInterface::setTitle
FieldValidationRuleBase::setWeight public function Sets the weight for this field_validation_rule. Overrides FieldValidationRuleInterface::setWeight
FieldValidationRuleBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
NumericFieldValidationRule::addFieldValidationRule public function Applies a field_validation_rule to the field_validation_rule_set. Overrides FieldValidationRuleInterface::addFieldValidationRule
NumericFieldValidationRule::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
NumericFieldValidationRule::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldValidationRuleBase::defaultConfiguration
NumericFieldValidationRule::getSummary public function Returns a render array summarizing the configuration of the field_validation_rule. Overrides FieldValidationRuleBase::getSummary
NumericFieldValidationRule::submitConfigurationForm public function Form submission handler. Overrides ConfigurableFieldValidationRuleBase::submitConfigurationForm
NumericFieldValidationRule::validate public function Overrides FieldValidationRuleBase::validate
NumericFieldValidationRule::valid_number_step public function Verifies that a number is a multiple of a given step.
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.
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.