Yaml

编辑此页

验证值是否具有有效的 YAML 语法。

7.2

Yaml 约束在 Symfony 7.2 中引入。

应用于 属性或方法
类 Yaml
验证器 YamlValidator

基本用法

Yaml 约束可以应用于属性或 “getter” 方法

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;
}

选项

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;
}

message

类型：string 默认值：此值不是有效的 YAML。

如果底层数据不是有效的 YAML 值，则显示此消息。

您可以在此消息中使用以下参数

参数 描述
{{ error }} 来自 YAML 解析器的完整错误消息
{{ line }} YAML 语法错误发生的行号

groups

类型：array | string 默认值：null

它定义此约束的验证组。阅读更多关于 验证组 的信息。

payload

类型：mixed 默认值：null

此选项可用于将任意特定于域的数据附加到约束。配置的 payload 不会被验证器组件使用，但其处理完全取决于您。

例如，您可能想要使用 多个错误级别，以便根据错误严重程度在前端以不同方式呈现失败的约束。

这项工作，包括代码示例，根据 Creative Commons BY-SA 3.0 许可获得许可。
目录
    版本