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

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