Як застосувати лише підмножину усіх ваших обмежень валідації (групи валідації)

За замовчуванням, при валідації обʼєкта, всі обмеження цього класу будуть перевірені на предмет того, чи дійсно вони підійдуть. Однак, у деяких випадках, вам знадобиться валідувати обʼєкт лише по відношенню до деяких обмежень цього класу. Щоб зробити це, ви можете організувати кожне обмеження в одну та більше "груп валідації", а потім застосувати валідацію лише до однієї групи обмежень.

Наприклад, уявіть, що у вас є клас User, який використовується як при реєстрації користувача, так і при оновленні контактної інформації пізніше:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

// src/Entity/User.php
namespace App\Entity;

use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Validator\Constraints as Assert;

class User implements UserInterface
{
    #[Assert\Email(groups: ['registration'])]
    private string $email;

    #[Assert\NotBlank(groups: ['registration'])]
    #[Assert\Length(min: 7, groups: ['registration'])]
    private string $password;

    #[Assert\Length(min: 2)]
    private string $city;
}

1
2
3
4
5
6
7
8
9
10
11

# config/validator/validation.yaml
App\Entity\User:
    properties:
        email:
            - Email: { groups: [registration] }
        password:
            - NotBlank: { groups: [registration] }
            - Length: { min: 7, groups: [registration] }
        city:
            - Length:
                min: 2

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

<!-- 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="email">
            <constraint name="Email">
                <option name="groups">
                    <value>registration</value>
                </option>
            </constraint>
        </property>

        <property name="password">
            <constraint name="NotBlank">
                <option name="groups">
                    <value>registration</value>
                </option>
            </constraint>
            <constraint name="Length">
                <option name="min">7</option>
                <option name="groups">
                    <value>registration</value>
                </option>
            </constraint>
        </property>

        <property name="city">
            <constraint name="Length">
                <option name="min">2</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// src/Entity/User.php
namespace App\Entity;

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

class User
{
    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('email', new Assert\Email(
            groups: ['registration'],
        ));

        $metadata->addPropertyConstraint('password', new Assert\NotBlank(
            groups: ['registration'],
        ));
        $metadata->addPropertyConstraint('password', new Assert\Length(
            min: 7,
            groups: ['registration'],
        ));

        $metadata->addPropertyConstraint('city', new Assert\Length(
            min: 2,
        ));
    }
}

У такій конфігурації існує три групи валідації:

Default

Містить обмеження у поточному класі і всі згадані класи, які не належать до жодної групи.

User

Еквівалентна усім обмеженням обʼєкта User в групі Default. Це завжди є іменем класу. Різниця між цією групою і Default пояснюється у Як послідовно застосовувати групи валідації.

registration

Це користувацька група валідації, тому вона містить лише обмеження, які чітко асційовані з нею. У цьому прикладі, лише поля email та password.

Обмеження у групі класу Default - це обмеження, які або не мають чітко сконфігурованої групи, або які сконфігуровані у групу, що дорівнює іменя класу або рядку Default.

Щоб повідомити валідатору про використання конкретної групи, передайте одне або більше імен груп в якості третього аргументу методу validate():

1

$errors = $validator->validate($author, null, ['registration']);

Якщо не вказана жодна група, будуть застосовані всі обмеження, які належать до групи Default

Авжеж, ви частіше працюватимете з валідацією не напряму, а через бібліотеку форм. Для інформації про те, як використовувати групи валідації всередині форм, дивіться Як визначити, які групи валідації використовувати.