Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. RangeValidator.php

class RangeValidator

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
    • class \Symfony\Component\Validator\Constraints\RangeValidator extends \Symfony\Component\Validator\ConstraintValidator

Expanded class hierarchy of RangeValidator

File

vendor/symfony/validator/Constraints/RangeValidator.php, line 26

Namespace

Symfony\Component\Validator\Constraints
View source
class RangeValidator extends ConstraintValidator {
    public function __construct(?PropertyAccessorInterface $propertyAccessor = null) {
    }
    public function validate(mixed $value, Constraint $constraint) : void {
        if (!$constraint instanceof Range) {
            throw new UnexpectedTypeException($constraint, Range::class);
        }
        if (null === $value) {
            return;
        }
        $min = $this->getLimit($constraint->minPropertyPath, $constraint->min, $constraint);
        $max = $this->getLimit($constraint->maxPropertyPath, $constraint->max, $constraint);
        if (!is_numeric($value) && !$value instanceof \DateTimeInterface) {
            if ($this->isParsableDatetimeString($min) && $this->isParsableDatetimeString($max)) {
                $this->context
                    ->buildViolation($constraint->invalidDateTimeMessage)
                    ->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
                    ->setCode(Range::INVALID_CHARACTERS_ERROR)
                    ->addViolation();
            }
            else {
                $this->context
                    ->buildViolation($constraint->invalidMessage)
                    ->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
                    ->setCode(Range::INVALID_CHARACTERS_ERROR)
                    ->addViolation();
            }
            return;
        }
        // Convert strings to DateTimes if comparing another DateTime
        // This allows to compare with any date/time value supported by
        // the DateTime constructor:
        // https://php.net/datetime.formats
        if ($value instanceof \DateTimeInterface) {
            if (\is_string($min)) {
                try {
                    $min = new $value($min);
                } catch (\Exception) {
                    throw new ConstraintDefinitionException(\sprintf('The min value "%s" could not be converted to a "%s" instance in the "%s" constraint.', $min, get_debug_type($value), get_debug_type($constraint)));
                }
            }
            if (\is_string($max)) {
                try {
                    $max = new $value($max);
                } catch (\Exception) {
                    throw new ConstraintDefinitionException(\sprintf('The max value "%s" could not be converted to a "%s" instance in the "%s" constraint.', $max, get_debug_type($value), get_debug_type($constraint)));
                }
            }
        }
        $hasLowerLimit = null !== $min;
        $hasUpperLimit = null !== $max;
        if ($hasLowerLimit && $hasUpperLimit && ($value < $min || $value > $max)) {
            $message = $constraint->notInRangeMessage;
            $code = Range::NOT_IN_RANGE_ERROR;
            $violationBuilder = $this->context
                ->buildViolation($message)
                ->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
                ->setParameter('{{ min }}', $this->formatValue($min, self::PRETTY_DATE))
                ->setParameter('{{ max }}', $this->formatValue($max, self::PRETTY_DATE))
                ->setCode($code);
            if (null !== $constraint->maxPropertyPath) {
                $violationBuilder->setParameter('{{ max_limit_path }}', $constraint->maxPropertyPath);
            }
            if (null !== $constraint->minPropertyPath) {
                $violationBuilder->setParameter('{{ min_limit_path }}', $constraint->minPropertyPath);
            }
            $violationBuilder->addViolation();
            return;
        }
        if ($hasUpperLimit && $value > $max) {
            $violationBuilder = $this->context
                ->buildViolation($constraint->maxMessage)
                ->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
                ->setParameter('{{ limit }}', $this->formatValue($max, self::PRETTY_DATE))
                ->setCode(Range::TOO_HIGH_ERROR);
            if (null !== $constraint->maxPropertyPath) {
                $violationBuilder->setParameter('{{ max_limit_path }}', $constraint->maxPropertyPath);
            }
            if (null !== $constraint->minPropertyPath) {
                $violationBuilder->setParameter('{{ min_limit_path }}', $constraint->minPropertyPath);
            }
            $violationBuilder->addViolation();
            return;
        }
        if ($hasLowerLimit && $value < $min) {
            $violationBuilder = $this->context
                ->buildViolation($constraint->minMessage)
                ->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
                ->setParameter('{{ limit }}', $this->formatValue($min, self::PRETTY_DATE))
                ->setCode(Range::TOO_LOW_ERROR);
            if (null !== $constraint->maxPropertyPath) {
                $violationBuilder->setParameter('{{ max_limit_path }}', $constraint->maxPropertyPath);
            }
            if (null !== $constraint->minPropertyPath) {
                $violationBuilder->setParameter('{{ min_limit_path }}', $constraint->minPropertyPath);
            }
            $violationBuilder->addViolation();
        }
    }
    private function getLimit(?string $propertyPath, mixed $default, Constraint $constraint) : mixed {
        if (null === $propertyPath) {
            return $default;
        }
        if (null === ($object = $this->context
            ->getObject())) {
            return $default;
        }
        try {
            return $this->getPropertyAccessor()
                ->getValue($object, $propertyPath);
        } catch (NoSuchPropertyException $e) {
            throw new ConstraintDefinitionException(\sprintf('Invalid property path "%s" provided to "%s" constraint: ', $propertyPath, get_debug_type($constraint)) . $e->getMessage(), 0, $e);
        } catch (UninitializedPropertyException) {
            return null;
        }
    }
    private function getPropertyAccessor() : PropertyAccessorInterface {
        return $this->propertyAccessor ??= PropertyAccess::createPropertyAccessor();
    }
    private function isParsableDatetimeString(mixed $boundary) : bool {
        if (null === $boundary) {
            return true;
        }
        if (!\is_string($boundary)) {
            return false;
        }
        try {
            new \DateTimeImmutable($boundary);
        } catch (\Exception) {
            return false;
        }
        return true;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ConstraintValidator::$context protected property
ConstraintValidator::formatTypeOf protected function Returns a string representation of the type of the value.
ConstraintValidator::formatValue protected function Returns a string representation of the value.
ConstraintValidator::formatValues protected function Returns a string representation of a list of values.
ConstraintValidator::initialize public function Initializes the constraint validator. Overrides ConstraintValidatorInterface::initialize
ConstraintValidator::OBJECT_TO_STRING public constant Whether to cast objects with a &quot;__toString()&quot; method to strings.
ConstraintValidator::PRETTY_DATE public constant Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter}
(if it is available) or as RFC-3339 dates (&quot;Y-m-d H:i:s&quot;).
RangeValidator::getLimit private function
RangeValidator::getPropertyAccessor private function
RangeValidator::isParsableDatetimeString private function
RangeValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
RangeValidator::__construct public function
RSS feed
Powered by Drupal