Skip to content

Commit 7003445

Browse files
javiereguiluzweaverryan
javiereguiluz
authored and
weaverryan
committed
Finished the documentation of the new data comparison validators
1 parent 1fa69fe commit 7003445

File tree

5 files changed

+253
-127
lines changed

5 files changed

+253
-127
lines changed

‎reference/constraints/GreaterThan.rst‎

Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,19 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
5757
.. code-block:: xml
5858
5959
<!-- src/Acme/SocialBundle/Resources/config/validation.xml -->
60-
<class name="Acme\SocialBundle\Entity\Person">
61-
<property name="age">
62-
<constraint name="GreaterThan">
63-
<option name="value">18</option>
64-
</constraint>
65-
</property>
66-
</class>
60+
<?xml version="1.0" encoding="UTF-8" ?>
61+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
62+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
63+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
64+
65+
<class name="Acme\SocialBundle\Entity\Person">
66+
<property name="age">
67+
<constraint name="GreaterThan">
68+
<option name="value">18</option>
69+
</constraint>
70+
</property>
71+
</class>
72+
</constraint-mapping>
6773
6874
.. code-block:: php
6975
@@ -86,6 +92,9 @@ If you want to ensure that the ``age`` of a ``Person`` class is greater than
8692
Comparing Dates
8793
---------------
8894

95+
.. versionadded:: 2.6
96+
The feature to compare dates was added in Symfony 2.6.
97+
8998
This constraint can be used to compare ``DateTime`` objects against any date
9099
string `accepted by the DateTime constructor`_. For example, you could check
91100
that a date must at least be the next day:
@@ -94,15 +103,15 @@ that a date must at least be the next day:
94103

95104
.. code-block:: yaml
96105
97-
# src/OrderBundle/Resources/config/validation.yml
106+
# src/Acme/OrderBundle/Resources/config/validation.yml
98107
Acme\OrderBundle\Entity\Order:
99108
properties:
100109
deliveryDate:
101110
- GreaterThan: today
102111
103112
.. code-block:: php-annotations
104113
105-
// src/Acme/SocialBundle/Entity/Order.php
114+
// src/Acme/OrderBundle/Entity/Order.php
106115
namespace Acme\OrderBundle\Entity;
107116
108117
use Symfony\Component\Validator\Constraints as Assert;
@@ -118,11 +127,17 @@ that a date must at least be the next day:
118127
.. code-block:: xml
119128
120129
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
121-
<class name="Acme\OrderBundle\Entity\Order">
122-
<property name="deliveryDate">
123-
<constraint name="GreaterThan">today</constraint>
124-
</property>
125-
</class>
130+
<?xml version="1.0" encoding="UTF-8" ?>
131+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
132+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
133+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
134+
135+
<class name="Acme\OrderBundle\Entity\Order">
136+
<property name="deliveryDate">
137+
<constraint name="GreaterThan">today</constraint>
138+
</property>
139+
</class>
140+
</constraint-mapping>
126141
127142
.. code-block:: php
128143
@@ -147,15 +162,15 @@ dates. If you want to fix the timezone, append it to the date string:
147162

148163
.. code-block:: yaml
149164
150-
# src/OrderBundle/Resources/config/validation.yml
165+
# src/Acme/OrderBundle/Resources/config/validation.yml
151166
Acme\OrderBundle\Entity\Order:
152167
properties:
153168
deliveryDate:
154169
- GreaterThan: today UTC
155170
156171
.. code-block:: php-annotations
157172
158-
// src/Acme/SocialBundle/Entity/Order.php
173+
// src/Acme/OrderBundle/Entity/Order.php
159174
namespace Acme\OrderBundle\Entity;
160175
161176
use Symfony\Component\Validator\Constraints as Assert;
@@ -171,11 +186,17 @@ dates. If you want to fix the timezone, append it to the date string:
171186
.. code-block:: xml
172187
173188
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
174-
<class name="Acme\OrderBundle\Entity\Order">
175-
<property name="deliveryDate">
176-
<constraint name="GreaterThan">today UTC</constraint>
177-
</property>
178-
</class>
189+
<?xml version="1.0" encoding="UTF-8" ?>
190+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
191+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
192+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
193+
194+
<class name="Acme\OrderBundle\Entity\Order">
195+
<property name="deliveryDate">
196+
<constraint name="GreaterThan">today UTC</constraint>
197+
</property>
198+
</class>
199+
</constraint-mapping>
179200
180201
.. code-block:: php
181202
@@ -201,15 +222,15 @@ current time:
201222

