語言

編輯此頁面

驗證值是否為有效的語言Unicode 語言識別碼 (例如 fr 或 zh-Hant)。

適用於	屬性或方法
類別	語言
驗證器	LanguageValidator

基本用法

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

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Assert\Language]
    protected string $preferredLanguage;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\User:
    properties:
        preferredLanguage:
            - Language: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="https://symfony.dev.org.tw/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://symfony.dev.org.tw/schema/dic/constraint-mapping https://symfony.dev.org.tw/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\User">
        <property name="preferredLanguage">
            <constraint name="Language"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // 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): void
    {
        $metadata->addPropertyConstraint('preferredLanguage', new Assert\Language());
    }
}
    

注意

與大多數其他約束條件一樣，null 和空字串被視為有效值。這是為了允許它們成為可選值。如果該值是強制性的，一個常見的解決方案是將此約束條件與 NotBlank 結合使用。

選項

alpha3

類型: boolean 預設: false

如果此選項為 true，則約束條件會檢查該值是否為 ISO 639-2 (2T) 三字母代碼 (例如，法語 = fra)，而不是預設的 ISO 639-1 雙字母代碼 (例如，法語 = fr)。

`群組`

類型: array | string 預設: null

它定義此約束條件的驗證群組。閱讀更多關於驗證群組的資訊。

`訊息`

類型: string 預設: 此值不是有效的語言。

如果字串不是有效的語言代碼，則會顯示此訊息。

您可以在此訊息中使用以下參數

參數	描述
`{{ value }}`	目前的 (無效) 值
`{{ label }}`	對應的表單欄位標籤

`酬載`

類型: mixed 預設: null

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

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

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

版本