Added documentation for the EqualConstraint

wouterj · wouterj · commit 635c8c8dee26 · 2013-05-03T16:50:48.000+02:00
diff --git a/reference/constraints.rst b/reference/constraints.rst
@@ -21,6 +21,8 @@ Validation Constraints Reference
 
    constraints/Range
 
+   constraints/EqualTo
+
    constraints/Date
    constraints/DateTime
    constraints/Time
diff --git a/reference/constraints/EqualTo.rst b/reference/constraints/EqualTo.rst
@@ -0,0 +1,106 @@
+EqualTo
+=======
+
+.. versionadded:: 2.3
+    This constraint is new in version 2.3.
+
+Validates that a value is equal to another value, defined in the options. To
+force that a value is *not* equal, see :doc:`/reference/constraints/NotEqual`.
+
+.. caution::
+    
+    This constraint compares using ``==``, so ``3`` and ``"3"`` are considered
+    equal. Use :doc:`/reference/constraints/IdenticalTo` to compare with
+    ``===``.
+
++----------------+-----------------------------------------------------------------------+
+| Applies to     | :ref:`property or method<validation-property-target>`                 |
++----------------+-----------------------------------------------------------------------+
+| Options        | - `value`_                                                            |
+|                | - `message`_                                                          |
++----------------+-----------------------------------------------------------------------+
+| Class          | :class:`Symfony\\Component\\Validator\\Constraints\\EqualTo`          |
++----------------+-----------------------------------------------------------------------+
+| Validator      | :class:`Symfony\\Component\\Validator\\Constraints\\EqualToValidator` |
++----------------+-----------------------------------------------------------------------+
+
+Basic Usage
+-----------
+
+If you want to ensure that the ``age`` of a ``Person`` class is equal to
+``20``, you could do the following:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # src/SocialBundle/Resources/config/validation.yml
+        Acme\SocialBundle\Entity\Person:
+            properties:
+                age:
+                    - EqualTo:
+                        value: 20
+
+    .. code-block:: php-annotations
+
+        // src/Acme/SocialBundle/Entity/Person.php
+        namespace Acme\SocialBundle\Entity;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Person
+        {
+            /**
+             * @Assert\EqualTo(
+             *     value = 20
+             * )
+             */
+            protected $age;
+        }
+
+    .. code-block:: xml
+
+        <!-- src/Acme/SocialBundle/Resources/config/validation.xml -->
+        <class name="Acme\SocialBundle\Entity\Person">
+            <property name="age">
+                <constraint name="EqualTo">
+                    <option name="value">20</option>
+                </constraint>
+            </property>
+        </class>
+
+    .. code-block:: php
+
+        // src/Acme/SocialBundle/Entity/Person.php
+        namespace Acme\SocialBundle\Entity;
+
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Person
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('age', new Assert\EqualTo(array(
+                    'value' => 20,
+                )));
+            }
+        }
+
+Options
+-------
+
+value
+~~~~~
+
+**type**: ``mixed``
+
+This option is required. It defines the value to compare to. It can be a
+string, number or object.
+
+message
+~~~~~~~
+
+**type**: ``string`` **default**: ``This value should be equal to {{ compared_value }}``
+
+This is the message that will be shown if the value is not equal.
diff --git a/reference/constraints/map.rst.inc b/reference/constraints/map.rst.inc
@@ -26,6 +26,11 @@ Number Constraints
 
 * :doc:`Range </reference/constraints/Range>`
 
+Comparison Constraints
+~~~~~~~~~~~~~~~~~~~~~~
+
+* :doc:`EqualTo </reference/constraints/EqualTo>`
+
 Date Constraints
 ~~~~~~~~~~~~~~~~
 
