vendor/symfony/validator/Constraints/BicValidator.php line 61

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  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 Symfony\Component\Validator\Constraints;
  14. use Symfony\Component\Intl\Countries;
  15. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  16. use Symfony\Component\PropertyAccess\PropertyAccess;
  17. use Symfony\Component\PropertyAccess\PropertyAccessor;
  18. use Symfony\Component\Validator\Constraint;
  19. use Symfony\Component\Validator\ConstraintValidator;
  20. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  21. use Symfony\Component\Validator\Exception\LogicException;
  22. use Symfony\Component\Validator\Exception\UnexpectedTypeException;
  23. use Symfony\Component\Validator\Exception\UnexpectedValueException;
  25. /**
  26.  * @author Michael Hirschler <michael.vhirsch@gmail.com>
  27.  *
  28.  * @see https://en.wikipedia.org/wiki/ISO_9362#Structure
  29.  */
  30. class BicValidator extends ConstraintValidator
  31. {
  32.     // Reference: https://www.iban.com/structure
  33.     private const BIC_COUNTRY_TO_IBAN_COUNTRY_MAP = [
  34.         // FR includes:
  35.         'GF' => 'FR', // French Guiana
  36.         'PF' => 'FR', // French Polynesia
  37.         'TF' => 'FR', // French Southern Territories
  38.         'GP' => 'FR', // Guadeloupe
  39.         'MQ' => 'FR', // Martinique
  40.         'YT' => 'FR', // Mayotte
  41.         'NC' => 'FR', // New Caledonia
  42.         'RE' => 'FR', // Reunion
  43.         'BL' => 'FR', // Saint Barthelemy
  44.         'MF' => 'FR', // Saint Martin (French part)
  45.         'PM' => 'FR', // Saint Pierre and Miquelon
  46.         'WF' => 'FR', // Wallis and Futuna Islands
  47.         // GB includes:
  48.         'JE' => 'GB', // Jersey
  49.         'IM' => 'GB', // Isle of Man
  50.         'GG' => 'GB', // Guernsey
  51.         'VG' => 'GB', // British Virgin Islands
  52.         // FI includes:
  53.         'AX' => 'FI', // Aland Islands
  54.         // ES includes:
  55.         'IC' => 'ES', // Canary Islands
  56.         'EA' => 'ES', // Ceuta and Melilla
  57.     ];
  59.     private ?PropertyAccessor $propertyAccessor;
  61.     public function __construct(PropertyAccessor $propertyAccessor = null)
  62.     {
  63.         $this->propertyAccessor = $propertyAccessor;
  64.     }
  66.     public function validate(mixed $value, Constraint $constraint)
  67.     {
  68.         if (!$constraint instanceof Bic) {
  69.             throw new UnexpectedTypeException($constraint, Bic::class);
  70.         }
  72.         if (null === $value || '' === $value) {
  73.             return;
  74.         }
  76.         if (!\is_scalar($value) && !$value instanceof \Stringable) {
  77.             throw new UnexpectedValueException($value, 'string');
  78.         }
  80.         $canonicalize = str_replace(' ', '', $value);
  82.         // the bic must be either 8 or 11 characters long
  83.         if (!\in_array(\strlen($canonicalize), [8, 11])) {
  84.             $this->context->buildViolation($constraint->message)
  85.                 ->setParameter('{{ value }}', $this->formatValue($value))
  86.                 ->setCode(Bic::INVALID_LENGTH_ERROR)
  87.                 ->addViolation();
  89.             return;
  90.         }
  92.         // must contain alphanumeric values only
  93.         if (!ctype_alnum($canonicalize)) {
  94.             $this->context->buildViolation($constraint->message)
  95.                 ->setParameter('{{ value }}', $this->formatValue($value))
  96.                 ->setCode(Bic::INVALID_CHARACTERS_ERROR)
  97.                 ->addViolation();
  99.             return;
  100.         }
  102.         // first 4 letters must be alphabetic (bank code)
  103.         if (!ctype_alpha(substr($canonicalize, 0, 4))) {
  104.             $this->context->buildViolation($constraint->message)
  105.                 ->setParameter('{{ value }}', $this->formatValue($value))
  106.                 ->setCode(Bic::INVALID_BANK_CODE_ERROR)
  107.                 ->addViolation();
  109.             return;
  110.         }
  112.         $bicCountryCode = substr($canonicalize, 4, 2);
  113.         if (!isset(self::BIC_COUNTRY_TO_IBAN_COUNTRY_MAP[$bicCountryCode]) && !Countries::exists($bicCountryCode)) {
  114.             $this->context->buildViolation($constraint->message)
  115.                 ->setParameter('{{ value }}', $this->formatValue($value))
  116.                 ->setCode(Bic::INVALID_COUNTRY_CODE_ERROR)
  117.                 ->addViolation();
  119.             return;
  120.         }
  122.         // should contain uppercase characters only
  123.         if (strtoupper($canonicalize) !== $canonicalize) {
  124.             $this->context->buildViolation($constraint->message)
  125.                 ->setParameter('{{ value }}', $this->formatValue($value))
  126.                 ->setCode(Bic::INVALID_CASE_ERROR)
  127.                 ->addViolation();
  129.             return;
  130.         }
  132.         // check against an IBAN
  133.         $iban = $constraint->iban;
  134.         $path = $constraint->ibanPropertyPath;
  135.         if ($path && null !== $object = $this->context->getObject()) {
  136.             try {
  137.                 $iban = $this->getPropertyAccessor()->getValue($object, $path);
  138.             } catch (NoSuchPropertyException $e) {
  139.                 throw new ConstraintDefinitionException(sprintf('Invalid property path "%s" provided to "%s" constraint: ', $path, get_debug_type($constraint)).$e->getMessage(), 0, $e);
  140.             }
  141.         }
  142.         if (!$iban) {
  143.             return;
  144.         }
  145.         $ibanCountryCode = substr($iban, 0, 2);
  146.         if (ctype_alpha($ibanCountryCode) && !$this->bicAndIbanCountriesMatch($bicCountryCode, $ibanCountryCode)) {
  147.             $this->context->buildViolation($constraint->ibanMessage)
  148.                 ->setParameter('{{ value }}', $this->formatValue($value))
  149.                 ->setParameter('{{ iban }}', $iban)
  150.                 ->setCode(Bic::INVALID_IBAN_COUNTRY_CODE_ERROR)
  151.                 ->addViolation();
  152.         }
  153.     }
  155.     private function getPropertyAccessor(): PropertyAccessor
  156.     {
  157.         if (null === $this->propertyAccessor) {
  158.             if (!class_exists(PropertyAccess::class)) {
  159.                 throw new LogicException('Unable to use property path as the Symfony PropertyAccess component is not installed.');
  160.             }
  161.             $this->propertyAccessor = PropertyAccess::createPropertyAccessor();
  162.         }
  164.         return $this->propertyAccessor;
  165.     }
  167.     private function bicAndIbanCountriesMatch(string $bicCountryCode, string $ibanCountryCode): bool
  168.     {
  169.         return $ibanCountryCode === $bicCountryCode || $ibanCountryCode === (self::BIC_COUNTRY_TO_IBAN_COUNTRY_MAP[$bicCountryCode] ?? null);
  170.     }
  171. }