Compound

To the contrary to the other constraints, this constraint cannot be used on its own. Instead, it allows you to create your own set of reusable constraints, representing rules to use consistently across your application, by extending the constraint.

New in version 5.1

The Compound constraint was introduced in Symfony 5.1.

Applies to	class or property or method
Options	groups payload
Class	Compound
Validator	CompoundValidator

Basic Usage

Suppose that you have different places where a user password must be validated, you can create your own named set or requirements to be reused consistently everywhere:

Annotations
Attributes

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        // src/Validator/Constraints/PasswordRequirements.php
namespace App\Validator\Constraints;

use Symfony\Component\Validator\Constraints\Compound;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @Annotation
 */
class PasswordRequirements extends Compound
{
    protected function getConstraints(array $options): array
    {
        return [
            new Assert\NotBlank(),
            new Assert\Type('string'),
            new Assert\Length(['min' => 12]),
            new Assert\NotCompromisedPassword(),
        ];
    }
}
    

Add @Annotation or #[\Attribute] to the constraint class if you want to use it as an annotation/attribute in other classes. If the constraint has configuration options, define them as public properties on the constraint class.

New in version 5.2

The ability to use PHP attributes to configure constraints was introduced in Symfony 5.2. Prior to this, Doctrine Annotations were the only way to annotate constraints.

You can now use it anywhere you need it:

Annotations
Attributes
YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Entity/User.php
namespace App\Entity\User;

use App\Validator\Constraints as Assert;

class User
{
    /**
     * @Assert\PasswordRequirements()
     */
    public $plainPassword;
}
    

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/User.php
namespace App\Entity\User;

use App\Validator\Constraints as Assert;

class User
{
    #[Assert\PasswordRequirements]
    public $plainPassword;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\User:
    properties:
        plainPassword:
            - App\Validator\Constraints\PasswordRequirements: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\User">
        <property name="plainPassword">
            <constraint name="App\Validator\Constraints\PasswordRequirements"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // src/Entity/User.php
namespace App\Entity\User;

use App\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class User
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('plainPassword', new Assert\PasswordRequirements());
    }
}
    

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

Compound

Compound

Basic Usage

Options

`groups`

`payload`

Deployed on