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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Validator\Constraints;
  11. use Symfony\Component\Validator\Constraint;
  12. use Symfony\Component\Validator\Exception\InvalidArgumentException;
  13. /**
  14.  * @Annotation
  15.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  16.  *
  17.  * @author Bernhard Schussek <bschussek@gmail.com>
  18.  */
  19. #[\Attribute(\Attribute::TARGET_PROPERTY \Attribute::TARGET_METHOD \Attribute::IS_REPEATABLE)]
  20. class Regex extends Constraint
  21. {
  22.     public const REGEX_FAILED_ERROR 'de1e3db3-5ed4-4941-aae4-59f3667cc3a3';
  23.     protected const ERROR_NAMES = [
  24.         self::REGEX_FAILED_ERROR => 'REGEX_FAILED_ERROR',
  25.     ];
  26.     /**
  27.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  28.      */
  29.     protected static $errorNames self::ERROR_NAMES;
  30.     public $message 'This value is not valid.';
  31.     public $pattern;
  32.     public $htmlPattern;
  33.     public $match true;
  34.     public $normalizer;
  35.     public function __construct(
  36.         string|array|null $pattern,
  37.         string $message null,
  38.         string $htmlPattern null,
  39.         bool $match null,
  40.         callable $normalizer null,
  41.         array $groups null,
  42.         mixed $payload null,
  43.         array $options = []
  44.     ) {
  45.         if (\is_array($pattern)) {
  46.             $options array_merge($pattern$options);
  47.         } elseif (null !== $pattern) {
  48.             $options['value'] = $pattern;
  49.         }
  50.         parent::__construct($options$groups$payload);
  51.         $this->message $message ?? $this->message;
  52.         $this->htmlPattern $htmlPattern ?? $this->htmlPattern;
  53.         $this->match $match ?? $this->match;
  54.         $this->normalizer $normalizer ?? $this->normalizer;
  55.         if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  56.             throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).'get_debug_type($this->normalizer)));
  57.         }
  58.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function getDefaultOption(): ?string
  63.     {
  64.         return 'pattern';
  65.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function getRequiredOptions(): array
  70.     {
  71.         return ['pattern'];
  72.     }
  73.     /**
  74.      * Converts the htmlPattern to a suitable format for HTML5 pattern.
  75.      * Example: /^[a-z]+$/ would be converted to [a-z]+
  76.      * However, if options are specified, it cannot be converted.
  77.      *
  78.      * @see http://dev.w3.org/html5/spec/single-page.html#the-pattern-attribute
  79.      */
  80.     public function getHtmlPattern(): ?string
  81.     {
  82.         // If htmlPattern is specified, use it
  83.         if (null !== $this->htmlPattern) {
  84.             return empty($this->htmlPattern)
  85.                 ? null
  86.                 $this->htmlPattern;
  87.         }
  88.         // Quit if delimiters not at very beginning/end (e.g. when options are passed)
  89.         if ($this->pattern[0] !== $this->pattern[\strlen($this->pattern) - 1]) {
  90.             return null;
  91.         }
  92.         $delimiter $this->pattern[0];
  93.         // Unescape the delimiter
  94.         $pattern str_replace('\\'.$delimiter$delimitersubstr($this->pattern1, -1));
  95.         // If the pattern is inverted, we can wrap it in
  96.         // ((?!pattern).)*
  97.         if (!$this->match) {
  98.             return '((?!'.$pattern.').)*';
  99.         }
  100.         // If the pattern contains an or statement, wrap the pattern in
  101.         // .*(pattern).* and quit. Otherwise we'd need to parse the pattern
  102.         if (str_contains($pattern'|')) {
  103.             return '.*('.$pattern.').*';
  104.         }
  105.         // Trim leading ^, otherwise prepend .*
  106.         $pattern '^' === $pattern[0] ? substr($pattern1) : '.*'.$pattern;
  107.         // Trim trailing $, otherwise append .*
  108.         $pattern '$' === $pattern[\strlen($pattern) - 1] ? substr($pattern0, -1) : $pattern.'.*';
  109.         return $pattern;
  110.     }
  111. }