202223
.. code-block:: yaml
203224
204-
# src/OrderBundle/Resources/config/validation.yml
225+
# src/Acme/OrderBundle/Resources/config/validation.yml
205226
Acme\OrderBundle\Entity\Order:
206227
properties:
207228
deliveryDate:
208229
- GreaterThan: +5 hours
209230
210231
.. code-block:: php-annotations
211232
212-
// src/Acme/SocialBundle/Entity/Order.php
233+
// src/Acme/OrderBundle/Entity/Order.php
213234
namespace Acme\OrderBundle\Entity;
214235
215236
use Symfony\Component\Validator\Constraints as Assert;
@@ -225,11 +246,17 @@ current time:
225246
.. code-block:: xml
226247
227248
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
228-
<class name="Acme\OrderBundle\Entity\Order">
229-
<property name="deliveryDate">
230-
<constraint name="GreaterThan">+5 hours</constraint>
231-
</property>
232-
</class>
249+
<?xml version="1.0" encoding="UTF-8" ?>
250+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
251+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
252+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
253+
254+
<class name="Acme\OrderBundle\Entity\Order">
255+
<property name="deliveryDate">
256+
<constraint name="GreaterThan">+5 hours</constraint>
257+
</property>
258+
</class>
259+
</constraint-mapping>
233260
234261
.. code-block:: php
235262

‎reference/constraints/GreaterThanOrEqual.rst‎

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,19 @@ or equal to ``18``, you could do the following:
5656
.. code-block:: xml
5757
5858
<!-- src/Acme/SocialBundle/Resources/config/validation.xml -->
59-
<class name="Acme\SocialBundle\Entity\Person">
60-
<property name="age">
61-
<constraint name="GreaterThanOrEqual">
62-
<option name="value">18</option>
63-
</constraint>
64-
</property>
65-
</class>
59+
<?xml version="1.0" encoding="UTF-8" ?>
60+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
61+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
62+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
63+
64+
<class name="Acme\SocialBundle\Entity\Person">
65+
<property name="age">
66+
<constraint name="GreaterThanOrEqual">
67+
<option name="value">18</option>
68+
</constraint>
69+
</property>
70+
</class>
71+
</constraint-mapping>
6672
6773
.. code-block:: php
6874
@@ -85,6 +91,9 @@ or equal to ``18``, you could do the following:
8591
Comparing Dates
8692
---------------
8793

94+
.. versionadded:: 2.6
95+
The feature to compare dates was added in Symfony 2.6.
96+
8897
This constraint can be used to compare ``DateTime`` objects against any date
8998
string `accepted by the DateTime constructor`_. For example, you could check
9099
that a date must at least be the current day:
@@ -117,11 +126,17 @@ that a date must at least be the current day:
117126
.. code-block:: xml
118127
119128
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
120-
<class name="Acme\OrderBundle\Entity\Order">
121-
<property name="deliveryDate">
122-
<constraint name="GreaterThanOrEqual">today</constraint>
123-
</property>
124-
</class>
129+
<?xml version="1.0" encoding="UTF-8" ?>
130+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
131+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
132+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
133+
134+
<class name="Acme\OrderBundle\Entity\Order">
135+
<property name="deliveryDate">
136+
<constraint name="GreaterThanOrEqual">today</constraint>
137+
</property>
138+
</class>
139+
</constraint-mapping>
125140
126141
.. code-block:: php
127142
@@ -170,11 +185,17 @@ dates. If you want to fix the timezone, append it to the date string:
170185
.. code-block:: xml
171186
172187
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
173-
<class name="Acme\OrderBundle\Entity\Order">
174-
<property name="deliveryDate">
175-
<constraint name="GreaterThanOrEqual">today UTC</constraint>
176-
</property>
177-
</class>
188+
<?xml version="1.0" encoding="UTF-8" ?>
189+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
190+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
191+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
192+
193+
<class name="Acme\OrderBundle\Entity\Order">
194+
<property name="deliveryDate">
195+
<constraint name="GreaterThanOrEqual">today UTC</constraint>
196+
</property>
197+
</class>
198+
</constraint-mapping>
178199
179200
.. code-block:: php
180201
@@ -224,11 +245,17 @@ current time:
224245
.. code-block:: xml
225246
226247
<!-- src/Acme/OrderBundle/Resources/config/validation.xml -->
227-
<class name="Acme\OrderBundle\Entity\Order">
228-
<property name="deliveryDate">
229-
<constraint name="GreaterThanOrEqual">+5 hours</constraint>
230-
</property>
231-
</class>
248+
<?xml version="1.0" encoding="UTF-8" ?>
249+
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
250+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
251+
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
252+
253+
<class name="Acme\OrderBundle\Entity\Order">
254+
<property name="deliveryDate">
255+
<constraint name="GreaterThanOrEqual">+5 hours</constraint>
256+
</property>
257+
</class>
258+
</constraint-mapping>
232259
233260
.. code-block:: php
234261

0 commit comments

Comments
 (0)