minor #9428 Documented the "values" option of the Expression constraint (javiereguiluz)

javiereguiluz · javiereguiluz · commit 7fcae45cb8e5 · 2018-03-18T19:55:16.000+01:00
This PR was squashed before being merged into the master branch (closes #9428). Discussion ---------- Documented the "values" option of the Expression constraint This fixes #9098. @ostrolucky I have problems defining the XML config of this example. Could you please help me? Thanks! Commits ------- 3aebcb7 Documented the "values" option of the Expression constraint
diff --git a/reference/constraints/Expression.rst b/reference/constraints/Expression.rst
@@ -12,6 +12,7 @@ gives you similar flexibility.
 | Options        | - :ref:`expression <reference-constraint-expression-option>`                                  |
 |                | - `message`_                                                                                  |
 |                | - `payload`_                                                                                  |
+|                | - `values`_                                                                                   |
 +----------------+-----------------------------------------------------------------------------------------------+
 | Class          | :class:`Symfony\\Component\\Validator\\Constraints\\Expression`                               |
 +----------------+-----------------------------------------------------------------------------------------------+
@@ -253,3 +254,90 @@ message
 The default message supplied when the expression evaluates to false.
 
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+values
+~~~~~~
+
+**type**: ``array`` **default**: ``[]``
+
+.. versionadded:: 4.1
+    The ``values`` option was introduced in Symfony 4.1.
+
+The values of the custom variables used in the expression. Values can be of any
+type (numeric, boolean, strings, null, etc.)
+
+.. configuration-block::
+
+    .. code-block:: php-annotations
+
+        // src/Model/Analysis.php
+        namespace App\Model;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+
+        class Analysis
+        {
+            /**
+             * @Assert\Expression(
+             *     "value + error_margin < threshold",
+             *     values = { "error_margin": 0.25, "threshold": 1.5 }
+             * )
+             */
+            private $metric;
+
+            // ...
+        }
+
+    .. code-block:: yaml
+
+        # config/validator/validation.yaml
+        App\Model\Analysis:
+            properties:
+                metric:
+                    - Expression:
+                        expression: "value + error_margin < threshold"
+                        values:     { error_margin: 0.25, threshold: 1.5 }
+
+    .. code-block:: xml
+
+        <!-- config/validator/validation.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
+
+            <class name="App\Model\Analysis">
+                <property name="metric">
+                    <constraint name="Expression">
+                        <option name="expression">
+                            value + error_margin &lt; threshold
+                        </option>
+                        <option name="values">
+                            <value key="error_margin">0.25</value>
+                            <value key="threshold">1.5</value>
+                        </option>
+                    </constraint>
+                </property>
+            </class>
+        </constraint-mapping>
+
+    .. code-block:: php
+
+        // src/Model/Analysis.php
+        namespace App\Model;
+
+        use Symfony\Component\Validator\Constraints as Assert;
+        use Symfony\Component\Validator\Mapping\ClassMetadata;
+
+        class Analysis
+        {
+            public static function loadValidatorMetadata(ClassMetadata $metadata)
+            {
+                $metadata->addPropertyConstraint('metric', new Assert\Expression(array(
+                    'expression' => 'value + error_margin < threshold',
+                    'values' => array('error_margin' => 0.25, 'threshold' => 1.5),
+                )));
+            }
+
+            // ...
+        }
