Iban

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 Iban
Validator 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.

  • YAML
    # src/Acme/SubscriptionBundle/Resources/config/validation.yml
    Acme\SubscriptionBundle\Entity\Transaction:
        properties:
            bankAccountNumber:
                - Iban:
                    message: This is not a valid International Bank Account Number (IBAN).
    
  • Annotations
    // src/Acme/SubscriptionBundle/Entity/Transaction.php
    namespace Acme\SubscriptionBundle\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;
    }
    
  • XML
    <!-- src/Acme/SubscriptionBundle/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="Acme\SubscriptionBundle\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
    // src/Acme/SubscriptionBundle/Entity/Transaction.php
    namespace Acme\SubscriptionBundle\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.