Как применить только подмножество всех ваших ограничений валидации (группы валидации)

По умолчанию, при валидации объекта, все ограничения этого класса будут проверены на предмет того, действительно ли они подойдут. Однако, в некоторых случаях, вам понадобится валидировать объект только по отношению к некоторым ограничениям этого класса. Чтобы сделать это, вы можете организовать каждое ограничение в одну или более "групп валидации", а потом применить валидацию только к одной группе ограничений.

Например, представьте, что у вас есть класс 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 $email;

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

    #[Assert\Length(min: 2)]
    private $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)
    {
        $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

Содержит ограничения в текущем классе и все упомянутые классы, которые не принадлежат ни к одной другой группе. В этом примере, она содержит только поле city.

User

Эквивалентна всем ограничениям объекта User в группе Default. Это всегда является именем класса. Разица между этой группой и Default объясняется в Как применять группы валидации последовательно.

registration

Это пользовательская группа валидации, поэтому она содержит только ограничения, четко ассоциированные с ней. В этом пимере - только поля email и password.

Ограничения в группе класса Default - это ограничения, которые либо не имеют явной сконфигурированной группы, или которые сконфигурированы в группу, равную имени класса или строке Default.

Чтобы сообщить валидатору об использовании конкретной группы, передайте одно или более имён групп в качестве третьего аргумента метода validate():

1

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

Если не указана ни одна группа, будут применены все ограничения, принадлежащие группе Default

Конечно же, вы чаще будете работать с валидацией не напрямую, а через библиотеку форм. Для информации о том, как использовать группы валидации внутри форм, смотрите Как определить, какие группы валидации использовать.