Expression ¶

This constraint allows you to use an expression for more complex, dynamic validation. See Basic Usage for an example. See Callback for a different constraint that gives you similar flexibility.

この制約により、式を使用して、より複雑で動的な検証を行うことができます。例については、基本的な使用法を参照してください。同様の柔軟性を提供する別の制約については、コールバックを参照してください。

Applies to	class or property/method
Class	Expression
Validator	ExpressionValidator

Basic Usage ¶

Imagine you have a class BlogPost with category and isTechnicalPost properties:

カテゴリと isTechnicalPost プロパティを持つクラス BlogPost があるとします。

    
                        // src/Model/BlogPost.php
namespace App\Model;

use Symfony\Component\Validator\Constraints as Assert;

class BlogPost
{
    private $category;

    private $isTechnicalPost;

    // ...

    public function getCategory()
    {
        return $this->category;
    }

    public function setIsTechnicalPost($isTechnicalPost)
    {
        $this->isTechnicalPost = $isTechnicalPost;
    }

    // ...
}

To validate the object, you have some special requirements:

オブジェクトを検証するには、いくつかの特別な要件があります。

A) If isTechnicalPost is true, then category must be either php: or symfony;
またはsymfony;

B) If isTechnicalPost is false, then category can be anything.

B) isTechnicalPost が false の場合、カテゴリは何でもかまいません。

One way to accomplish this is with the Expression constraint:

これを実現する 1 つの方法は、Expression コンストレインを使用することです。

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // src/Model/BlogPost.php
namespace App\Model;

use Symfony\Component\Validator\Constraints as Assert;

#[Assert\Expression(
    "this.getCategory() in ['php', 'symfony'] or !this.isTechnicalPost()",
    message: 'If this is a tech post, the category should be either php or symfony!',
)]
class BlogPost
{
    // ...
}

    
                        # config/validator/validation.yaml
App\Model\BlogPost:
    constraints:
        - Expression:
            expression: "this.getCategory() in ['php', 'symfony'] or !this.isTechnicalPost()"
            message: "If this is a tech post, the category should be either php or symfony!"

    
        
                
                
                        <!-- 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\Model\BlogPost">
        <constraint name="Expression">
            <option name="expression">
                this.getCategory() in ['php', 'symfony'] or !this.isTechnicalPost()
            </option>
            <option name="message">
                If this is a tech post, the category should be either php or symfony!
            </option>
        </constraint>
    </class>
</constraint-mapping>
                    

            

    

    
                        // src/Model/BlogPost.php
namespace App\Model;

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

class BlogPost
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addConstraint(new Assert\Expression([
            'expression' => 'this.getCategory() in ["php", "symfony"] or !this.isTechnicalPost()',
            'message' => 'If this is a tech post, the category should be either php or symfony!',
        ]));
    }

    // ...
}

The expression option is the expression that must return true in order for validation to pass. To learn more about the expression language syntax, see The Expression Syntax.

式オプションは、検証に合格するために true を返さなければならない式です。式言語の構文の詳細については、式の構文を参照してください。

Alternatively, you can set the negate option to false in order to assert that the expression must return true for validation to fail.

または、否定オプションを false に設定して、検証が失敗するために式が true を返す必要があることをアサートすることもできます。

6.2

The negate option was introduced in Symfony 6.2.

negate オプションは Symfony 6.2 で導入されました。

エラーを特定のフィールドにマッピングする

You can also attach the constraint to a specific property and still validate based on the values of the entire entity. This is handy if you want to attach the error to a specific field. In this context, value represents the value of isTechnicalPost.

制約を特定のプロパティにアタッチして、エンティティ全体の値に基づいて検証することもできます。これは、特定のフィールドにエラーを添付する場合に便利です。このコンテキストでは、value は isTechnicalPost の値を表します。

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // src/Model/BlogPost.php
namespace App\Model;

use Symfony\Component\Validator\Constraints as Assert;

class BlogPost
{
    // ...

    #[Assert\Expression(
        "this.getCategory() in ['php', 'symfony'] or value == false",
        message: 'If this is a tech post, the category should be either php or symfony!',
    )]
    private $isTechnicalPost;

    // ...
}

    
                        # config/validator/validation.yaml
