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

此選項可用於將任意特定領域的資料附加到約束條件。Validator 組件不使用已設定的 payload，但其處理完全取決於您。

例如，您可能想要使用多個錯誤層級，以便根據錯誤的嚴重性，在前台以不同方式呈現失敗的約束條件。

本作品，包括程式碼範例，根據 Creative Commons BY-SA 3.0 授權條款發布。
目錄
    版本