116 lines
5.1 KiB
PHP
116 lines
5.1 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Validator\Constraints;
|
|
|
|
use Symfony\Component\Intl\Countries;
|
|
use Symfony\Component\PropertyAccess\PropertyAccess;
|
|
use Symfony\Component\Validator\Attribute\HasNamedArguments;
|
|
use Symfony\Component\Validator\Constraint;
|
|
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
|
|
use Symfony\Component\Validator\Exception\InvalidArgumentException;
|
|
use Symfony\Component\Validator\Exception\LogicException;
|
|
|
|
/**
|
|
* Ensures that the value is valid against the BIC format.
|
|
*
|
|
* @see https://en.wikipedia.org/wiki/ISO_9362
|
|
*
|
|
* @author Michael Hirschler <michael.vhirsch@gmail.com>
|
|
*/
|
|
#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
|
|
class Bic extends Constraint
|
|
{
|
|
public const VALIDATION_MODE_STRICT = 'strict';
|
|
public const VALIDATION_MODE_CASE_INSENSITIVE = 'case-insensitive';
|
|
|
|
public const VALIDATION_MODES = [
|
|
self::VALIDATION_MODE_STRICT,
|
|
self::VALIDATION_MODE_CASE_INSENSITIVE,
|
|
];
|
|
|
|
public const INVALID_LENGTH_ERROR = '66dad313-af0b-4214-8566-6c799be9789c';
|
|
public const INVALID_CHARACTERS_ERROR = 'f424c529-7add-4417-8f2d-4b656e4833e2';
|
|
/**
|
|
* @deprecated since Symfony 7.1, to be removed in 8.0
|
|
*/
|
|
public const INVALID_BANK_CODE_ERROR = '00559357-6170-4f29-aebd-d19330aa19cf';
|
|
public const INVALID_COUNTRY_CODE_ERROR = '1ce76f8d-3c1f-451c-9e62-fe9c3ed486ae';
|
|
public const INVALID_CASE_ERROR = '11884038-3312-4ae5-9d04-699f782130c7';
|
|
public const INVALID_IBAN_COUNTRY_CODE_ERROR = '29a2c3bb-587b-4996-b6f5-53081364cea5';
|
|
|
|
protected const ERROR_NAMES = [
|
|
self::INVALID_LENGTH_ERROR => 'INVALID_LENGTH_ERROR',
|
|
self::INVALID_CHARACTERS_ERROR => 'INVALID_CHARACTERS_ERROR',
|
|
self::INVALID_BANK_CODE_ERROR => 'INVALID_BANK_CODE_ERROR',
|
|
self::INVALID_COUNTRY_CODE_ERROR => 'INVALID_COUNTRY_CODE_ERROR',
|
|
self::INVALID_CASE_ERROR => 'INVALID_CASE_ERROR',
|
|
];
|
|
|
|
public string $message = 'This is not a valid Business Identifier Code (BIC).';
|
|
public string $ibanMessage = 'This Business Identifier Code (BIC) is not associated with IBAN {{ iban }}.';
|
|
public ?string $iban = null;
|
|
public ?string $ibanPropertyPath = null;
|
|
/**
|
|
* @var self::VALIDATION_MODE_*
|
|
*/
|
|
public string $mode = self::VALIDATION_MODE_STRICT;
|
|
|
|
/**
|
|
* @param array<string,mixed>|null $options
|
|
* @param string|null $iban An IBAN value to validate that its country code is the same as the BIC's one
|
|
* @param string|null $ibanPropertyPath Property path to the IBAN value when validating objects
|
|
* @param string[]|null $groups
|
|
* @param self::VALIDATION_MODE_*|null $mode The mode used to validate the BIC; pass null to use the default mode (strict)
|
|
*/
|
|
#[HasNamedArguments]
|
|
public function __construct(
|
|
?array $options = null,
|
|
?string $message = null,
|
|
?string $iban = null,
|
|
?string $ibanPropertyPath = null,
|
|
?string $ibanMessage = null,
|
|
?array $groups = null,
|
|
mixed $payload = null,
|
|
?string $mode = null,
|
|
) {
|
|
if (!class_exists(Countries::class)) {
|
|
throw new LogicException('The Intl component is required to use the Bic constraint. Try running "composer require symfony/intl".');
|
|
}
|
|
if (\is_array($options) && \array_key_exists('mode', $options) && !\in_array($options['mode'], self::VALIDATION_MODES, true)) {
|
|
throw new InvalidArgumentException('The "mode" parameter value is not valid.');
|
|
}
|
|
if (null !== $mode && !\in_array($mode, self::VALIDATION_MODES, true)) {
|
|
throw new InvalidArgumentException('The "mode" parameter value is not valid.');
|
|
}
|
|
|
|
if (\is_array($options)) {
|
|
trigger_deprecation('symfony/validator', '7.3', 'Passing an array of options to configure the "%s" constraint is deprecated, use named arguments instead.', static::class);
|
|
}
|
|
|
|
parent::__construct($options, $groups, $payload);
|
|
|
|
$this->message = $message ?? $this->message;
|
|
$this->ibanMessage = $ibanMessage ?? $this->ibanMessage;
|
|
$this->iban = $iban ?? $this->iban;
|
|
$this->ibanPropertyPath = $ibanPropertyPath ?? $this->ibanPropertyPath;
|
|
$this->mode = $mode ?? $this->mode;
|
|
|
|
if (null !== $this->iban && null !== $this->ibanPropertyPath) {
|
|
throw new ConstraintDefinitionException('The "iban" and "ibanPropertyPath" options of the Iban constraint cannot be used at the same time.');
|
|
}
|
|
|
|
if (null !== $this->ibanPropertyPath && !class_exists(PropertyAccess::class)) {
|
|
throw new LogicException(\sprintf('The "symfony/property-access" component is required to use the "%s" constraint with the "ibanPropertyPath" option. Try running "composer require symfony/property-access".', self::class));
|
|
}
|
|
}
|
|
}
|