How to Sequentially Apply Validation Groups

How to Sequentially Apply Validation Groups

In some cases, you want to validate your groups by steps. To do this, you can use the GroupSequence feature. In this case, an object defines a group sequence, which determines the order groups should be validated.

For example, suppose you have a User class and want to validate that the username and the password are different only if all other validation passes (in order to avoid multiple error messages).

  • Annotations

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. use Symfony\Component\Security\Core\User\UserInterface;
    5. use Symfony\Component\Validator\Constraints as Assert;
    7. /**
    8.  * @Assert\GroupSequence({"User", "Strict"})
    9.  */
    10. class User implements UserInterface
    11. {
    12.     /**
    13.      * @Assert\NotBlank
    14.      */
    15.     private $username;
    17.     /**
    18.      * @Assert\NotBlank
    19.      */
    20.     private $password;
    22.     /**
    23.      * @Assert\IsTrue(message="The password cannot match your username", groups={"Strict"})
    24.      */
    25.     public function isPasswordSafe()
    26.     {
    27.         return ($this->username !== $this->password);
    28.     }
    29. }

  • YAML

    1. # config/validator/validation.yaml
    2. App\Entity\User:
    3.     group_sequence:
    4.         - User
    5.         - Strict
    6.     getters:
    7.         passwordSafe:
    8.             - 'IsTrue':
    9.                 message: 'The password cannot match your username'
    10.                 groups: [Strict]
    11.     properties:
    12.         username:
    13.             - NotBlank: ~
    14.         password:
    15.             - NotBlank: ~

  • XML

    1. <!-- config/validator/validation.xml -->
    2. <?xml version="1.0" encoding="UTF-8" ?>
    3. <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    5.     xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    7.     <class name="App\Entity\User">
    8.         <property name="username">
    9.             <constraint name="NotBlank"/>
    10.         </property>
    12.         <property name="password">
    13.             <constraint name="NotBlank"/>
    14.         </property>
    16.         <getter property="passwordSafe">
    17.             <constraint name="IsTrue">
    18.                 <option name="message">The password cannot match your username</option>
    19.                 <option name="groups">
    20.                     <value>Strict</value>
    21.                 </option>
    22.             </constraint>
    23.         </getter>
    25.         <group-sequence>
    26.             <value>User</value>
    27.             <value>Strict</value>
    28.         </group-sequence>
    29.     </class>
    30. </constraint-mapping>

  • PHP

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    5. use Symfony\Component\Validator\Mapping\ClassMetadata;
    7. class User
    8. {
    9.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    10.     {
    11.         $metadata->addPropertyConstraint('username', new Assert\NotBlank());
    12.         $metadata->addPropertyConstraint('password', new Assert\NotBlank());
    14.         $metadata->addGetterConstraint('passwordSafe', new Assert\IsTrue([
    15.             'message' => 'The password cannot match your first name',
    16.             'groups'  => ['Strict'],
    17.         ]));
    19.         $metadata->setGroupSequence(['User', 'Strict']);
    20.     }
    21. }

In this example, it will first validate all constraints in the group User (which is the same as the Default group). Only if all constraints in that group are valid, the second group, Strict, will be validated.

Caution

As you have already seen in How to Apply only a Subset of all Your Validation Constraints (Validation Groups), the Default group and the group containing the class name (e.g. User) were identical. However, when using Group Sequences, they are no longer identical. The Default group will now reference the group sequence, instead of all constraints that do not belong to any group.

This means that you have to use the {ClassName} (e.g. User) group when specifying a group sequence. When using Default, you get an infinite recursion (as the Default group references the group sequence, which will contain the Default group which references the same group sequence, …).

Caution

Calling validate() with a group in the sequence (Strict in previous example) will cause a validation only with that group and not with all the groups in the sequence. This is because sequence is now referred to Default group validation.

You can also define a group sequence in the validation_groups form option:

  1. // src/Form/MyType.php
  2. namespace App\Form;
  4. use Symfony\Component\Form\AbstractType;
  5. use Symfony\Component\OptionsResolver\OptionsResolver;
  6. use Symfony\Component\Validator\Constraints\GroupSequence;
  7. // ...
  9. class MyType extends AbstractType
  10. {
  11.     // ...
  12.     public function configureOptions(OptionsResolver $resolver)
  13.     {
  14.         $resolver->setDefaults([
  15.             'validation_groups' => new GroupSequence(['First', 'Second']),
  16.         ]);
  17.     }
  18. }

