You are here

class Step in Clientside Validation 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/CvValidator/Step.php \Drupal\clientside_validation\Plugin\CvValidator\Step
  2. 3.0.x src/Plugin/CvValidator/Step.php \Drupal\clientside_validation\Plugin\CvValidator\Step
  3. 2.0.x src/Plugin/CvValidator/Step.php \Drupal\clientside_validation\Plugin\CvValidator\Step

Provides a 'step' validator.

Plugin annotation


@CvValidator(
  id = "step",
  name = @Translation("Step"),
  supports = {
    "attributes" = {"step"}
  }
)

Hierarchy

Expanded class hierarchy of Step

File

src/Plugin/CvValidator/Step.php, line 19

Namespace

Drupal\clientside_validation\Plugin\CvValidator
View source
class Step extends CvValidatorBase {

  /**
   * {@inheritdoc}
   */
  protected function getRules($element, FormStateInterface $form_state) {
    $step = $this
      ->getAttributeValue($element, 'step');
    if ($step !== 'any') {
      if (isset($element['#step_error'])) {
        $message = $element['#step_error'];
      }
      elseif ($min = $this
        ->getAttributeValue($element, 'min')) {
        $message = $this
          ->t('The value in @title has to be greater than @min by steps of @step.', [
          '@title' => $this
            ->getElementTitle($element),
          '@step' => $step,
          '@min' => $min,
        ]);
      }
      else {
        $message = $this
          ->t('The value in @title has to be divisible by @step.', [
          '@title' => $this
            ->getElementTitle($element),
          '@step' => $step,
        ]);
      }
      return [
        'messages' => [
          'step' => $message,
        ],
      ];
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CvValidatorBase::addValidation public function Makes the necessary changes to the form element so it can be validated. Overrides CvValidatorInterface::addValidation 1
CvValidatorBase::getAttributeValue protected function Get the value of an attribute of an element.
CvValidatorBase::getElementTitle protected function Get title for form element.
CvValidatorBase::getName public function Return the name of the validator flavor. Overrides CvValidatorInterface::getName
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
Step::getRules protected function Get the validation rules for this form element. Overrides CvValidatorBase::getRules
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.