Final Class Yiisoft\Validator\DataSet\ObjectDataSet

A data set for object data. The object passed to this data set can provide rules and data by implementing {@see RulesProviderInterface} and {@see DataSetInterface}. Alternatively this data set allows getting rules from PHP attributes (attached to class properties and class itself) and data from object properties.

An example of object implementing {@see \Yiisoft\Validator\RulesProviderInterface}:

final class Author implements RulesProviderInterface
{
    public function getRules(): iterable
    {
        return ['age' => [new Number(min: 18)]];
    }
}

An example of object implementing {@see \Yiisoft\Validator\DataSetInterface}:

final class Author implements DataSetInterface
{
    public function getPropertyValue(string $property): mixed
    {
        return $this->getData()[$property] ?? null;
    }

    public function getData(): mixed
    {
        return ['name' => 'John', 'age' => 18];
    }

    public function hasProperty(string $property): bool
    {
        return array_key_exists($property, $this->getData());
    }
}

These two can be combined and used at the same time.

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 DTO 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();
$data = $parser->getData();

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()],
            ]),
        ]),
    ]);
];

And the result of $data will be:

[
    'title' => 'Yii3 Overview 3',
    'author' => 'John',
    'files' => [],
];

Note that the rule attributes can be combined with others without affecting parsing. Which properties to parse can be configured via {@see \Yiisoft\Validator\DataSet\ObjectDataSet::$propertyVisibility} and {@see \Yiisoft\Validator\DataSet\ObjectDataSet::$skipStaticProperties} options.

The other combinations of rules / data are also possible, for example: the data is provided by implementing {@see \Yiisoft\Validator\DataSetInterface} and rules are parsed from the attributes.

Please refer to the guide for more examples.

Rules and data provided via separate methods have a higher priority over attributes and properties, so, when used together, the latter ones will be ignored without exception.

When {@see \Yiisoft\Validator\RulesProviderInterface} / {@see \Yiisoft\Validator\DataSetInterface} are not implemented, uses {@see \Yiisoft\Validator\Helper\ObjectParser} and supports caching for data and attribute methods (partially) and rules (completely) which can be disabled on demand.

For getting only rules by a class name string or to be able to skip static properties, use {@see \Yiisoft\Validator\RulesProvider\AttributesRulesProvider} instead.