Merge pull request #95 from nicolassing/master

odolbeau · Dec 19, 2022 · b07b919 · b07b919
2 parents d470db6 + 534552b
commit b07b919
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Add a feature to change country display format in form
 
 ### Added
 

diff --git a/README.md b/README.md
@@ -169,6 +169,12 @@ This produces the preferred choices of 'Jersey' and 'United Kingdom', and regula
 By default the `country_choices` is empty, which means all countries are included, as is `preferred_country_choices`.
 The option `country_placeholder` can be specified to create a placeholder option on above the whole list.
 
+The option `country_display_type` can be specified to change the country dropdown label format. There are two formats available :
+| display type                      | Result                 |
+| ----------------------------------| -----------------------|
+| `display_country_full` (default)  |  United Kingdom (+44)  |
+| `display_country_short`           |  GB +44                |
+
 ### Validating phone numbers
 
 ℹ️ _Using a Symfony or PHP version that does not support attributes? This bundle also supports validation as annotation.

diff --git a/src/Form/Type/PhoneNumberType.php b/src/Form/Type/PhoneNumberType.php
@@ -33,6 +33,9 @@ class PhoneNumberType extends AbstractType
     public const WIDGET_SINGLE_TEXT = 'single_text';
     public const WIDGET_COUNTRY_CHOICE = 'country_choice';
 
+    public const DISPLAY_COUNTRY_FULL = 'display_country_full';
+    public const DISPLAY_COUNTRY_SHORT = 'display_country_short';
+
     /**
      * {@inheritdoc}
      */
@@ -60,13 +63,15 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             }
 
             $countryChoices = [];
+            $intlCountries = Countries::getNames();
 
-            foreach (Countries::getNames() as $region => $name) {
-                if (false === isset($countries[$region])) {
+            foreach ($countries as $regionCode => $countryCode) {
+                if (!isset($intlCountries[$regionCode])) {
                     continue;
                 }
 
-                $countryChoices[sprintf('%s (+%s)', $name, $countries[$region])] = $region;
+                $label = $this->formatDisplayChoice($options['country_display_type'], $intlCountries[$regionCode], $regionCode, $countryCode);
+                $countryChoices[$label] = $regionCode;
             }
 
             $transformerChoices = array_values($countryChoices);
@@ -128,6 +133,7 @@ public function configureOptions(OptionsResolver $resolver): void
             'by_reference' => false,
             'error_bubbling' => false,
             'country_choices' => [],
+            'country_display_type' => self::DISPLAY_COUNTRY_FULL,
             'country_placeholder' => false,
             'preferred_country_choices' => [],
             'country_options' => [],
@@ -139,6 +145,11 @@ public function configureOptions(OptionsResolver $resolver): void
             self::WIDGET_COUNTRY_CHOICE,
         ]);
 
+        $resolver->setAllowedValues('country_display_type', [
+            self::DISPLAY_COUNTRY_FULL,
+            self::DISPLAY_COUNTRY_SHORT,
+        ]);
+
         $resolver->setAllowedTypes('country_options', 'array');
         $resolver->setAllowedTypes('number_options', 'array');
     }
@@ -158,4 +169,13 @@ public function getBlockPrefix(): string
     {
         return 'phone_number';
     }
+
+    private function formatDisplayChoice(string $displayType, string $regionName, string $regionCode, string $countryCode): string
+    {
+        if (self::DISPLAY_COUNTRY_SHORT === $displayType) {
+            return sprintf('%s +%s', $regionCode, $countryCode);
+        }
+
+        return sprintf('%s (+%s)', $regionName, $countryCode);
+    }
 }
diff --git a/tests/Form/Type/PhoneNumberTypeTest.php b/tests/Form/Type/PhoneNumberTypeTest.php
@@ -146,7 +146,9 @@ public function countryChoiceChoicesProvider()
         return [
             [
                 [],
-                \count(PhoneNumberUtil::getInstance()->getSupportedRegions()),
+                // 3 regions have an already used label "TA", "AC" and XK
+                // @see https://fr.wikipedia.org/wiki/ISO_3166-2#cite_note-UPU-1
+                242,
                 [
                     $this->createChoiceView('United Kingdom (+44)', 'GB'),
                 ],
@@ -170,6 +172,45 @@ public function countryChoiceChoicesProvider()
         ];
     }
 
+    /**
+     * @dataProvider countryChoiceFormatProvider
+     */
+    public function testCountryChoiceFormat(string $displayType, array $expectedChoices)
+    {
+        $options['widget'] = PhoneNumberType::WIDGET_COUNTRY_CHOICE;
+        $options['country_display_type'] = $displayType;
+        $form = $this->factory->create(PhoneNumberType::class, null, $options);
+
+        $view = $form->createView();
+        $choices = $view['country']->vars['choices'];
+
+        foreach ($expectedChoices as $expectedChoice) {
+            $this->assertContainsEquals($expectedChoice, $choices);
+        }
+    }
+
+    /**
+     * 0 => Display type
+     * 2 => Expected choices.
+     */
+    public function countryChoiceFormatProvider()
+    {
+        return [
+            [
+                PhoneNumberType::DISPLAY_COUNTRY_FULL,
+                [
+                    $this->createChoiceView('United Kingdom (+44)', 'GB'),
+                ],
+            ],
+            [
+                PhoneNumberType::DISPLAY_COUNTRY_SHORT,
+                [
+                    $this->createChoiceView('GB +44', 'GB'),
+                ],
+            ],
+        ];
+    }
+
     /**
      * @dataProvider countryChoicePlaceholderProvider
      */