vendor/symfony/validator/Constraints/AbstractComparisonValidator.php line 32

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Validator\Constraints;
  14. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  15. use Symfony\Component\PropertyAccess\PropertyAccess;
  16. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  17. use Symfony\Component\Validator\Constraint;
  18. use Symfony\Component\Validator\ConstraintValidator;
  19. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  20. use Symfony\Component\Validator\Exception\UnexpectedTypeException;
  22. /**
  23.  * Provides a base class for the validation of property comparisons.
  24.  *
  25.  * @author Daniel Holmes <daniel@danielholmes.org>
  26.  * @author Bernhard Schussek <bschussek@gmail.com>
  27.  */
  28. abstract class AbstractComparisonValidator extends ConstraintValidator
  29. {
  30.     private ?PropertyAccessorInterface $propertyAccessor;
  32.     public function __construct(PropertyAccessorInterface $propertyAccessor = null)
  33.     {
  34.         $this->propertyAccessor = $propertyAccessor;
  35.     }
  37.     public function validate(mixed $value, Constraint $constraint)
  38.     {
  39.         if (!$constraint instanceof AbstractComparison) {
  40.             throw new UnexpectedTypeException($constraint, AbstractComparison::class);
  41.         }
  43.         if (null === $value) {
  44.             return;
  45.         }
  47.         if ($path = $constraint->propertyPath) {
  48.             if (null === $object = $this->context->getObject()) {
  49.                 return;
  50.             }
  52.             try {
  53.                 $comparedValue = $this->getPropertyAccessor()->getValue($object, $path);
  54.             } catch (NoSuchPropertyException $e) {
  55.                 throw new ConstraintDefinitionException(sprintf('Invalid property path "%s" provided to "%s" constraint: ', $path, get_debug_type($constraint)).$e->getMessage(), 0, $e);
  56.             }
  57.         } else {
  58.             $comparedValue = $constraint->value;
  59.         }
  61.         // Convert strings to DateTimes if comparing another DateTime
  62.         // This allows to compare with any date/time value supported by
  63.         // the DateTime constructor:
  64.         // https://php.net/datetime.formats
  65.         if (\is_string($comparedValue) && $value instanceof \DateTimeInterface) {
  66.             // If $value is immutable, convert the compared value to a DateTimeImmutable too, otherwise use DateTime
  67.             $dateTimeClass = $value instanceof \DateTimeImmutable ? \DateTimeImmutable::class : \DateTime::class;
  69.             try {
  70.                 $comparedValue = new $dateTimeClass($comparedValue);
  71.             } catch (\Exception) {
  72.                 throw new ConstraintDefinitionException(sprintf('The compared value "%s" could not be converted to a "%s" instance in the "%s" constraint.', $comparedValue, $dateTimeClass, get_debug_type($constraint)));
  73.             }
  74.         }
  76.         if (!$this->compareValues($value, $comparedValue)) {
  77.             $violationBuilder = $this->context->buildViolation($constraint->message)
  78.                 ->setParameter('{{ value }}', $this->formatValue($value, self::OBJECT_TO_STRING | self::PRETTY_DATE))
  79.                 ->setParameter('{{ compared_value }}', $this->formatValue($comparedValue, self::OBJECT_TO_STRING | self::PRETTY_DATE))
  80.                 ->setParameter('{{ compared_value_type }}', $this->formatTypeOf($comparedValue))
  81.                 ->setCode($this->getErrorCode());
  83.             if (null !== $path) {
  84.                 $violationBuilder->setParameter('{{ compared_value_path }}', $path);
  85.             }
  87.             $violationBuilder->addViolation();
  88.         }
  89.     }
  91.     private function getPropertyAccessor(): PropertyAccessorInterface
  92.     {
  93.         return $this->propertyAccessor ??= PropertyAccess::createPropertyAccessor();
  94.     }
  96.     /**
  97.      * Compares the two given values to find if their relationship is valid.
  98.      */
  99.     abstract protected function compareValues(mixed $value1, mixed $value2): bool;
  101.     /**
  102.      * Returns the error code used if the comparison fails.
  103.      */
  104.     protected function getErrorCode(): ?string
  105.     {
  106.         return null;
  107.     }
  108. }