Added docs for GreaterThan validator

wouterj · wouterj · commit 956f5fc1b506 · 2013-05-04T12:09:38.000+02:00
diff --git a/reference/constraints.rst b/reference/constraints.rst
@@ -27,6 +27,7 @@ Validation Constraints Reference
    constraints/NotIdenticalTo
    constraints/LessThan
    constraints/LessThanOrEqual
+   constraints/GreaterThan
 
    constraints/Date
    constraints/DateTime
diff --git a/reference/constraints/GreaterThan.rst b/reference/constraints/GreaterThan.rst
@@ -0,0 +1,96 @@
+GreaterThan
+===========
+
+.. versionadded:: 2.3
+    This constraint is new in version 2.3.
+
+Validates that a value is greater than another value, defined in the options. To
+force that a value is greater than or equal to another value, see
+:doc:`/reference/constraints/GreaterThanOrEqual`. To force a value is less
+than another value, see :doc:`/reference/constraints/LessThan`.
+
++----------------+---------------------------------------------------------------------------+
+| Applies to     | :ref:`property or method<validation-property-target>`                     |
++----------------+---------------------------------------------------------------------------+
+| Options        | - `value`_                                                                |
+|                | - `message`_                                                              |
++----------------+---------------------------------------------------------------------------+
+| Class          | :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThan`          |
++----------------+---------------------------------------------------------------------------+
+| Validator      | :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThanValidator` |
++----------------+---------------------------------------------------------------------------+
+
+Basic Usage
+-----------
+
+If you want to ensure that the ``age`` of a ``Person`` class is greater than
+``18``, you could do the following:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # src/SocialBundle/Resources/config/validation.yml
+        Acme\SocialBundle\Entity\Person:
+            properties:
+                age:
+                    - GreaterThan:
+                        value: 18
+
+    .. code-block:: php-annotations
+
+        // src/Acme/SocialBundle/Entity/Person.php
+        namespace Acme\SocialBundle\Entity;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Person
+        {
+            /**
+             * @Assert\GreaterThan(
+             *     value = 18
+             * )
+             */
+            protected $age;
+        }
+
+    .. code-block:: xml
+
+        <!-- src/Acme/SocialBundle/Resources/config/validation.xml -->
+        <class name="Acme\SocialBundle\Entity\Person">
+            <property name="age">
+                <constraint name="GreaterThan">
+                    <option name="value">18</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\GreaterThan(array(
+                    'value' => 18,
+                )));
+            }
+        }
+
+Options
+-------
+
+.. include:: /reference/constraints/_comparison-value-option.rst.inc
+
+message
+~~~~~~~
+
+**type**: ``string`` **default**: ``This value should be greater than {{ 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
@@ -35,6 +35,7 @@ Comparison Constraints
 * :doc:`NotIdenticalTo </reference/constraints/NotIdenticalTo>`
 * :doc:`LessThan </reference/constraints/LessThan>`
 * :doc:`LessThanOrEqual </reference/constraints/LessThanOrEqual>`
+* :doc:`GreaterThan </reference/constraints/GreaterThan>`
 
 Date Constraints
 ~~~~~~~~~~~~~~~~
