Final Class Yiisoft\Validator\RulesProvider\AttributesRulesProvider

A rules provider that extracts rules from PHP attributes (attached to class properties and class itself). The attributes introduced in PHP 8 simplify rules' configuration process, especially for nested data and relations. This way the validated structures can be presented as DTO classes with references to each other.

An example of object with both one-to-one (requires PHP > 8.0) and one-to-many (requires PHP > 8.1) relations:

final class Post
{
    #[Length(max: 255)]
    public string $title = '';

    #[Nested]
    public Author|null $author = null;

    // Passing instances is available only since PHP 8.1.
    #[Each(new Nested(File::class))]
    public array $files = [];

    public function __construct()
    {
        $this->author = new Author();
    }
}

final class Author
{
    #[Length(min: 1)]
    public string $name = '';
}

// Some rules, like "Nested" can be also configured through the class attribute.

#[Nested(['url' => new Url()])]
final class File
{
    public string $url = '';
}

$post = new Post(title: 'Yii3 Overview 3', author: 'Dmitriy');
$parser = new ObjectParser($post);
$rules = $parser->getRules();

The $rules will contain:

[
    new Nested([
        'title' => [new Length(max: 255)],
        'author' => new Nested([
            'name' => [new Length(min: 1)],
        ]),
        'files' => new Each(new Nested([
            'url' => [new Url()],
        ])),
    ]);
];

A class name string is valid as a source too:

$parser = new ObjectParser(Post::class);
$rules = $parser->getRules(); // The result is the same as in previous example.

Please refer to the guide for more examples.

Note that the rule attributes can be combined with others without affecting parsing. Which properties to parse can be configured via $propertyVisibility and $skipStaticProperties constructor arguments.

Uses {@see \Yiisoft\Validator\Helper\ObjectParser} and supports caching.

If you want to additionally extract data or to be able to disable cache, use {@see \Yiisoft\Validator\DataSet\ObjectDataSet} or {@see \Yiisoft\Validator\Helper\ObjectParser} directly instead.