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 <[email protected]>
  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 <[email protected]>
  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 static $errorNames = [
  29. self::REGEX_FAILED_ERROR => 'REGEX_FAILED_ERROR',
  30. ];
  32. public $message = 'This value is not valid.';
  33. public $pattern;
  34. public $htmlPattern;
  35. public $match = true;
  36. public $normalizer;
  38. /**
  39. * {@inheritdoc}
  40. *
  41. * @param string|array $pattern The pattern to evaluate or an array of options
  42. */
  43. public function __construct(
  44. $pattern,
  45. ?string $message = null,
  46. ?string $htmlPattern = null,
  47. ?bool $match = null,
  48. ?callable $normalizer = null,
  49. ?array $groups = null,
  50. $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()
  75. {
  76. return 'pattern';
  77. }
  79. /**
  80. * {@inheritdoc}
  81. */
  82. public function getRequiredOptions()
  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. * @return string|null
  95. */
  96. public function getHtmlPattern()
  97. {
  98. // If htmlPattern is specified, use it
  99. if (null !== $this->htmlPattern) {
  100. return empty($this->htmlPattern)
  101. ? null
  102. : $this->htmlPattern;
  103. }
  105. // Quit if delimiters not at very beginning/end (e.g. when options are passed)
  106. if ($this->pattern[0] !== $this->pattern[\strlen($this->pattern) - 1]) {
  107. return null;
  108. }
  110. $delimiter = $this->pattern[0];
  112. // Unescape the delimiter
  113. $pattern = str_replace('\\'.$delimiter, $delimiter, substr($this->pattern, 1, -1));
  115. // If the pattern is inverted, we can wrap it in
  116. // ((?!pattern).)*
  117. if (!$this->match) {
  118. return '((?!'.$pattern.').)*';
  119. }
  121. // If the pattern contains an or statement, wrap the pattern in
  122. // .*(pattern).* and quit. Otherwise we'd need to parse the pattern
  123. if (str_contains($pattern, '|')) {
  124. return '.*('.$pattern.').*';
  125. }
  127. // Trim leading ^, otherwise prepend .*
  128. $pattern = '^' === $pattern[0] ? substr($pattern, 1) : '.*'.$pattern;
  130. // Trim trailing $, otherwise append .*
  131. $pattern = '$' === $pattern[\strlen($pattern) - 1] ? substr($pattern, 0, -1) : $pattern.'.*';
  133. return $pattern;
  134. }
  135. }