IBAN

This constraint is used to ensure that a bank account number has the proper format of an International Bank Account Number (IBAN). IBAN is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of propagating transcription errors.

この制約は、銀行口座番号が国際銀行口座番号 (IBAN) の適切な形式であることを確認するために使用されます。 IBAN は、国境を越えて銀行口座を識別する国際的に合意された手段であり、転記エラーが伝播するリスクを軽減します。
Applies to property or method
Class Iban
Validator IbanValidator

Basic Usage

To use the IBAN validator, apply it to a property on an object that will contain an International Bank Account Number.

IBAN バリデーターを使用するには、国際銀行口座番号を含むオブジェクトのプロパティに適用します。
  • Attributes
    属性
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
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 $bankAccountNumber;
}

Note

ノート

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

他のほとんどの制約と同様に、null および空の文字列は有効な値と見なされます。これは、それらをオプションの値にできるようにするためです。値が必須の場合、一般的な解決策は、この制約と NotBlank を組み合わせることです。

Options

groups

type: array | string

タイプ: 配列 |ストリング

It defines the validation group or groups of this constraint. Read more about validation groups.

この制約の検証グループを定義します。検証グループの詳細を参照してください。

message

type: string default: This is not a valid International Bank Account Number (IBAN).

タイプ: 文字列 デフォルト: これは有効な国際銀行口座番号 (IBAN) ではありません。

The default message supplied when the value does not pass the IBAN check.

値が IBAN チェックに合格しなかった場合に提供されるデフォルトのメッセージ。

You can use the following parameters in this message:

このメッセージでは、次のパラメーターを使用できます。
Parameter Description
{{ value }} The current (invalid) value
{{ label }} Corresponding form field label

payload

type: mixed default: null

タイプ: 混合 デフォルト: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

このオプションは、任意のドメイン固有のデータを制約に添付するために使用できます。構成されたペイロードは Validator コンポーネントによって使用されませんが、その処理は完全にユーザー次第です。

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

たとえば、いくつかのエラー レベルを使用して、エラーの重大度に応じて、失敗した制約をフロントエンドで異なる方法で提示することができます。