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

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. class Email extends Constraint
  26. {
  27.     public const VALIDATION_MODE_HTML5 = 'html5';
  28.     public const VALIDATION_MODE_STRICT = 'strict';
  29.     public const VALIDATION_MODE_LOOSE = 'loose';
  31.     public const INVALID_FORMAT_ERROR = 'bd79c0ab-ddba-46cc-a703-a7a4b08de310';
  33.     /**
  34.      * @deprecated since Symfony 4.2.
  35.      */
  36.     public const MX_CHECK_FAILED_ERROR = 'bf447c1c-0266-4e10-9c6c-573df282e413';
  38.     /**
  39.      * @deprecated since Symfony 4.2.
  40.      */
  41.     public const HOST_CHECK_FAILED_ERROR = '7da53a8b-56f3-4288-bb3e-ee9ede4ef9a1';
  43.     protected static $errorNames = [
  44.         self::INVALID_FORMAT_ERROR => 'STRICT_CHECK_FAILED_ERROR',
  45.         self::MX_CHECK_FAILED_ERROR => 'MX_CHECK_FAILED_ERROR',
  46.         self::HOST_CHECK_FAILED_ERROR => 'HOST_CHECK_FAILED_ERROR',
  47.     ];
  49.     /**
  50.      * @var string[]
  51.      *
  52.      * @internal
  53.      */
  54.     public static $validationModes = [
  55.         self::VALIDATION_MODE_HTML5,
  56.         self::VALIDATION_MODE_STRICT,
  57.         self::VALIDATION_MODE_LOOSE,
  58.     ];
  60.     public $message = 'This value is not a valid email address.';
  62.     /**
  63.      * @deprecated since Symfony 4.2.
  64.      */
  65.     public $checkMX = false;
  67.     /**
  68.      * @deprecated since Symfony 4.2.
  69.      */
  70.     public $checkHost = false;
  72.     /**
  73.      * @deprecated since Symfony 4.1, set mode to "strict" instead.
  74.      */
  75.     public $strict;
  76.     public $mode;
  77.     public $normalizer;
  79.     public function __construct($options = null)
  80.     {
  81.         if (\is_array($options) && \array_key_exists('strict', $options)) {
  82.             @trigger_error(sprintf('The "strict" property is deprecated since Symfony 4.1. Use "mode"=>"%s" instead.', self::VALIDATION_MODE_STRICT), \E_USER_DEPRECATED);
  83.         }
  85.         if (\is_array($options) && \array_key_exists('checkMX', $options)) {
  86.             @trigger_error('The "checkMX" option is deprecated since Symfony 4.2.', \E_USER_DEPRECATED);
  87.         }
  89.         if (\is_array($options) && \array_key_exists('checkHost', $options)) {
  90.             @trigger_error('The "checkHost" option is deprecated since Symfony 4.2.', \E_USER_DEPRECATED);
  91.         }
  93.         if (\is_array($options) && \array_key_exists('mode', $options) && !\in_array($options['mode'], self::$validationModes, true)) {
  94.             throw new InvalidArgumentException('The "mode" parameter value is not valid.');
  95.         }
  97.         parent::__construct($options);
  99.         if ((self::VALIDATION_MODE_STRICT === $this->mode || true === $this->strict) && !class_exists(StrictEmailValidator::class)) {
  100.             // throw new LogicException(sprintf('The "egulias/email-validator" component is required to use the "%s" constraint in strict mode.', __CLASS__));
  101.             @trigger_error(sprintf('Using the "%s" constraint in strict mode without the "egulias/email-validator" component installed is deprecated since Symfony 4.2.', __CLASS__), \E_USER_DEPRECATED);
  102.         }
  104.         if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  105.             throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
  106.         }
  107.     }
  108. }