Added docs for NotEqualTo validator

Author: wouterj

reference/constraints.rst

@@ -22,6 +22,7 @@ Validation Constraints Reference
    constraints/Range
 
    constraints/EqualTo
+   constraints/NotEqualTo
 
    constraints/Date
    constraints/DateTime

reference/constraints/EqualTo.rst

@@ -5,7 +5,7 @@ EqualTo
     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`.
+force that a value is *not* equal, see :doc:`/reference/constraints/NotEqualTo`.
 
 .. caution::
 
@@ -90,13 +90,7 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
 Options
 -------
 
-value
-~~~~~
-
-**type**: ``mixed``
-
-This option is required. It defines the value to compare to. It can be a
-string, number or object.
+.. include:: /reference/constraints/_comparison-value-option.rst.inc
 
 message
 ~~~~~~~

reference/constraints/NotEqualTo.rst

@@ -0,0 +1,101 @@
+NotEqualTo
+==========
+
+.. versionadded:: 2.3
+    This constraint is new in version 2.3.
+
+Validates that a value is **not** equal to another value, defined in the
+options. To force that a value is equal, see
+:doc:`/reference/constraints/EqualTo`.
+
+.. caution::
+    
+    This constraint compares using ``!=``, so ``3`` and ``"3"`` are considered
+    equal. Use :doc:`/reference/constraints/NotIdenticalTo` to compare with
+    ``!==``.
+
++----------------+-------------------------------------------------------------------------+
+| Applies to     | :ref:`property or method<validation-property-target>`                   |
++----------------+-------------------------------------------------------------------------+
+| Options        | - `value`_                                                              |
+|                | - `message`_                                                            |
++----------------+-------------------------------------------------------------------------+
+| Class          | :class:`Symfony\\Component\\Validator\\Constraints\\NotEqualTo`         |
++----------------+-------------------------------------------------------------------------+
+| Validator      | :class:`Symfony\\Component\\Validator\\Constraints\\NotEqualToValidator`|
++----------------+-------------------------------------------------------------------------+
+
+Basic Usage
+-----------
+
+If you want to ensure that the ``age`` of a ``Person`` class is not equal to
+``15``, you could do the following:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # src/SocialBundle/Resources/config/validation.yml
+        Acme\SocialBundle\Entity\Person:
+            properties:
+                age:
+                    - NotEqualTo:
+                        value: 15
+
+    .. code-block:: php-annotations
+
+        // src/Acme/SocialBundle/Entity/Person.php
+        namespace Acme\SocialBundle\Entity;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Person
+        {
+            /**
+             * @Assert\NotEqualTo(
+             *     value = 15
+             * )
+             */
+            protected $age;
+        }
+
+    .. code-block:: xml
+
+        <!-- src/Acme/SocialBundle/Resources/config/validation.xml -->
+        <class name="Acme\SocialBundle\Entity\Person">
+            <property name="age">
+                <constraint name="NotEqualTo">
+                    <option name="value">15</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\NotEqualTo(array(
+                    'value' => 15,
+                )));
+            }
+        }
+
+Options
+-------
+
+.. include:: /reference/constraints/_comparison-value-option.rst.inc
+
+message
+~~~~~~~
+
+**type**: ``string`` **default**: ``This value should not be equal to {{ compared_value }}``
+
+This is the message that will be shown if the value is not equal.

reference/constraints/_comparison-value-option.rst.inc

@@ -0,0 +1,7 @@
+value
+~~~~~
+
+**type**: ``mixed``
+
+This option is required. It defines the value to compare to. It can be a
+string, number or object.

reference/constraints/map.rst.inc

@@ -30,6 +30,7 @@ Comparison Constraints
 ~~~~~~~~~~~~~~~~~~~~~~
 
 * :doc:`EqualTo </reference/constraints/EqualTo>`
+* :doc:`NotEqualTo </reference/constraints/NotEqualTo>`
 
 Date Constraints
 ~~~~~~~~~~~~~~~~