Skip to content

Documented the "values" option of the Expression constraint #9428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions reference/constraints/Expression.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
+----------------+-----------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -253,3 +254,92 @@ message
The default message supplied when the expression evaluates to false.

.. include:: /reference/constraints/_payload-option.rst.inc

values
~~~~~~

**type**: ``array`` **default**: an empty array
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we use [] in that case? (or just nothing, as empty is like no 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
{
// ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imo, this and the empty line below can be removed. That saves some lines


/**
* @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),
)));
}

// ...
}