Yaml

Дата оновлення перекладу 2025-01-15

Yaml

Валідує, що значення має валідний синтаксис YAML.

7.2

Обмеження Yaml було представлено в Symfony 7.2.

?????????????? ??	??????????? ??? ??????
????	Yaml
?????????	YamlValidator

Базове використання

Обмеження Yaml можна застосувати до властивості або методу "геттера":

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

use Symfony\Component\Validator\Constraints as Assert;

class Report
{
    #[Assert\Yaml(
        message: "Ваша конфігурація не містить валідного синтаксису YAML."
    )]
    private string $customConfiguration;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Report:
    properties:
        customConfiguration:
            - Yaml:
                message: Ваша конфігурація не містить валідного синтаксису YAML.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- 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\Report">
        <property name="customConfiguration">
            <constraint name="Yaml">
                <option name="message">Ваша конфігурація не містить валідного синтаксису YAML.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

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

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

class Report
{
    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('customConfiguration', new Assert\Yaml([
            'message' => 'Ваша конфігурація не містить валідного синтаксису YAML.',
        ]));
    }
}
    

Опції

`flags`

тип: integer за замовчуванням: 0

Ця опція вмикає необов'язкові функції синтаксичного аналізатора YAML при валідації змісту. Її значенням може бути комбінація одного або декількох
прапорців, визначених компонентом Yaml :

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

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

class Report
{
    #[Assert\Yaml(
        message: "Ваша конфігурація не містить валідного синтаксису YAML.",
        flags: Yaml::PARSE_CONSTANT | Yaml::PARSE_CUSTOM_TAGS | Yaml::PARSE_DATETIME,
    )]
    private string $customConfiguration;
}
    

????????	?????
`{{ error }}`	????? ???????????? ??? ??????? ??? ??????????? YAML
`{{ line }}`	?????, ? ????? ??????? ??????? ?????????? YAML

`groups`

тип: array | string за замовчуванням: null

Визначає групу або групи валідації обмеження. Прочитайте більше про групи валідації.

Дата оновлення перекладу 2025-01-15

`payload`

тип: mixed за замовчуванням: null

Ця опція може бути використана, щоб додати довільні дані, специфічні для домену, до обмеження. Сконфігуроване корисне навантаження не використовується компонентом Validator, але його обробка повністю залежить від вас.

Наприклад, ви можете захотіти використати декілька рівнів помилок, щоб представити неуспішні обмеження по-різному у фронтенді, залежно від серйозності помилки.