Bic

Warning: You are browsing the documentation for Symfony 6.2, which is no longer maintained.

Read the updated version of this page for Symfony 7.1 (the current stable version).

Bic

This constraint is used to ensure that a value has the proper format of a Business Identifier Code (BIC). BIC is an internationally agreed means to uniquely identify both financial and non-financial institutions. You may also check that the BIC's country code is the same as a given IBAN's one.

Applies to	property or method
Class	Bic
Validator	BicValidator

Basic Usage

To use the Bic validator, apply it to a property on an object that will contain a Business Identifier Code (BIC).

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

use Symfony\Component\Validator\Constraints as Assert;

class Transaction
{
    #[Assert\Bic]
    protected string $businessIdentifierCode;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Transaction:
    properties:
        businessIdentifierCode:
            - Bic: ~
    

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

    <class name="App\Entity\Transaction">
        <property name="businessIdentifierCode">
            <constraint name="Bic"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // 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('businessIdentifierCode', new Assert\Bic());
    }
}
    

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.

Available Options

`groups`

type: array | string default: null

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

`iban`

type: string default: null

An IBAN value to validate that its country code is the same as the BIC's one.

`ibanMessage`

type: string default: This Business Identifier Code (BIC) is not associated with IBAN {{ iban }}.

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

`ibanPropertyPath`

type: string default: null

It defines the object property whose value stores the IBAN used to check the BIC with.

For example, if you want to compare the $bic property of some object with regard to the $iban property of the same object, use ibanPropertyPath="iban" in the comparison constraint of $bic.

`message`

type: string default: This is not a valid Business Identifier Code (BIC).

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

You can use the following parameters in this message:

Parameter	Description
`{{ value }}`	The current (invalid) BIC value

`payload`

type: mixed default: 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.

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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version