New in Symfony 6.2: Conditional Constraints
November 9, 2022 • Published by Javier Eguiluz
Symfony 6.2 is backed by:
Warning: This post is about an unsupported Symfony version. Some of this information may be out of date. Read the most recent Symfony Docs.
The Symfony Validator component includes some advanced constraints such as Callback (to implement custom validation rules), Sequentially (to apply a set of rules in order and interrupt them at any point), Compound (to create a set of reusable constraints), etc.
In Symfony 6.2 we're adding another advanced constraint to that list: When
,
which allows to implement conditional validations.
Consider a Discount
class with two properties:
1 2 3 4 5 6 7 8 9 10
// src/Model/Discount.php
namespace App\Model;
class Discount
{
private ?string $type;
private ?int $value;
// ...
}
To validate the object contents, you need to apply these rules:
- If
type
ispercent
, thenvalue
must be less than or equal100
; - If
type
isabsolute
, thenvalue
can be any value; - In all cases, the
value
must be greater than 0.
The new When
constraint defines two main options called expression
and
constraints
. These constraints are only enforced when the result of evaluating
the expression is true
. You can use it as follows to validate that the
value
is less than 100
only if the discount type
is percent
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
use Symfony\Component\Validator\Constraints as Assert;
// ...
class Discount
{
#[Assert\GreaterThan(0)]
#[Assert\When(
expression: 'this.getType() == "percent"',
constraints: [
new Assert\LessThanOrEqual(100, message: 'The value should be between 1 and 100!')
],
)]
private ?int $value;
// ...
}
The condition passed to the expression
option must use the Symfony
ExpressionLanguage syntax. Inside the expression you can use the this
variable to refer to the object being validated and value
to refer to the
property being valuated (this is only available if you apply the When
constraint to properties).
Finally, you can combine When
with other advanced constraints such as Callback
to define complex conditional validations:
1 2 3 4 5 6 7 8 9 10 11 12 13
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
class Discount
{
#[Assert\When(
expression: 'value == "percent"',
constraints: [new Assert\Callback('doComplexValidation')],
)]
private ?string $type;
// ...
}
Help the Symfony project!
As with any Open-Source project, contributing code or documentation is the most common way to help, but we also have a wide range of sponsoring opportunities.
Comments are closed.
To ensure that comments stay relevant, they are closed for old posts.
When using the Assert\When constrain directly in the form types, would it be possible to use callbacks rather than expressions?
eg
$form->add('type', SomeType::class, [
'constraints' => [
new Assert\When([
'expression' => fn (DataClass $data) => $data->getSomeField() === 'some_value',
'constraints' => [...],
],
]);
expression: 'this.isCustomConditionMethodValid'