[Validator] Add shorter examples using the default option

Author: alexmart

reference/constraints/Choice.rst

@@ -46,6 +46,11 @@ If your valid choice list is simple, you can pass them in directly via the
 
         class Author
         {
+            /**
+             * @Assert\Choice({"New York", "Berlin", "Tokyo"})
+             */
+            protected $city;
+
             /**
              * @Assert\Choice(choices = {"male", "female"}, message = "Choose a valid gender.")
              */
@@ -57,6 +62,7 @@ If your valid choice list is simple, you can pass them in directly via the
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Author:
             properties:
+                city: [New York, Berlin, Tokyo]
                 gender:
                     - Choice:
                         choices:  [male, female]
@@ -71,6 +77,13 @@ If your valid choice list is simple, you can pass them in directly via the
             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\Author">
+                <property name="city">
+                    <constraint name="Choice">
+                        <value>New York</value>
+                        <value>Berlin</value>
+                        <value>Tokyo</value>
+                    </constraint>
+                </property>
                 <property name="gender">
                     <constraint name="Choice">
                         <option name="choices">
@@ -97,6 +110,11 @@ If your valid choice list is simple, you can pass them in directly via the
 
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint(
+                    'gender',
+                     new Assert\Choice(array('New York', 'Berlin', 'Tokyo'))
+                 );
+
                 $metadata->addPropertyConstraint('gender', new Assert\Choice(array(
                     'choices' => array('male', 'female'),
                     'message' => 'Choose a valid gender.',

reference/constraints/EqualTo.rst

@@ -28,8 +28,8 @@ To force that a value is *not* equal, see :doc:`/reference/constraints/NotEqualT
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is equal to
-``20``, you could do the following:
+If you want to ensure that the ``firstName`` of a ``Person`` class is equal to ``Mary``
+and that the ``age`` is ``20``, you could do the following:
 
 .. configuration-block::
 
@@ -42,6 +42,11 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
 
         class Person
         {
+            /**
+             * @Assert\EqualTo("Mary")
+             */
+            protected $firstName;
+
             /**
              * @Assert\EqualTo(
              *     value = 20
@@ -55,6 +60,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                firstName:
+                    - EqualTo: Mary
                 age:
                     - EqualTo:
                         value: 20
@@ -68,6 +75,11 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
             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\Person">
+                <property name="firstName">
+                    <constraint name="EqualTo">
+                        <value>Mary</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="EqualTo">
                         <option name="value">20</option>
@@ -88,6 +100,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('firstName', new Assert\EqualTo('Mary'));
+
                 $metadata->addPropertyConstraint('age', new Assert\EqualTo(array(
                     'value' => 20,
                 )));

reference/constraints/GreaterThan.rst

@@ -24,8 +24,10 @@ than another value, see :doc:`/reference/constraints/LessThan`.
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is greater than
-``18``, you could do the following:
+The following constraints ensure that:
+- the number of ``siblings`` of a ``Person`` is greater than ``5``
+- the ``age`` of a ``Person`` class is greater than ``18``
+
 
 .. configuration-block::
 
@@ -38,6 +40,12 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
 
         class Person
         {
+
+            /**
+             * @Assert\GreaterThan(5)
+             */
+            protected $siblings;
+
             /**
              * @Assert\GreaterThan(
              *     value = 18
@@ -51,6 +59,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                siblings:
+                    - GreaterThan: 5
                 age:
                     - GreaterThan:
                         value: 18
@@ -64,6 +74,11 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
             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\Person">
+                <property name="siblings">
+                    <constraint name="GreaterThan">
+                        <value>5</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="GreaterThan">
                         <option name="value">18</option>
@@ -84,6 +99,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('siblings', new Assert\GreaterThan(5));
+
                 $metadata->addPropertyConstraint('age', new Assert\GreaterThan(array(
                     'value' => 18,
                 )));

reference/constraints/GreaterThanOrEqual.rst

@@ -23,8 +23,9 @@ the options. To force that a value is greater than another value, see
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is greater than
-or equal to ``18``, you could do the following:
+The following constraints ensure that:
+- the number of ``siblings`` of a ``Person`` is greater than or equal to ``5``
+- the ``age`` of a ``Person`` class is greater than or equal to ``18``
 
 .. configuration-block::
 
@@ -37,6 +38,11 @@ or equal to ``18``, you could do the following:
 
         class Person
         {
+            /**
+             * @Assert\GreaterThanOrEqual(5)
+             */
+            protected $siblings;
+
             /**
              * @Assert\GreaterThanOrEqual(
              *     value = 18
@@ -50,6 +56,8 @@ or equal to ``18``, you could do the following:
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                siblings:
+                    - GreaterThanOrEqual: 5
                 age:
                     - GreaterThanOrEqual:
                         value: 18
@@ -63,6 +71,11 @@ or equal to ``18``, you could do the following:
             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\Person">
+                <property name="siblings">
+                    <constraint name="GreaterThanOrEqual">
+                        <value>5</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="GreaterThanOrEqual">
                         <option name="value">18</option>
@@ -83,6 +96,8 @@ or equal to ``18``, you could do the following:
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('siblings', new Assert\GreaterThanOrEqual(5));
+
                 $metadata->addPropertyConstraint('age', new Assert\GreaterThanOrEqual(array(
                     'value' => 18,
                 )));

reference/constraints/IdenticalTo.rst

@@ -29,8 +29,9 @@ To force that a value is *not* identical, see
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is equal to
-``20`` and an integer, you could do the following:
+The following constraints ensure that:
+- ``firstName`` of ``Person` class is equal to ``Mary`` *and* is a string
+- ``age`` is equal to``20`` *and* is of type integer
 
 .. configuration-block::
 
@@ -43,6 +44,11 @@ If you want to ensure that the ``age`` of a ``Person`` class is equal to
 
         class Person
         {
+            /**
+             * @Assert\IdenticalTo("Mary")
+             */
+            protected $firstName;
+
             /**
              * @Assert\IdenticalTo(
              *     value = 20

reference/constraints/LessThan.rst

@@ -24,8 +24,9 @@ than another value, see :doc:`/reference/constraints/GreaterThan`.
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is less than
-``80``, you could do the following:
+The following constraints ensure that:
+- the number of ``siblings`` of a ``Person`` is less than or equal to ``5``
+- ``age`` is less than``80``
 
 .. configuration-block::
 
@@ -38,6 +39,12 @@ If you want to ensure that the ``age`` of a ``Person`` class is less than
 
         class Person
         {
+
+            /**
+             * @Assert\LessThan(5)
+             */
+            protected $siblings;
+
             /**
              * @Assert\LessThan(
              *     value = 80
@@ -51,6 +58,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is less than
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                siblings:
+                    - LessThan: 5
                 age:
                     - LessThan:
                         value: 80
@@ -64,6 +73,11 @@ If you want to ensure that the ``age`` of a ``Person`` class is less than
             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\Person">
+                <property name="siblings">
+                    <constraint name="LessThan">
+                        <value>5</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="LessThan">
                         <option name="value">80</option>
@@ -84,6 +98,8 @@ If you want to ensure that the ``age`` of a ``Person`` class is less than
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('siblings', new Assert\LessThan(5));
+
                 $metadata->addPropertyConstraint('age', new Assert\LessThan(array(
                     'value' => 80,
                 )));

reference/constraints/LessThanOrEqual.rst

@@ -23,8 +23,9 @@ options. To force that a value is less than another value, see
 Basic Usage
 -----------
 
-If you want to ensure that the ``age`` of a ``Person`` class is less than or
-equal to ``80``, you could do the following:
+The following constraints ensure that:
+- the number of ``siblings`` of a ``Person`` is less than or equal to ``5``
+- the ``age`` is less than or equal to ``80``
 
 .. configuration-block::
 
@@ -37,6 +38,11 @@ equal to ``80``, you could do the following:
 
         class Person
         {
+            /**
+             * @Assert\LessThanOrEqual(5)
+             */
+            protected $siblings;
+
             /**
              * @Assert\LessThanOrEqual(
              *     value = 80
@@ -50,6 +56,8 @@ equal to ``80``, you could do the following:
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                siblings:
+                    - LessThanOrEqual: 5
                 age:
                     - LessThanOrEqual:
                         value: 80
@@ -63,6 +71,11 @@ equal to ``80``, you could do the following:
             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\Person">
+                <property name="siblings">
+                    <constraint name="LessThanOrEqual">
+                        <value>5</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="LessThanOrEqual">
                         <option name="value">80</option>
@@ -83,6 +96,8 @@ equal to ``80``, you could do the following:
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('siblings', new Assert\LessThanOrEqual(5));
+
                 $metadata->addPropertyConstraint('age', new Assert\LessThanOrEqual(array(
                     'value' => 80,
                 )));

reference/constraints/NotEqualTo.rst

@@ -28,9 +28,10 @@ options. To force that a value is equal, see
 
 Basic Usage
 -----------
+If you want to ensure that the ``firstName`` of a ``Person`` is not equal to
+``Mary`` and that the ``age`` of a ``Person`` class is not ``15``, you could do
+the following:
 
-If you want to ensure that the ``age`` of a ``Person`` class is not equal
-to ``15``, you could do the following:
 
 .. configuration-block::
 
@@ -43,6 +44,11 @@ to ``15``, you could do the following:
 
         class Person
         {
+            /**
+             * @Assert\NotEqualTo("Mary")
+             */
+            protected $firstName;
+
             /**
              * @Assert\NotEqualTo(
              *     value = 15
@@ -56,6 +62,8 @@ to ``15``, you could do the following:
         # src/AppBundle/Resources/config/validation.yml
         AppBundle\Entity\Person:
             properties:
+                firstName:
+                    - NotEqualTo: Mary
                 age:
                     - NotEqualTo:
                         value: 15
@@ -69,6 +77,11 @@ to ``15``, you could do the following:
             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\Person">
+                <property name="firstName">
+                    <constraint name="NotEqualTo">
+                        <value>Mary</value>
+                    </constraint>
+                </property>
                 <property name="age">
                     <constraint name="NotEqualTo">
                         <option name="value">15</option>
@@ -89,6 +102,8 @@ to ``15``, you could do the following:
         {
             public static function loadValidatorMetadata(ClassMetadata $metadata)
             {
+                $metadata->addPropertyConstraint('age', new Assert\NotEqualTo('Mary'));
+
                 $metadata->addPropertyConstraint('age', new Assert\NotEqualTo(array(
                     'value' => 15,
                 )));