Group Sequence Providers

Imagine a User entity which can be a normal user or a premium user. When it’s a premium user, some extra constraints should be added to the user entity (e.g. the credit card details). To dynamically determine which groups should be activated, you can create a Group Sequence Provider. First, create the entity and a new constraint group called Premium:

  • Annotations

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    6. class User
    7. {
    8.     /**
    9.      * @Assert\NotBlank
    10.      */
    11.     private $name;
    13.     /**
    14.      * @Assert\CardScheme(
    15.      *     schemes={"VISA"},
    16.      *     groups={"Premium"},
    17.      * )
    18.      */
    19.     private $creditCard;
    21.     // ...
    22. }

  • YAML

    1. # config/validator/validation.yaml
    2. App\Entity\User:
    3.     properties:
    4.         name:
    5.             - NotBlank: ~
    6.         creditCard:
    7.             - CardScheme:
    8.                 schemes: [VISA]
    9.                 groups: [Premium]

  • XML

    1. <!-- config/validator/validation.xml -->
    2. <?xml version="1.0" encoding="UTF-8" ?>
    3. <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    5.     xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    7.     <class name="App\Entity\User">
    8.         <property name="name">
    9.             <constraint name="NotBlank"/>
    10.         </property>
    12.         <property name="creditCard">
    13.             <constraint name="CardScheme">
    14.                 <option name="schemes">
    15.                     <value>VISA</value>
    16.                 </option>
    17.                 <option name="groups">
    18.                     <value>Premium</value>
    19.                 </option>
    20.             </constraint>
    21.         </property>
    23.         <!-- ... -->
    24.     </class>
    25. </constraint-mapping>

  • PHP

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    5. use Symfony\Component\Validator\Mapping\ClassMetadata;
    7. class User
    8. {
    9.     private $name;
    10.     private $creditCard;
    12.     // ...
    14.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    15.     {
    16.         $metadata->addPropertyConstraint('name', new Assert\NotBlank());
    17.         $metadata->addPropertyConstraint('creditCard', new Assert\CardScheme([
    18.             'schemes' => ['VISA'],
    19.             'groups'  => ['Premium'],
    20.         ]));
    21.     }
    22. }

Now, change the User class to implement Symfony\Component\Validator\GroupSequenceProviderInterface and add the [getGroupSequence()](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/Validator/GroupSequenceProviderInterface.php "Symfony\Component\Validator\GroupSequenceProviderInterface::getGroupSequence()"), method, which should return an array of groups to use:

  1. // src/Entity/User.php
  2. namespace App\Entity;
  4. // ...
  5. use Symfony\Component\Validator\GroupSequenceProviderInterface;
  7. class User implements GroupSequenceProviderInterface
  8. {
  9.     // ...
  11.     public function getGroupSequence()
  12.     {
  13.         // when returning a simple array, if there's a violation in any group
  14.         // the rest of groups are not validated. E.g. if 'User' fails,
  15.         // 'Premium' and 'Api' are not validated:
  16.         return ['User', 'Premium', 'Api'];
  18.         // when returning a nested array, all the groups included in each array
  19.         // are validated. E.g. if 'User' fails, 'Premium' is also validated
  20.         // (and you'll get its violations too) but 'Api' won't be validated:
  21.         return [['User', 'Premium'], 'Api'];
  22.     }
  23. }

At last, you have to notify the Validator component that your User class provides a sequence of groups to be validated:

  • Annotations

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. // ...
    6. /**
    7.  * @Assert\GroupSequenceProvider
    8.  */
    9. class User implements GroupSequenceProviderInterface
    10. {
    11.     // ...
    12. }

  • YAML

    1. # config/validator/validation.yaml
    2. App\Entity\User:
    3.     group_sequence_provider: true

  • XML

    1. <!-- config/validator/validation.xml -->
    2. <?xml version="1.0" encoding="UTF-8" ?>
    3. <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    5.     xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping
    6.         https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    8.     <class name="App\Entity\User">
    9.         <group-sequence-provider/>
    10.         <!-- ... -->
    11.     </class>
    12. </constraint-mapping>

  • PHP

    1. // src/Entity/User.php
    2. namespace App\Entity;
    4. // ...
    5. use Symfony\Component\Validator\Mapping\ClassMetadata;
    7. class User implements GroupSequenceProviderInterface
    8. {
    9.     // ...
    11.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    12.     {
    13.         $metadata->setGroupSequenceProvider(true);
    14.         // ...
    15.     }
    16. }

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