vendor/symfony/validator/Constraints/Ip.php line 28

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 Symfony\Component\Validator\Constraint;
  15. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  16. use Symfony\Component\Validator\Exception\InvalidArgumentException;
  18. /**
  19.  * Validates that a value is a valid IP address.
  20.  *
  21.  * @Annotation
  22.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  23.  *
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  * @author Joseph Bielawski <stloyd@gmail.com>
  26.  */
  27. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  28. class Ip extends Constraint
  29. {
  30.     public const V4 = '4';
  31.     public const V6 = '6';
  32.     public const ALL = 'all';
  34.     // adds FILTER_FLAG_NO_PRIV_RANGE flag (skip private ranges)
  35.     public const V4_NO_PRIV = '4_no_priv';
  36.     public const V6_NO_PRIV = '6_no_priv';
  37.     public const ALL_NO_PRIV = 'all_no_priv';
  39.     // adds FILTER_FLAG_NO_RES_RANGE flag (skip reserved ranges)
  40.     public const V4_NO_RES = '4_no_res';
  41.     public const V6_NO_RES = '6_no_res';
  42.     public const ALL_NO_RES = 'all_no_res';
  44.     // adds FILTER_FLAG_NO_PRIV_RANGE and FILTER_FLAG_NO_RES_RANGE flags (skip both)
  45.     public const V4_ONLY_PUBLIC = '4_public';
  46.     public const V6_ONLY_PUBLIC = '6_public';
  47.     public const ALL_ONLY_PUBLIC = 'all_public';
  49.     public const INVALID_IP_ERROR = 'b1b427ae-9f6f-41b0-aa9b-84511fbb3c5b';
  51.     protected static $versions = [
  52.         self::V4,
  53.         self::V6,
  54.         self::ALL,
  56.         self::V4_NO_PRIV,
  57.         self::V6_NO_PRIV,
  58.         self::ALL_NO_PRIV,
  60.         self::V4_NO_RES,
  61.         self::V6_NO_RES,
  62.         self::ALL_NO_RES,
  64.         self::V4_ONLY_PUBLIC,
  65.         self::V6_ONLY_PUBLIC,
  66.         self::ALL_ONLY_PUBLIC,
  67.     ];
  69.     protected static $errorNames = [
  70.         self::INVALID_IP_ERROR => 'INVALID_IP_ERROR',
  71.     ];
  73.     public $version = self::V4;
  75.     public $message = 'This is not a valid IP address.';
  77.     public $normalizer;
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function __construct(
  83.         ?array $options = null,
  84.         ?string $version = null,
  85.         ?string $message = null,
  86.         ?callable $normalizer = null,
  87.         ?array $groups = null,
  88.         $payload = null
  89.     ) {
  90.         parent::__construct($options, $groups, $payload);
  92.         $this->version = $version ?? $this->version;
  93.         $this->message = $message ?? $this->message;
  94.         $this->normalizer = $normalizer ?? $this->normalizer;
  96.         if (!\in_array($this->version, self::$versions)) {
  97.             throw new ConstraintDefinitionException(sprintf('The option "version" must be one of "%s".', implode('", "', self::$versions)));
  98.         }
  100.         if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
  101.             throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
  102.         }
  103.     }
  104. }