Locale ¶

Validates that a value is a valid locale.

値が有効なロケールであることを検証します。

The "value" for each locale is any of the ICU format locale IDs. For example, the two letter ISO 639-1 language code (e.g. fr), or the language code followed by an underscore (_) and the ISO 3166-1 alpha-2 country code (e.g. fr_FR for French/France).

各ロケールの「値」は、ICU 形式のロケール ID のいずれかです。たとえば、2 文字の ISO 639-1 言語コード (例: fr)、または言語コードの後にアンダースコア (_) と ISO 3166-1 alpha-2 国コード (例: フランス語/フランスの場合は fr_FR) が続きます。

The given locale values are canonicalized before validating them to avoid issues with wrong uppercase/lowercase values and to remove unneeded elements (e.g. FR-fr.utf8 will be validated as fr_FR).

指定されたロケール値は、大文字/小文字の値が間違っている問題を回避し、不要な要素を削除するために、検証する前に正規化されます (たとえば、FR-fr.utf8 は fr_FR として検証されます)。

Applies to	property or method
Class	Locale
Validator	LocaleValidator

Basic Usage ¶

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // src/Entity/User.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Assert\Locale(
        canonicalize: true,
    )]
    protected $locale;
}

    
                        # config/validator/validation.yaml
App\Entity\User:
    properties:
        locale:
            - Locale:
                canonicalize: true

    
                        <!-- 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\User">
        <property name="locale">
            <constraint name="Locale">
                <option name="canonicalize">true</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

    
                        // 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)
    {
        $metadata->addPropertyConstraint('locale', new Assert\Locale([
            'canonicalize' => true,
        ]));
    }
}

Note

ノート

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

他のほとんどの制約と同様に、null および空の文字列は有効な値と見なされます。これは、それらをオプションの値にできるようにするためです。値が必須の場合、一般的な解決策は、この制約と NotBlank を組み合わせることです。

Options ¶

`groups` ¶

type: array | string

タイプ: 配列 |ストリング

It defines the validation group or groups of this constraint. Read more about validation groups.

この制約の検証グループを定義します。検証グループの詳細を参照してください。

`message` ¶

type: string default: This value is not a valid locale.

タイプ: 文字列デフォルト: この値は有効なロケールではありません。

This message is shown if the string is not a valid locale.

このメッセージは、文字列が有効なロケールでない場合に表示されます。

You can use the following parameters in this message:

このメッセージでは、次のパラメーターを使用できます。

Parameter	Description
`{{ value }}`	The current (invalid) value
`{{ label }}`	Corresponding form field label

`payload` ¶

type: mixed default: null

タイプ: 混合デフォルト: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

このオプションは、任意のドメイン固有のデータを制約に添付するために使用できます。構成されたペイロードは Validator コンポーネントによって使用されませんが、その処理は完全にユーザー次第です。

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

たとえば、いくつかのエラーレベルを使用して、エラーの重大度に応じて、失敗した制約をフロントエンドで異なる方法で提示することができます。

Locale ¶

Basic Usage ¶

Options ¶

groups ¶

message ¶

payload ¶

`groups` ¶

`message` ¶

`payload` ¶