milo/hydrator

Hydrates object from array, exports object to array

v0.3.1 2020-12-03 12:30 UTC

This package is auto-updated.

Last update: 2021-01-08 09:46:47 UTC


README

Build Status

Usage

class Person
{
	/** @var string */
	public $name;

	public string $surname;

	public string|null $email;

	/** @var Address[] */
	public array $addresses;
}

class Address
{
	/** @var string */
	public $city;
}

$data = [
	'name' => 'Miloslav',
	'surname' => 'Hůla',
	'addresses' => [
		['city' => 'Prague'],
		['city' => 'Roztoky'],
	],
];


$backend = new Milo\Hydrator\Backend\PublicPropertiesBackend;
$hydrator = new Milo\Hydrator\Hydrator($backend);


/** @var Person $person  created from array */
$person = $hydrator->hydrate(Person::class, $data);

Personally, I'm using it for hydrate and export configuration written in NEON. Configuration stored in an array is fine, but when grows too much, it's hard to refactor. Working with type hinted objects in IDE is much more comfortable and less error prone.

Backend

There is only one backend for now.

PublicPropertiesBackend

It manipulates with public properties of class. It makes type check according a property type definition or @var annotation. Annotation type string has to be in a union format (e.g. int|string|null). Type checking is strict which means, integer cannot be cast to string or vice versa even it would be possible.

Implement Milo\Hydrator\IHydratorBackend for your own backend.

Caching

Implement ICache and use it with the backend. It saves resources associated with classes reflection and FQCN (Fully Qualified Class Name) resolving.

I'm using a simple cache class with Nette Caching. It looks like:

use Milo\Hydrator;
use Nette\Caching\Cache;
use Nette\Caching\Storage;


class HydratorCache implements Hydrator\Backend\ICache
{
	private Cache $cache;


	public function __construct(Storage $storage)
	{
		$this->cache = new Cache($storage, 'milo.hydrator');
	}


	public function save($key, $value, array $dependentFiles = null)
	{
		$dependencies = $dependentFiles
			? [Cache::FILES => $dependentFiles]
			: null;

		$this->cache->save($key, $value, $dependencies);
	}


	public function load($key)
	{
		return $this->cache->load($key);
	}
}

Installation

Use Composer: composer require milo/hydrator

TODO

  • improve error messages for deep structures because now are terrible
  • support more than one array dimension in Hydrator