yiisoft/hydrator

Create and populate objects with type casting, mapping and dependencies resolving support.

1.1.0 2024-02-09 07:47 UTC

This package is auto-updated.

Last update: 2024-02-16 12:52:15 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Hydrator


Latest Stable Version Total Downloads Build status Code Coverage Mutation testing badge static analysis type-coverage psalm-level

The package provides a way to create and hydrate objects from a set of raw data.

Features are:

  • supports properties of any visibility;
  • uses constructor arguments to create objects;
  • resolves dependencies when creating objects using PSR-11 compatible DI container provided;
  • supports nested objects;
  • supports mapping;
  • allows fine-tuning hydration via PHP attributes.

Requirements

  • PHP 8.0 or higher.

Installation

The package could be installed with composer:

composer require yiisoft/hydrator

General usage

To hydrate existing object:

use Yiisoft\Hydrator\Hydrator;

$hydrator = new Hydrator();
$hydrator->hydrate($object, $data);

To create a new object and fill it with the data:

use Yiisoft\Hydrator\Hydrator;

$hydrator = new Hydrator();
$object = $hydrator->create(MyClass::class, $data);

To pass arguments to the constructor of a nested object, use nested array or dot-notation:

final class Engine
{
    public function __construct(
        private string $name,
    ) {}
}

final class Car
{
    public function __construct(
        private string $name,
        private Engine $engine,
    ) {}
}

// nested array
$object = $hydrator->create(Car::class, [
    'name' => 'Ferrari',
    'engine' => [
        'name' => 'V8',
    ]
]);

// or dot-notation
$object = $hydrator->create(Car::class, [
    'name' => 'Ferrari',
    'engine.name' => 'V8',
]);

That would pass the name constructor argument of the Car object and create a new Engine object for engine argument passing V8 as the name argument to its constructor.

Documentation

License

The Yii Hydrator is free software. It's released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack