vendor/symfony/validator/Constraints/Range.php line 116

Open in your IDE?
  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\PropertyAccess;
  15. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  16. use Symfony\Component\Validator\Constraint;
  17. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  18. use Symfony\Component\Validator\Exception\LogicException;
  19. use Symfony\Component\Validator\Exception\MissingOptionsException;
  21. /**
  22.  * @Annotation
  23.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  24.  *
  25.  * @author Bernhard Schussek <bschussek@gmail.com>
  26.  */
  27. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  28. class Range extends Constraint
  29. {
  30.     public const INVALID_CHARACTERS_ERROR = 'ad9a9798-7a99-4df7-8ce9-46e416a1e60b';
  31.     public const NOT_IN_RANGE_ERROR = '04b91c99-a946-4221-afc5-e65ebac401eb';
  32.     public const TOO_HIGH_ERROR = '2d28afcb-e32e-45fb-a815-01c431a86a69';
  33.     public const TOO_LOW_ERROR = '76454e69-502c-46c5-9643-f447d837c4d5';
  35.     protected static $errorNames = [
  36.         self::INVALID_CHARACTERS_ERROR => 'INVALID_CHARACTERS_ERROR',
  37.         self::NOT_IN_RANGE_ERROR => 'NOT_IN_RANGE_ERROR',
  38.         self::TOO_HIGH_ERROR => 'TOO_HIGH_ERROR',
  39.         self::TOO_LOW_ERROR => 'TOO_LOW_ERROR',
  40.     ];
  42.     public $notInRangeMessage = 'This value should be between {{ min }} and {{ max }}.';
  43.     public $minMessage = 'This value should be {{ limit }} or more.';
  44.     public $maxMessage = 'This value should be {{ limit }} or less.';
  45.     public $invalidMessage = 'This value should be a valid number.';
  46.     public $invalidDateTimeMessage = 'This value should be a valid datetime.';
  47.     public $min;
  48.     public $minPropertyPath;
  49.     public $max;
  50.     public $maxPropertyPath;
  52.     /**
  53.      * @internal
  54.      */
  55.     public $deprecatedMinMessageSet = false;
  57.     /**
  58.      * @internal
  59.      */
  60.     public $deprecatedMaxMessageSet = false;
  62.     /**
  63.      * {@inheritdoc}
  64.      *
  65.      * @param string|PropertyPathInterface|null $minPropertyPath
  66.      * @param string|PropertyPathInterface|null $maxPropertyPath
  67.      */
  68.     public function __construct(
  69.         ?array $options = null,
  70.         ?string $notInRangeMessage = null,
  71.         ?string $minMessage = null,
  72.         ?string $maxMessage = null,
  73.         ?string $invalidMessage = null,
  74.         ?string $invalidDateTimeMessage = null,
  75.         $min = null,
  76.         $minPropertyPath = null,
  77.         $max = null,
  78.         $maxPropertyPath = null,
  79.         ?array $groups = null,
  80.         $payload = null
  81.     ) {
  82.         parent::__construct($options, $groups, $payload);
  84.         $this->notInRangeMessage = $notInRangeMessage ?? $this->notInRangeMessage;
  85.         $this->minMessage = $minMessage ?? $this->minMessage;
  86.         $this->maxMessage = $maxMessage ?? $this->maxMessage;
  87.         $this->invalidMessage = $invalidMessage ?? $this->invalidMessage;
  88.         $this->invalidDateTimeMessage = $invalidDateTimeMessage ?? $this->invalidDateTimeMessage;
  89.         $this->min = $min ?? $this->min;
  90.         $this->minPropertyPath = $minPropertyPath ?? $this->minPropertyPath;
  91.         $this->max = $max ?? $this->max;
  92.         $this->maxPropertyPath = $maxPropertyPath ?? $this->maxPropertyPath;
  94.         if (null === $this->min && null === $this->minPropertyPath && null === $this->max && null === $this->maxPropertyPath) {
  95.             throw new MissingOptionsException(sprintf('Either option "min", "minPropertyPath", "max" or "maxPropertyPath" must be given for constraint "%s".', __CLASS__), ['min', 'minPropertyPath', 'max', 'maxPropertyPath']);
  96.         }
  98.         if (null !== $this->min && null !== $this->minPropertyPath) {
  99.             throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires only one of the "min" or "minPropertyPath" options to be set, not both.', static::class));
  100.         }
  102.         if (null !== $this->max && null !== $this->maxPropertyPath) {
  103.             throw new ConstraintDefinitionException(sprintf('The "%s" constraint requires only one of the "max" or "maxPropertyPath" options to be set, not both.', static::class));
  104.         }
  106.         if ((null !== $this->minPropertyPath || null !== $this->maxPropertyPath) && !class_exists(PropertyAccess::class)) {
  107.             throw new LogicException(sprintf('The "%s" constraint requires the Symfony PropertyAccess component to use the "minPropertyPath" or "maxPropertyPath" option.', static::class));
  108.         }
  110.         if (null !== $this->min && null !== $this->max) {
  111.             $this->deprecatedMinMessageSet = isset($options['minMessage']) || null !== $minMessage;
  112.             $this->deprecatedMaxMessageSet = isset($options['maxMessage']) || null !== $maxMessage;
  114.             // BC layer, should throw a ConstraintDefinitionException in 6.0
  115.             if ($this->deprecatedMinMessageSet || $this->deprecatedMaxMessageSet) {
  116.                 trigger_deprecation('symfony/validator', '4.4', '"minMessage" and "maxMessage" are deprecated when the "min" and "max" options are both set. Use "notInRangeMessage" instead.');
  117.             }
  118.         }
  119.     }
  120. }