bug #49697 [Validator] Update BIC validator IBAN mappings (maxbeckers)

nicolas-grekas · nicolas-grekas · commit f4177aa97995 · 2023-03-17T13:40:36.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Validator] Update BIC validator IBAN mappings | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a With #29755 were added some special cases for BIC validation. The old references have updated and don't include this mapping anymore. But https://www.iban.com/structure describes this special cases. I updated the list with this PR based on the new reference. Commits ------- 436dcba [Validator] Update BIC validator IBAN mappings
diff --git a/src/Symfony/Component/Validator/Constraints/BicValidator.php b/src/Symfony/Component/Validator/Constraints/BicValidator.php
@@ -29,8 +29,9 @@
  */
 class BicValidator extends ConstraintValidator
 {
+    // Reference: https://www.iban.com/structure
     private const BIC_COUNTRY_TO_IBAN_COUNTRY_MAP = [
-        // Reference: https://www.ecbs.org/iban/france-bank-account-number.html
+        // FR includes:
         'GF' => 'FR', // French Guiana
         'PF' => 'FR', // French Polynesia
         'TF' => 'FR', // French Southern Territories
@@ -39,13 +40,20 @@ class BicValidator extends ConstraintValidator
         'YT' => 'FR', // Mayotte
         'NC' => 'FR', // New Caledonia
         'RE' => 'FR', // Reunion
+        'BL' => 'FR', // Saint Barthelemy
+        'MF' => 'FR', // Saint Martin (French part)
         'PM' => 'FR', // Saint Pierre and Miquelon
         'WF' => 'FR', // Wallis and Futuna Islands
-        // Reference: https://www.ecbs.org/iban/united-kingdom-uk-bank-account-number.html
+        // GB includes:
         'JE' => 'GB', // Jersey
         'IM' => 'GB', // Isle of Man
         'GG' => 'GB', // Guernsey
         'VG' => 'GB', // British Virgin Islands
+        // FI includes:
+        'AX' => 'FI', // Aland Islands
+        // ES includes:
+        'IC' => 'ES', // Canary Islands
+        'EA' => 'ES', // Ceuta and Melilla
     ];
 
     private $propertyAccessor;
@@ -104,7 +112,8 @@ public function validate($value, Constraint $constraint)
             return;
         }
 
-        if (!Countries::exists(substr($canonicalize, 4, 2))) {
+        $bicCountryCode = substr($canonicalize, 4, 2);
+        if (!isset(self::BIC_COUNTRY_TO_IBAN_COUNTRY_MAP[$bicCountryCode]) && !Countries::exists($bicCountryCode)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(Bic::INVALID_COUNTRY_CODE_ERROR)
@@ -137,7 +146,7 @@ public function validate($value, Constraint $constraint)
             return;
         }
         $ibanCountryCode = substr($iban, 0, 2);
-        if (ctype_alpha($ibanCountryCode) && !$this->bicAndIbanCountriesMatch(substr($canonicalize, 4, 2), $ibanCountryCode)) {
+        if (ctype_alpha($ibanCountryCode) && !$this->bicAndIbanCountriesMatch($bicCountryCode, $ibanCountryCode)) {
             $this->context->buildViolation($constraint->ibanMessage)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setParameter('{{ iban }}', $iban)
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php
@@ -299,6 +299,8 @@ public static function getValidBicSpecialCases()
         yield ['BNPAYTGX', 'FR14 2004 1010 0505 0001 3M02 606'];
         yield ['BNPANCGX', 'FR14 2004 1010 0505 0001 3M02 606'];
         yield ['BNPAREGX', 'FR14 2004 1010 0505 0001 3M02 606'];
+        yield ['BNPABLGX', 'FR14 2004 1010 0505 0001 3M02 606'];
+        yield ['BNPAMFGX', 'FR14 2004 1010 0505 0001 3M02 606'];
         yield ['BNPAPMGX', 'FR14 2004 1010 0505 0001 3M02 606'];
         yield ['BNPAWFGX', 'FR14 2004 1010 0505 0001 3M02 606'];
 
@@ -307,6 +309,13 @@ public static function getValidBicSpecialCases()
         yield ['BARCIMSA', 'GB12 CPBK 0892 9965 0449 911'];
         yield ['BARCGGSA', 'GB12 CPBK 0892 9965 0449 911'];
         yield ['BARCVGSA', 'GB12 CPBK 0892 9965 0449 911'];
+
+        // FI related special cases
+        yield ['NDEAAXHH', 'FI14 1009 3000 1234 58'];
+
+        // ES related special cases
+        yield ['CAIXICBBXXX', 'ES79 2100 0813 6101 2345 6789'];
+        yield ['CAIXEABBXXX', 'ES79 2100 0813 6101 2345 6789'];
     }
 }
 
