Yaml

Дата обновления перевода 2025-07-27

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: "Your configuration doesn't have valid YAML syntax."
    )]
    private string $customConfiguration;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Report:
    properties:
        customConfiguration:
            - Yaml:
                message: Your configuration doesn't have valid YAML syntax.
    

        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">Your configuration doesn't have valid YAML syntax.</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: 'Your configuration doesn\'t have valid YAML syntax.',
        ));
    }
}
    

Опции

`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: "Your configuration doesn't have valid YAML syntax.",
        flags: Yaml::PARSE_CONSTANT | Yaml::PARSE_CUSTOM_TAGS | Yaml::PARSE_DATETIME,
    )]
    private string $customConfiguration;
}
    

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

`groups`

тип: array | string по умолчанию: null

Определяет группу или группы валидации ограничений. Прочитайте больше о группах валидации.

Дата обновления перевода 2025-07-27

payload

тип: mixed по умолчанию: null

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

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