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

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

Iban

Iban

New in version 2.3: The Iban constraint was introduced in Symfony 2.3.

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.

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Iban
Validator Symfony\Component\Validator\Constraints\IbanValidator

Basic Usage

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

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    // src/AppBundle/Entity/Transaction.php
    namespace AppBundle\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;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    # src/AppBundle/Resources/config/validation.yml
    AppBundle\Entity\Transaction:
        properties:
            bankAccountNumber:
                - Iban:
                    message: This is not a valid International Bank Account Number (IBAN).
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    <!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    
        <class name="AppBundle\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>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    // src/AppBundle/Entity/Transaction.php
    namespace AppBundle\Entity;
    
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Transaction
    {
        protected $bankAccountNumber;
    
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('bankAccountNumber', new Assert\Iban(array(
                'message' => 'This is not a valid International Bank Account Number (IBAN).',
            )));
        }
    }
    

Available Options

message

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

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

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