vendor/symfony/validator/Constraints/Email.php line 26

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 Egulias\EmailValidator\EmailValidator as StrictEmailValidator;
  15. use Symfony\Component\Validator\Constraint;
  16. use Symfony\Component\Validator\Exception\InvalidArgumentException;
  17. use Symfony\Component\Validator\Exception\LogicException;
  19. /**
  20. * @Annotation
  21. * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  22. *
  23. * @author Bernhard Schussek <bschussek@gmail.com>
  24. */
  25. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  26. class Email extends Constraint
  27. {
  28. public const VALIDATION_MODE_HTML5_ALLOW_NO_TLD = 'html5-allow-no-tld';
  29. public const VALIDATION_MODE_HTML5 = 'html5';
  30. public const VALIDATION_MODE_STRICT = 'strict';
  31. /**
  32. * @deprecated since Symfony 6.2, use VALIDATION_MODE_HTML5 instead
  33. */
  34. public const VALIDATION_MODE_LOOSE = 'loose';
  36. public const INVALID_FORMAT_ERROR = 'bd79c0ab-ddba-46cc-a703-a7a4b08de310';
  38. public const VALIDATION_MODES = [
  39. self::VALIDATION_MODE_HTML5_ALLOW_NO_TLD,
  40. self::VALIDATION_MODE_HTML5,
  41. self::VALIDATION_MODE_STRICT,
  42. self::VALIDATION_MODE_LOOSE,
  43. ];
  45. protected const ERROR_NAMES = [
  46. self::INVALID_FORMAT_ERROR => 'INVALID_FORMAT_ERROR',
  47. ];
  49. /**
  50. * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  51. */
  52. protected static $errorNames = self::ERROR_NAMES;
  54. public $message = 'This value is not a valid email address.';
  55. public $mode;
  56. /** @var callable|null */
  57. public $normalizer;
  59. public function __construct(
  60. ?array $options = null,
  61. ?string $message = null,
  62. ?string $mode = null,
  63. ?callable $normalizer = null,
  64. ?array $groups = null,
  65. mixed $payload = null,
  66. ) {
  67. if (\is_array($options) && \array_key_exists('mode', $options) && !\in_array($options['mode'], self::VALIDATION_MODES, true)) {
  68. throw new InvalidArgumentException('The "mode" parameter value is not valid.');
  69. }
  71. if (null !== $mode && !\in_array($mode, self::VALIDATION_MODES, true)) {
  72. throw new InvalidArgumentException('The "mode" parameter value is not valid.');
  73. }
  75. parent::__construct($options, $groups, $payload);
  77. $this->message = $message ?? $this->message;
  78. $this->mode = $mode ?? $this->mode;
  79. $this->normalizer = $normalizer ?? $this->normalizer;
  81. if (self::VALIDATION_MODE_LOOSE === $this->mode) {
  82. trigger_deprecation('symfony/validator', '6.2', 'The "%s" mode is deprecated. It will be removed in 7.0 and the default mode will be changed to "%s".', self::VALIDATION_MODE_LOOSE, self::VALIDATION_MODE_HTML5);
  83. }
  85. if (self::VALIDATION_MODE_STRICT === $this->mode && !class_exists(StrictEmailValidator::class)) {
  86. throw new LogicException(\sprintf('The "egulias/email-validator" component is required to use the "%s" constraint in strict mode. Try running "composer require egulias/email-validator".', __CLASS__));
  87. }
  89. if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  90. throw new InvalidArgumentException(\sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
  91. }
  92. }
  93. }