IBAN

编辑此页

此约束用于确保银行账号具有国际银行账号 (IBAN) 的正确格式。IBAN 是一种国际上认可的识别跨国银行账户的方法，可以降低传播转录错误的风险。

适用于	属性或方法
类	Iban
验证器	IbanValidator

基本用法

要使用 IBAN 验证器，请将其应用于对象上将包含国际银行账号的属性。

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Entity/Transaction.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Transaction
{
    #[Assert\Iban(
        message: 'This is not a valid International Bank Account Number (IBAN).',
    )]
    protected string $bankAccountNumber;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Transaction:
    properties:
        bankAccountNumber:
            - Iban:
                message: This is not a valid International Bank Account Number (IBAN).
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.ac.cn/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.ac.cn/schema/dic/constraint-mapping http://symfony.ac.cn/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Transaction">
        <property name="bankAccountNumber">
            <constraint name="Iban">
                <option name="message">
                    This is not a valid International Bank Account Number (IBAN).
                </option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        // src/Entity/Transaction.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Transaction
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('bankAccountNumber', new Assert\Iban([
            'message' => 'This is not a valid International Bank Account Number (IBAN).',
        ]));
    }
}
    

注意

与大多数其他约束一样，null 和空字符串被认为是有效值。这是为了允许它们成为可选值。如果该值是强制性的，一个常见的解决方案是将此约束与 NotBlank 结合使用。

选项

`groups`

类型: array | string 默认值: null

它定义了此约束的验证组。阅读更多关于验证组的信息。

`message`

类型: string 默认值: 这不是一个有效的国际银行账号 (IBAN)。

当值未通过 IBAN 检查时提供的默认消息。

您可以在此消息中使用以下参数

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`payload`

类型: mixed 默认值: null

此选项可用于将任意特定于域的数据附加到约束。 Validator 组件不使用配置的 payload，但其处理完全取决于您。

例如，您可能想要使用多个错误级别，以便根据错误严重程度在前端以不同方式呈现失败的约束。

本作品，包括代码示例，根据 Creative Commons BY-SA 3.0 许可协议获得许可。

版本