New in Symfony 6.2: Conditional Constraints

Contributed by
wuchen90
in #42593.

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:

// 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 is percent, then value must be less than or equal 100;
  • If type is absolute, then value can be any value;
  • In all cases, the value must be greater than 0.

The new When constraint defines tow 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:

use Symfony\Component\Validator\Constraints as Assert;
// ...

class Discount
{
    #[Assert\GreaterThan(0)]
    #[Assert\When(
        expression: 'this.type == "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:

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;

    // ...
}
            <hr style="margin-bottom: 5px" />
            <div style="font-size: 90%">
                <a href="https://symfony.com/sponsor">Sponsor</a> the Symfony project.
            </div>

https://symfony.com/blog/new-in-symfony-6-2-conditional-constraints?utm_source=Symfony%20Blog%20Feed&utm_medium=feed

Created 3y | Nov 9, 2022, 9:20:04 AM


Login to add comment

Other posts in this group

Case study: A Long-Term Powerhouse Behind Vente-unique.com's E-Commerce Success (Zero Churn, All Wins!)

Vente-unique.com, a leading European online retailer of furniture and home decor, operates in 11 countries, powered by a team of 400 professionals and serving more than 3 million customers. From 15 ye

Jul 2, 2025, 9:10:03 AM | Symfony
A Week of Symfony #965 (June 23–29, 2025)

This week, Symfony 6.4.23, 7.2.8 and 7.3.1 maintenance versions were released. Meanwhile, the upcoming Symfony 7.4 version continued adding new features such as better controller helpers, more precisi

Jun 29, 2025, 9:10:15 AM | Symfony
Symfony 6.4.23 released

Symfony 6.4.23 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in you

Jun 28, 2025, 9:50:15 AM | Symfony
Symfony 7.2.8 released

Symfony 7.2.8 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in your

Jun 28, 2025, 9:50:15 AM | Symfony
Symfony 7.3.1 released

Symfony 7.3.1 has just been released. Read the Symfony upgrade guide to learn more about upgrading Symfony and use the SymfonyInsight upgrade reports to detect the code you will need to change in your

Jun 28, 2025, 9:50:14 AM | Symfony
A Week of Symfony #964 (June 16–22, 2025)

This week, development activity was intense, with many bug fixes in the maintained branches, numerous deprecation removals in the 8.0 branch, and new features added to the 7.4 branch, including tighte

Jun 22, 2025, 8:10:05 AM | Symfony
SymfonyOnline June 2025: Speakers, Stats & Replays!

Thank you for joining us at SymfonyOnline June 2025!

What a great edition of SymfonyOnline we’ve just wrapped up! 🎉

We were thrilled to welcome 300 participants from 35 different countries—a

Jun 18, 2025, 8:50:17 AM | Symfony