Як обробляти різні рівні помилок

Дата оновлення перекладу 2022-12-23

Як обробляти різні рівні помилок

Іноді вам може захотітися відобразити повідомлення про помилки обмежень валідації по-різному, засновуючись на деяких правилах. Наприклад, у вас є форма рєстрації для нових користувачів, де вони вводять деяку особисту інформацію та обирають свої атестати аутентифікації. Їм потрібно буде обрати імʼя користувача та безпечний пароль, але надваання інформації про банківський рахунок буде не обовʼязковим. Незважаючи на це, ви хочете переконатися, що ці необовʼязкові поля, якщо будуть заповнені, будуть валідні, але щоб помилки у них відбражалися по-іншому.

Процес досягнення такої поведінки складається з двох кроків:

Застосуйте різні рівні помилок до обмежень валідації;
Персоналізуйте ваші повідомлення про помилки, в залежності від рівня сконфігурованої помилки.

1. Призначення рівня помилки

Використайте оцію payload, щоб сконфігурувати рівень помилки для кожного обмеження:

Attributes
YAML
XML
PHP

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

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Assert\NotBlank(payload: ['severity' => 'error'])]
    protected $username;

    #[Assert\NotBlank(payload: ['severity' => 'error'])]
    protected $password;

    #[Assert\Iban(payload: ['severity' => 'warning'])]
    protected $bankAccountNumber;
}
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        # config/validator/validation.yaml
App\Entity\User:
    properties:
        username:
            - NotBlank:
                payload:
                    severity: error
        password:
            - NotBlank:
                payload:
                    severity: error
        bankAccountNumber:
            - Iban:
                payload:
                    severity: warning
    

        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
        <!-- 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="username">
            <constraint name="NotBlank">
                <option name="payload">
                    <value key="severity">error</value>
                </option>
            </constraint>
        </property>
        <property name="password">
            <constraint name="NotBlank">
                <option name="payload">
                    <value key="severity">error</value>
                </option>
            </constraint>
        </property>
        <property name="bankAccountNumber">
            <constraint name="Iban">
                <option name="payload">
                    <value key="severity">warning</value>
                </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
        // 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('username', new Assert\NotBlank([
            'payload' => ['severity' => 'error'],
        ]));
        $metadata->addPropertyConstraint('password', new Assert\NotBlank([
            'payload' => ['severity' => 'error'],
        ]));
        $metadata->addPropertyConstraint('bankAccountNumber', new Assert\Iban([
            'payload' => ['severity' => 'warning'],
        ]));
    }
}
    

2. Персоналізація шаблону повідомлення про помилку

Коли валідація обʼєкта User буде невдалою, ви можете повернути обмеження, яке викликало певну помилку, використовуючи метод getConstraint(). Кожне обмеження демонструє прикріплене корисне навантаження, як публічну властивість:

        1
2
3
4
5
        // невдача валідації обмеження, екземпляр
// Symfony\Component\Validator\ConstraintViolation
$constraintViolation = ...;
$constraint = $constraintViolation->getConstraint();
$severity = $constraint->payload['severity'] ?? null;
    

Наприклад, ви можете використати це, щоб налаштувати блок form_errors так, щоб значимість була додана як додатковий HTML-клас:

        1
2
3
4
5
6
7
8
9
        {%- block form_errors -%}
    {%- if errors|length > 0 -%}
    <ul>
        {%- for error in errors -%}
            <li class="{{ error.cause.constraint.payload.severity ?? '' }}">{{ error.message }}</li>
        {%- endfor -%}
    </ul>
    {%- endif -%}
{%- endblock form_errors -%}
    