feature #8531 Documented the propertyPath option of the comparison constraints (javiereguiluz)

This PR was squashed before being merged into the 3.4 branch (closes #8531).

Discussion
----------

Documented the propertyPath option of the comparison constraints

This fixes #8150.

Commits
-------

cacd0e8 Fixed a RST syntax issue
f856772 Documented the propertyPath option of the comparison constraints

Author: weaverryan

reference/constraints/EqualTo.rst

@@ -16,6 +16,7 @@ To force that a value is *not* equal, see :doc:`/reference/constraints/NotEqualT
 | Options        | - `value`_                                                            |
 |                | - `message`_                                                          |
 |                | - `payload`_                                                          |
+|                | - `propertyPath`_                                                     |
 +----------------+-----------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\EqualTo`          |
 +----------------+-----------------------------------------------------------------------+
@@ -118,3 +119,5 @@ message
 This is the message that will be shown if the value is not equal.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc

reference/constraints/GreaterThan.rst

@@ -12,6 +12,7 @@ than another value, see :doc:`/reference/constraints/LessThan`.
 | Options        | - `value`_                                                                |
 |                | - `message`_                                                              |
 |                | - `payload`_                                                              |
+|                | - `propertyPath`_                                                         |
 +----------------+---------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThan`          |
 +----------------+---------------------------------------------------------------------------+
@@ -301,4 +302,6 @@ comparison value.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
 
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc
+
 .. _`accepted by the DateTime constructor`: http://www.php.net/manual/en/datetime.formats.php

reference/constraints/GreaterThanOrEqual.rst

@@ -11,6 +11,7 @@ the options. To force that a value is greater than another value, see
 | Options        | - `value`_                                                                       |
 |                | - `message`_                                                                     |
 |                | - `payload`_                                                                     |
+|                | - `propertyPath`_                                                                |
 +----------------+----------------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\GreaterThanOrEqual`          |
 +----------------+----------------------------------------------------------------------------------+
@@ -299,4 +300,6 @@ to the comparison value.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
 
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc
+
 .. _`accepted by the DateTime constructor`: http://www.php.net/manual/en/datetime.formats.php

reference/constraints/IdenticalTo.rst

@@ -17,6 +17,7 @@ To force that a value is *not* identical, see
 | Options        | - `value`_                                                               |
 |                | - `message`_                                                             |
 |                | - `payload`_                                                             |
+|                | - `propertyPath`_                                                        |
 +----------------+--------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\IdenticalTo`         |
 +----------------+--------------------------------------------------------------------------+
@@ -112,3 +113,5 @@ message
 This is the message that will be shown if the value is not identical.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc

reference/constraints/LessThan.rst

@@ -12,6 +12,7 @@ than another value, see :doc:`/reference/constraints/GreaterThan`.
 | Options        | - `value`_                                                             |
 |                | - `message`_                                                           |
 |                | - `payload`_                                                           |
+|                | - `propertyPath`_                                                      |
 +----------------+------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\LessThan`          |
 +----------------+------------------------------------------------------------------------+
@@ -300,4 +301,6 @@ comparison value.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
 
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc
+
 .. _`accepted by the DateTime constructor`: http://www.php.net/manual/en/datetime.formats.php

reference/constraints/LessThanOrEqual.rst

@@ -11,6 +11,7 @@ options. To force that a value is less than another value, see
 | Options        | - `value`_                                                                    |
 |                | - `message`_                                                                  |
 |                | - `payload`_                                                                  |
+|                | - `propertyPath`_                                                             |
 +----------------+-------------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\LessThanOrEqual`          |
 +----------------+-------------------------------------------------------------------------------+
@@ -298,4 +299,6 @@ to the comparison value.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
 
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc
+
 .. _`accepted by the DateTime constructor`: http://www.php.net/manual/en/datetime.formats.php

reference/constraints/NotEqualTo.rst

@@ -17,6 +17,7 @@ options. To force that a value is equal, see
 | Options        | - `value`_                                                              |
 |                | - `message`_                                                            |
 |                | - `payload`_                                                            |
+|                | - `propertyPath`_                                                       |
 +----------------+-------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\NotEqualTo`         |
 +----------------+-------------------------------------------------------------------------+
@@ -120,3 +121,5 @@ message
 This is the message that will be shown if the value is equal.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc

reference/constraints/NotIdenticalTo.rst

@@ -17,6 +17,7 @@ the options. To force that a value is identical, see
 | Options        | - `value`_                                                                  |
 |                | - `message`_                                                                |
 |                | - `payload`_                                                                |
+|                | - `propertyPath`_                                                           |
 +----------------+-----------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\NotIdenticalTo`         |
 +----------------+-----------------------------------------------------------------------------+
@@ -121,3 +122,5 @@ message
 This is the message that will be shown if the value is identical.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+.. include:: /reference/constraints/_comparison-propertypath-option.rst.inc

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

@@ -0,0 +1,10 @@
+propertyPath
+~~~~~~~~~~~~
+
+**type**: ``string``
+
+It defines the object property whose value is used to make the comparison.
+
+For example, if you want to compare the ``$endDate`` property of some object
+with regard to the ``$startDate`` property of the same object, use
+``propertyPath="startDate"`` in the comparison constraint of ``$endDate``.