App\Model\BlogPost:
    properties:
        isTechnicalPost:
            - Expression:
                expression: "this.getCategory() in ['php', 'symfony'] or value == false"
                message: "If this is a tech post, the category should be either php or symfony!"

    
        
                
                
                        <!-- 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\Model\BlogPost">
        <property name="isTechnicalPost">
            <constraint name="Expression">
                <option name="expression">
                    this.getCategory() in ['php', 'symfony'] or value == false
                </option>
                <option name="message">
                    If this is a tech post, the category should be either php or symfony!
                </option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
                    

            

    

    
                        // src/Model/BlogPost.php
namespace App\Model;

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

class BlogPost
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('isTechnicalPost', new Assert\Expression([
            'expression' => 'this.getCategory() in ["php", "symfony"] or value == false',
            'message' => 'If this is a tech post, the category should be either php or symfony!',
        ]));
    }

    // ...
}

For more information about the expression and what variables are available to you, see the expression option details below.

式と使用できる変数の詳細については、以下の式オプションの詳細を参照してください。

Options ¶

`expression` ¶

type: string [default option]

タイプ: 文字列 [デフォルトオプション]

The expression that will be evaluated. If the expression evaluates to a false value (using ==, not ===), validation will fail.

評価される式。式が false と評価された場合 (=== ではなく == を使用)、検証は失敗します。

To learn more about the expression language syntax, see The Expression Syntax.

式言語の構文の詳細については、式の構文を参照してください。

Inside of the expression, you have access to up to 2 variables:

式の内部では、最大 2 つの変数にアクセスできます。

Depending on how you use the constraint, you have access to 1 or 2 variables in your expression:

制約の使用方法に応じて、式で 1 つまたは 2 つの変数にアクセスできます。

this: The object being validated (e.g. an instance of BlogPost);
this: 検証されるオブジェクト (BlogPost のインスタンスなど)。
value: The value of the property being validated (only available when the constraint is applied directly to a property);
value: 検証されるプロパティの値 (制約がプロパティに直接適用されている場合にのみ使用可能)。

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

タイプ: 文字列デフォルト: この値は無効です。

The default message supplied when the expression evaluates to false.

式が false と評価されたときに提供されるデフォルトのメッセージ。

You can use the following parameters in this message:

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

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

`negate` ¶

type: boolean default: true

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

If false, the validation fails when expression returns true.

false の場合、expression が true を返すと、検証は失敗します。

6.2

The negate option was introduced in Symfony 6.2.

negate オプションは Symfony 6.2 で導入されました。

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

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

`values` ¶

type: array default: []

タイプ: 配列デフォルト: []

The values of the custom variables used in the expression. Values can be of any type (numeric, boolean, strings, null, etc.)

式で使用されるカスタム変数の値。値は任意の型 (数値、ブール値、文字列、null など) にすることができます。

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // src/Model/Analysis.php
namespace App\Model;

use Symfony\Component\Validator\Constraints as Assert;

class Analysis
{
    #[Assert\Expression(
        'value + error_margin < threshold',
        values: ['error_margin' => 0.25, 'threshold' => 1.5],
    )]
    private $metric;

    // ...
}

    
                        # config/validator/validation.yaml
App\Model\Analysis:
    properties:
        metric:
            - Expression:
                expression: "value + error_margin < threshold"
                values:     { error_margin: 0.25, threshold: 1.5 }

    
        
                
                
                        <!-- 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\Model\Analysis">
        <property name="metric">
            <constraint name="Expression">
                <option name="expression">
                    value + error_margin &lt; threshold
                </option>
                <option name="values">
                    <value key="error_margin">0.25</value>
                    <value key="threshold">1.5</value>
                </option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
                    

            

    

    
                        // src/Model/Analysis.php
namespace App\Model;

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

class Analysis
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('metric', new Assert\Expression([
            'expression' => 'value + error_margin < threshold',
            'values' => ['error_margin' => 0.25, 'threshold' => 1.5],
        ]));
    }

    // ...
}

Expression ¶

Basic Usage ¶

Options ¶

expression ¶

groups ¶

message ¶

negate ¶

payload ¶

values ¶

`expression` ¶

`groups` ¶

`message` ¶

`negate` ¶

`payload` ¶

`values` ¶