[Validator] added BIC validator

mvhirsch · xabbuh · commit 7911fe15d2a8 · 2015-10-12T20:57:34.000+02:00
diff --git a/reference/constraints.rst b/reference/constraints.rst
@@ -50,6 +50,7 @@ Validation Constraints Reference
    constraints/Currency
    constraints/Luhn
    constraints/Iban
+   constraints/Bic
    constraints/Isbn
    constraints/Issn
 
diff --git a/reference/constraints/Bic.rst b/reference/constraints/Bic.rst
@@ -0,0 +1,105 @@
+Bic
+===
+
+.. versionadded:: 2.8
+    The Bic constraint was introduced in Symfony 2.8.
+
+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.
+
++----------------+-----------------------------------------------------------------------+
+| Applies to     | :ref:`property or method <validation-property-target>`                |
++----------------+-----------------------------------------------------------------------+
+| Options        | - `message`_                                                          |
+|                | - `payload`_                                                          |
++----------------+-----------------------------------------------------------------------+
+| Class          | :class:`Symfony\\Component\\Validator\\Constraints\\Bic`              |
++----------------+-----------------------------------------------------------------------+
+| Validator      | :class:`Symfony\\Component\\Validator\\Constraints\\BicValidator`     |
++----------------+-----------------------------------------------------------------------+
+
+Basic Usage
+-----------
+
+To use the Bic validator, simply apply it to a property on an object that
+will contain a Business Identifier Code (BIC).
+
+.. configuration-block::
+
+    .. code-block:: php-annotations
+
+        // src/AppBundle/Entity/Transaction.php
+        namespace AppBundle\Entity;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Transaction
+        {
+            /**
+             * @Assert\Bic()
+             */
+            protected $businessIdentifierCode;
+        }
+
+    .. code-block:: yaml
+
+        # src/AppBundle/Resources/config/validation.yml
+        AppBundle\Entity\Transaction:
+            properties:
+                businessIdentifierCode:
+                    - Bic:
+                        message: This is not a valid Business Identifier Code (BIC).
+
+    .. code-block:: xml
+
+        <!-- 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="businessIdentifierCode">
+                    <constraint name="Bic">
+                        <option name="message">
+                            This is not a valid Business Identifier Code (BIC).
+                        </option>
+                    </constraint>
+                </property>
+            </class>
+        </constraint-mapping>
+
+    .. code-block:: php
+
+        // src/AppBundle/Entity/Transaction.php
+        namespace AppBundle\Entity;
+
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Transaction
+        {
+            protected $businessIdentifierCode;
+
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('businessIdentifierCode', new Assert\Bic(array(
+                    'message' => 'This is not a valid Business Identifier Code (BIC).',
+                )));
+            }
+        }
+
+Available Options
+-----------------
+
+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.
+
+.. include:: /reference/constraints/_payload-option.rst.inc
+
+.. _`Business Identifier Code (BIC)`: https://en.wikipedia.org/wiki/Business_Identifier_Code
diff --git a/reference/constraints/map.rst.inc b/reference/constraints/map.rst.inc
@@ -66,6 +66,7 @@ File Constraints
 Financial and other Number Constraints
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+* :doc:`Bic </reference/constraints/Bic>`
 * :doc:`CardScheme </reference/constraints/CardScheme>`
 * :doc:`Currency </reference/constraints/Currency>`
 * :doc:`Luhn </reference/constraints/Luhn>`
