UUID ¶

Validates that a value is a valid Universally unique identifier (UUID) per RFC 4122. By default, this will validate the format according to the RFC's guidelines, but this can be relaxed to accept non-standard UUIDs that other systems (like PostgreSQL) accept. UUID versions can also be restricted using a list of allowed versions.

値が RFC 4122 に従って有効な汎用一意識別子 (UUID) であることを検証します。デフォルトでは、これは RFC のガイドラインに従って形式を検証しますが、これを緩和して、他のシステム (PostgreSQL など) が受け入れる非標準の UUID を受け入れることができます。 UUID バージョンは、許可されたバージョンのリストを使用して制限することもできます。

Applies to	property or method
Class	Uuid
Validator	UuidValidator

Basic Usage ¶

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

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

use Symfony\Component\Validator\Constraints as Assert;

class File
{
    #[Assert\Uuid]
    protected $identifier;
}

    
                        # config/validator/validation.yaml
App\Entity\File:
    properties:
        identifier:
            - Uuid: ~

    
                        <!-- 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\File">
        <property name="identifier">
            <constraint name="Uuid"/>
        </property>
    </class>
</constraint-mapping>

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

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class File
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('identifier', new Assert\Uuid());
    }
}

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 is not a valid UUID.

タイプ: 文字列デフォルト: これは有効な UUID ではありません。

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

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

You can use the following parameters in this message:

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

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

`normalizer` ¶

type: a PHP callable default: null

タイプ: PHP 呼び出し可能デフォルト: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

このオプションを使用すると、有効かどうかを確認する前に、指定された値に適用される PHP 呼び出し可能オブジェクトを定義できます。

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

たとえば、検証中に先頭と末尾の空白を無視するために、trim PHP 関数を適用するために「trim」文字列を渡すことができます。

`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.

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

`strict` ¶

type: boolean default: true

タイプ: ブールデフォルト: true

If this option is set to true the constraint will check if the UUID is formatted per the RFC's input format rules: 216fff40-98d9-11e3-a5e2-0800200c9a66. Setting this to false will allow alternate input formats like:

このオプションが true に設定されている場合、制約は UUID が RFC の入力フォーマット規則 (216fff40-98d9-11e3-a5e2-0800200c9a66) に従ってフォーマットされているかどうかをチェックします。これを false に設定すると、次のような代替入力形式が許可されます。

216f-ff40-98d9-11e3-a5e2-0800-200c-9a66
216f-ff40-98d9-11e3-a5e2-0800-200c-9a66
{216fff40-98d9-11e3-a5e2-0800200c9a66}
{216fff40-98d9-11e3-a5e2-0800200c9a66}
216fff4098d911e3a5e20800200c9a66
216fff4098d911e3a5e20800200c9a66

`versions` ¶

type: int[] default: [1,2,3,4,5,6,7,8]

タイプ: int[] デフォルト: [1,2,3,4,5,6,7,8]

This option can be used to only allow specific UUID versions (by default, all of them are allowed). Valid versions are 1 - 8. Instead of using numeric values, you can also use the following PHP constants to refer to each UUID version:

このオプションは、特定の UUID バージョンのみを許可するために使用できます (デフォルトでは、それらすべてが許可されます)。有効なバージョンは 1 ～ 8 です。数値を使用する代わりに、次の PHP 定数を使用して各 UUID バージョンを参照することもできます。

Uuid::V1_MAC
Uuid::V1_MAC
Uuid::V2_DCE
Uuid::V2_DCE
Uuid::V3_MD5
Uuid::V3_MD5
Uuid::V4_RANDOM
Uuid::V4_RANDOM
Uuid::V5_SHA1
Uuid::V5_SHA1
Uuid::V6_SORTABLE
Uuid::V6_SORTABLE
Uuid::V7_MONOTONIC
Uuid::V7_MONOTONIC
Uuid::V8_CUSTOM
Uuid::V8_CUSTOM

6.2

UUID versions 7 and 8 were introduced in Symfony 6.2.

UUID バージョン 7 と 8 は Symfony 6.2 で導入されました。

UUID ¶

Basic Usage ¶

Options ¶

groups ¶

message ¶

normalizer ¶

payload ¶

strict ¶

versions ¶