Traverse

Object properties are only validated if they are accessible, either by being public or having public accessor methods (e.g. a public getter). If your object needs to be traversed to validate its data, you can use this constraint.

オブジェクト プロパティは、パブリックであるか、パブリック アクセサー メソッド (パブリック ゲッターなど) を使用してアクセスできる場合にのみ検証されます。データを検証するためにオブジェクトをトラバースする必要がある場合は、この制約を使用できます。
Applies to class
Class Traverse

Basic Usage

In the following example, create two classes BookCollection and Book that all have constraints on their properties.

次の例では、BookCollection と Book の 2 つのクラスを作成します。これらはすべて、プロパティに制約があります。
  • Attributes
    属性
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
// src/Entity/BookCollection.php
namespace App\Entity;

use App\Entity\Book;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

#[ORM\Entity]
#[Assert\Traverse]
class BookCollection implements \IteratorAggregate
{
    /**
     * @var string
     */
    #[ORM\Column]
    #[Assert\NotBlank]
    protected $name = '';

    /**
     * @var Collection|Book[]
     */
    #[ORM\ManyToMany(targetEntity: Book::class)]
    protected $books;

    // some other properties

    public function __construct()
    {
        $this->books = new ArrayCollection();
    }

    // ... setter for name, adder and remover for books

    // the name can be validated by calling the getter
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @return \Generator|Book[] The books for a given author
     */
    public function getBooksForAuthor(Author $author): iterable
    {
        foreach ($this->books as $book) {
            if ($book->isAuthoredBy($author)) {
                yield $book;
            }
        }
    }

    // neither the method above nor any other specific getter
    // could be used to validated all nested books;
    // this object needs to be traversed to call the iterator
    public function getIterator()
    {
        return $this->books->getIterator();
    }
}

When the object implements \Traversable (like here with its child \IteratorAggregate), its traversal strategy will implicitly be set and the object will be iterated over without defining the constraint. It's mostly useful to add it to be explicit or to disable the traversal using the traverse option. If a public getter exists to return the inner books collection like getBooks(): Collection, the Valid constraint can be used on the $books property instead.

オブジェクトが \Traversable を実装する場合 (ここでは子\IteratorAggregate のように)、トラバーサル戦略が暗黙的に設定され、オブジェクトは制約を定義せずに反復処理されます。これを明示的に追加するか、トラバースを使用してトラバーサルを無効にすることが最も便利です。オプション。getBooks(): Collection のような内部の book コレクションを返す public getter が存在する場合、代わりに Valid 制約を $books プロパティで使用できます。

Options

The groups option is not available for this constraint.

グループ オプションは、この制約では使用できません。

traverse

type: boolean default: true

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

Instances of \Traversable are traversed by default, use this option to disable validating:

\Traversable のインスタンスはデフォルトでトラバースされます。このオプションを使用して検証を無効にします。
  • Attributes
    属性
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
12
 
// src/Entity/BookCollection.php

// ... same as above

/**
 * ...
 */
 #[Assert\Traverse(false)]
 class BookCollection implements \IteratorAggregate
 {
     // ...
 }

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.

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