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 = 'html5';
  29. public const VALIDATION_MODE_STRICT = 'strict';
  30. public const VALIDATION_MODE_LOOSE = 'loose';
  32. public const INVALID_FORMAT_ERROR = 'bd79c0ab-ddba-46cc-a703-a7a4b08de310';
  34. protected static $errorNames = [
  35. self::INVALID_FORMAT_ERROR => 'INVALID_FORMAT_ERROR',
  36. ];
  38. /**
  39. * @var string[]
  40. *
  41. * @internal
  42. */
  43. public static $validationModes = [
  44. self::VALIDATION_MODE_HTML5,
  45. self::VALIDATION_MODE_STRICT,
  46. self::VALIDATION_MODE_LOOSE,
  47. ];
  49. public $message = 'This value is not a valid email address.';
  50. public $mode;
  51. public $normalizer;
  53. public function __construct(
  54. ?array $options = null,
  55. ?string $message = null,
  56. ?string $mode = null,
  57. ?callable $normalizer = null,
  58. ?array $groups = null,
  59. $payload = null
  60. ) {
  61. if (\is_array($options) && \array_key_exists('mode', $options) && !\in_array($options['mode'], self::$validationModes, true)) {
  62. throw new InvalidArgumentException('The "mode" parameter value is not valid.');
  63. }
  65. if (null !== $mode && !\in_array($mode, self::$validationModes, true)) {
  66. throw new InvalidArgumentException('The "mode" parameter value is not valid.');
  67. }
  69. parent::__construct($options, $groups, $payload);
  71. $this->message = $message ?? $this->message;
  72. $this->mode = $mode ?? $this->mode;
  73. $this->normalizer = $normalizer ?? $this->normalizer;
  75. if (self::VALIDATION_MODE_STRICT === $this->mode && !class_exists(StrictEmailValidator::class)) {
  76. throw new LogicException(sprintf('The "egulias/email-validator" component is required to use the "%s" constraint in strict mode.', __CLASS__));
  77. }
  79. if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  80. throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
  81. }
  82. }
  83. }