IsTrue

Validates that a value is true. Specifically, this checks if the value is exactly true, exactly the integer 1, or exactly the string '1'.

値が true であることを検証します。具体的には、値が正確に true か、正確に整数 1 か、正確に文字列 '1' かをチェックします。

Also see IsFalse.

IsFalse も参照してください。
Applies to property or method
Class IsTrue
Validator IsTrueValidator

Basic Usage

This constraint can be applied to properties (e.g. a termsAccepted property on a registration model) and methods. It's most powerful in the latter case, where you can assert that a method returns a true value. For example, suppose you have the following method:

この制約は、プロパティ (登録モデルの termsAccepted プロパティなど) とメソッドに適用できます。メソッドが真の値を返すことをアサートできる後者のケースで最も強力です。たとえば、次のメソッドがあるとします。
1
2
3
4
5
6
7
8
9
10
11
12
 
// src/Entity/Author.php
namespace App\Entity;

class Author
{
    protected $token;

    public function isTokenValid()
    {
        return $this->token == $this->generateToken();
    }
}

Then you can validate this method with IsTrue as follows:

次に、次のように IsTrue を使用してこのメ​​ソッドを検証できます。
  • Attributes
    属性
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    protected $token;

    #[Assert\IsTrue(message: 'The token is invalid.')]
    public function isTokenValid()
    {
        return $this->token == $this->generateToken();
    }
}

If the isTokenValid() returns false, the validation will fail.

isTokenValid() が false を返す場合、検証は失敗します。

Note

ノート

As with most of the other constraints, null is considered a valid value. This is to allow the use of optional values. If the value is mandatory, a common solution is to combine this constraint with NotNull.

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

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 should be true.

タイプ: 文字列 デフォルト: この値は true にする必要があります。

This message is shown if the underlying data is not true.

このメッセージは、基になるデータが正しくない場合に表示されます。

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.

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