vendor/symfony/validator/Constraints/Regex.php line 24

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\Validator\Constraint;
  15. use Symfony\Component\Validator\Exception\InvalidArgumentException;
  17. /**
  18.  * @Annotation
  19.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  24. class Regex extends Constraint
  25. {
  26.     public const REGEX_FAILED_ERROR = 'de1e3db3-5ed4-4941-aae4-59f3667cc3a3';
  28.     protected const ERROR_NAMES = [
  29.         self::REGEX_FAILED_ERROR => 'REGEX_FAILED_ERROR',
  30.     ];
  32.     /**
  33.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  34.      */
  35.     protected static $errorNames = self::ERROR_NAMES;
  37.     public $message = 'This value is not valid.';
  38.     public $pattern;
  39.     public $htmlPattern;
  40.     public $match = true;
  41.     public $normalizer;
  43.     public function __construct(
  44.         string|array|null $pattern,
  45.         string $message = null,
  46.         string $htmlPattern = null,
  47.         bool $match = null,
  48.         callable $normalizer = null,
  49.         array $groups = null,
  50.         mixed $payload = null,
  51.         array $options = []
  52.     ) {
  53.         if (\is_array($pattern)) {
  54.             $options = array_merge($pattern, $options);
  55.         } elseif (null !== $pattern) {
  56.             $options['value'] = $pattern;
  57.         }
  59.         parent::__construct($options, $groups, $payload);
  61.         $this->message = $message ?? $this->message;
  62.         $this->htmlPattern = $htmlPattern ?? $this->htmlPattern;
  63.         $this->match = $match ?? $this->match;
  64.         $this->normalizer = $normalizer ?? $this->normalizer;
  66.         if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  67.             throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
  68.         }
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function getDefaultOption(): ?string
  75.     {
  76.         return 'pattern';
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function getRequiredOptions(): array
  83.     {
  84.         return ['pattern'];
  85.     }
  87.     /**
  88.      * Converts the htmlPattern to a suitable format for HTML5 pattern.
  89.      * Example: /^[a-z]+$/ would be converted to [a-z]+
  90.      * However, if options are specified, it cannot be converted.
  91.      *
  92.      * @see http://dev.w3.org/html5/spec/single-page.html#the-pattern-attribute
  93.      */
  94.     public function getHtmlPattern(): ?string
  95.     {
  96.         // If htmlPattern is specified, use it
  97.         if (null !== $this->htmlPattern) {
  98.             return empty($this->htmlPattern)
  99.                 ? null
  100.                 : $this->htmlPattern;
  101.         }
  103.         // Quit if delimiters not at very beginning/end (e.g. when options are passed)
  104.         if ($this->pattern[0] !== $this->pattern[\strlen($this->pattern) - 1]) {
  105.             return null;
  106.         }
  108.         $delimiter = $this->pattern[0];
  110.         // Unescape the delimiter
  111.         $pattern = str_replace('\\'.$delimiter, $delimiter, substr($this->pattern, 1, -1));
  113.         // If the pattern is inverted, we can wrap it in
  114.         // ((?!pattern).)*
  115.         if (!$this->match) {
  116.             return '((?!'.$pattern.').)*';
  117.         }
  119.         // If the pattern contains an or statement, wrap the pattern in
  120.         // .*(pattern).* and quit. Otherwise we'd need to parse the pattern
  121.         if (str_contains($pattern, '|')) {
  122.             return '.*('.$pattern.').*';
  123.         }
  125.         // Trim leading ^, otherwise prepend .*
  126.         $pattern = '^' === $pattern[0] ? substr($pattern, 1) : '.*'.$pattern;
  128.         // Trim trailing $, otherwise append .*
  129.         $pattern = '$' === $pattern[\strlen($pattern) - 1] ? substr($pattern, 0, -1) : $pattern.'.*';
  131.         return $pattern;
  132.     }
  133. }