Add new "requiredRegion" to PhoneNumberValidator

This option allows to validate the region of the phone number

Author: Nek-

src/Validator/Constraints/PhoneNumber.php

@@ -52,6 +52,7 @@ class PhoneNumber extends Constraint
     public string|array $type = self::ANY;
     public ?string $defaultRegion = null;
     public ?string $regionPath = null;
+    public ?string $requiredRegion = null;
     public ?PhoneNumberFormat $format = null;
 
     /**
@@ -69,6 +70,7 @@ public function __construct(
         ?array $groups = null,
         $payload = null,
         ?array $options = null,
+        ?string $requiredRegion = null,
     ) {
         parent::__construct($options, $groups, $payload);
 
@@ -82,6 +84,7 @@ public function __construct(
         $this->type = $type ?? $this->type;
         $this->defaultRegion = $defaultRegion ?? $this->defaultRegion;
         $this->regionPath = $regionPath ?? $this->regionPath;
+        $this->requiredRegion = $requiredRegion ?? $this->requiredRegion;
     }
 
     /**

src/Validator/Constraints/PhoneNumberValidator.php

@@ -88,6 +88,10 @@ public function validate(mixed $value, Constraint $constraint): void
             return;
         }
 
+        if (null !== $constraint->requiredRegion && false === $this->phoneUtil->isValidNumberForRegion($phoneNumber, $constraint->requiredRegion)) {
+            $this->addViolation($value, $constraint);
+        }
+
         $validTypes = [];
         foreach ($constraint->getTypes() as $type) {
             switch ($type) {

tests/Validator/Constraints/PhoneNumberValidatorTest.php

@@ -57,8 +57,9 @@ public function testValidate(
         ?string $defaultRegion = null,
         ?string $regionPath = null,
         PhoneNumberFormat|int|null $format = null,
+        ?string $requiredRegion = null,
     ): void {
-        $constraint = new PhoneNumber($format, $type, $defaultRegion, $regionPath);
+        $constraint = new PhoneNumber($format, $type, $defaultRegion, $regionPath, requiredRegion: $requiredRegion);
 
         if (true === $violates) {
             $constraintViolationBuilder = $this->createMock(ConstraintViolationBuilderInterface::class);
@@ -112,8 +113,18 @@ public function testValidateFromAttribute(): void
      * 2 => Type (optional)
      * 3 => Default region (optional).
      * 4 => Region Path (optional).
+     * 5 => Format (optional)
+     * 6 => Required region (optional).
      *
-     * @return iterable<array{string|LibPhoneNumber|null, bool, 2?: string|string[]|null, 3?: ?string, 4?: ?string, 5?: PhoneNumberFormat|int|null}>
+     * @return iterable<array{
+     *     string|LibPhoneNumber|null,
+     *     bool,
+     *     2?: string|string[]|null,
+     *     3?: ?string,
+     *     4?: ?string,
+     *     5?: PhoneNumberFormat|int|null,
+     *     6?: string|null
+     *  }>
      */
     public function validateProvider(): iterable
     {
@@ -160,6 +171,8 @@ public function validateProvider(): iterable
         yield ['+33606060606', false, 'mobile', null, 'regionPath'];
         yield ['+33606060606', false, 'mobile', null, null, PhoneNumberFormat::E164];
         yield ['2015555555', true, null, null, null, PhoneNumberFormat::E164];
+        yield ['+33650505050', false, null, null, null, PhoneNumberFormat::E164, 'FR'];
+        yield ['+33650505050', true, null, null, null, PhoneNumberFormat::E164, 'EN'];
 
         // Ensure BC promise is respected
         yield ['+33606060606', false, 'mobile', null, null, 0];