vendor/odolbeau/phone-number-bundle/src/Validator/Constraints/PhoneNumber.php line 24

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony2 PhoneNumberBundle.
  5.  *
  6.  * (c) University of Cambridge
  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 Misd\PhoneNumberBundle\Validator\Constraints;
  14. use Misd\PhoneNumberBundle\Exception\InvalidArgumentException;
  15. use Symfony\Component\Validator\Constraint;
  17. /**
  18.  * Phone number constraint.
  19.  *
  20.  * @Annotation
  21.  * @NamedArgumentConstructor
  22.  */
  23. #[\Attribute(\Attribute::TARGET_PROPERTY)]
  24. class PhoneNumber extends Constraint
  25. {
  26.     public const ANY = 'any';
  27.     public const FIXED_LINE = 'fixed_line';
  28.     public const MOBILE = 'mobile';
  29.     public const PAGER = 'pager';
  30.     public const PERSONAL_NUMBER = 'personal_number';
  31.     public const PREMIUM_RATE = 'premium_rate';
  32.     public const SHARED_COST = 'shared_cost';
  33.     public const TOLL_FREE = 'toll_free';
  34.     public const UAN = 'uan';
  35.     public const VOIP = 'voip';
  36.     public const VOICEMAIL = 'voicemail';
  38.     public const INVALID_PHONE_NUMBER_ERROR = 'ca23f4ca-38f4-4325-9bcc-eb570a4abe7f';
  40.     protected const ERROR_NAMES = [
  41.         self::INVALID_PHONE_NUMBER_ERROR => 'INVALID_PHONE_NUMBER_ERROR',
  42.     ];
  44.     /**
  45.      * @deprecated since PhoneNumberBundle 3.6, use const ERROR_NAMES instead
  46.      */
  47.     protected static $errorNames = self::ERROR_NAMES;
  49.     public $message = null;
  50.     public $type = self::ANY;
  51.     public $defaultRegion = null;
  52.     public $regionPath = null;
  53.     public $format = null;
  55.     /**
  56.      * {@inheritdoc}
  57.      *
  58.      * @param int|array|null    $format Specify the format (\libphonenumber\PhoneNumberFormat::*)
  59.      *                                  or options (an associative array)
  60.      * @param string|array|null $type
  61.      */
  62.     public function __construct($format = null, $type = null, string $defaultRegion = null, string $regionPath = null, string $message = null, array $groups = null, $payload = null, array $options = [])
  63.     {
  64.         if (\is_array($format)) {
  65.             @trigger_error('Usage of the argument $format to specify options is deprecated and will be removed in 4.0. Use "$option" argument instead.', \E_USER_DEPRECATED);
  66.             $options = array_merge($format, $options);
  67.         } else {
  68.             $phoneFormat = $format;
  69.         }
  71.         parent::__construct($options, $groups, $payload);
  73.         $this->message = $message ?? $this->message;
  74.         $this->format = $phoneFormat ?? $this->format;
  75.         $this->type = $type ?? $this->type;
  76.         $this->defaultRegion = $defaultRegion ?? $this->defaultRegion;
  77.         $this->regionPath = $regionPath ?? $this->regionPath;
  78.     }
  80.     public function getType(): ?string
  81.     {
  82.         @trigger_error(__METHOD__.' is deprecated and will be removed in 4.0. Use "getTypes" instead.', \E_USER_DEPRECATED);
  84.         $types = $this->getTypes();
  85.         if (0 === \count($types)) {
  86.             return null;
  87.         }
  89.         return reset($types);
  90.     }
  92.     public function getTypes(): array
  93.     {
  94.         if (\is_array($this->type)) {
  95.             return $this->type;
  96.         }
  98.         return [$this->type];
  99.     }
  101.     public function getMessage(): string
  102.     {
  103.         if (null !== $this->message) {
  104.             return $this->message;
  105.         }
  107.         $types = $this->getTypes();
  108.         if (1 === \count($types)) {
  109.             $typeName = $this->getTypeName($types[0]);
  111.             return "This value is not a valid $typeName.";
  112.         }
  114.         return 'This value is not a valid number.';
  115.     }
  117.     public function getTypeNames(): array
  118.     {
  119.         $types = \is_array($this->type) ? $this->type : [$this->type];
  121.         $typeNames = [];
  122.         foreach ($types as $type) {
  123.             $typeNames[] = $this->getTypeName($type);
  124.         }
  126.         return $typeNames;
  127.     }
  129.     private function getTypeName(string $type): string
  130.     {
  131.         switch ($type) {
  132.             case self::FIXED_LINE:
  133.                 return 'fixed-line number';
  134.             case self::MOBILE:
  135.                 return 'mobile number';
  136.             case self::PAGER:
  137.                 return 'pager number';
  138.             case self::PERSONAL_NUMBER:
  139.                 return 'personal number';
  140.             case self::PREMIUM_RATE:
  141.                 return 'premium-rate number';
  142.             case self::SHARED_COST:
  143.                 return 'shared-cost number';
  144.             case self::TOLL_FREE:
  145.                 return 'toll-free number';
  146.             case self::UAN:
  147.                 return 'UAN';
  148.             case self::VOIP:
  149.                 return 'VoIP number';
  150.             case self::VOICEMAIL:
  151.                 return 'voicemail access number';
  152.             case self::ANY:
  153.                 return 'phone number';
  154.         }
  156.         throw new InvalidArgumentException("Unknown phone number type \"$type\".");
  157.     }
  158. }