stratadox / deserializer
Requires
- php: >=8.0
- ext-json: *
- stratadox/deserializer-contracts: ^0.3
- stratadox/hydrator: ^6.0.1
- stratadox/immutable-collection: ^2
- stratadox/instantiator: ^0.2
- stratadox/specification: ^1.0
Requires (Dev)
- fakerphp/faker: ^1.7
- php-coveralls/php-coveralls: ^2.0
- phpstan/phpstan: ^0.12.54
- phpunit/phpunit: ^8.2
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2024-10-08 18:22:41 UTC
README
Transforms serialized data into objects.
Installation
Install with composer require stratadox/deserializer
What is this?
An object that Deserializes
can convert serialized
data into objects.
The serialized
input data is expected to have the form of an array, either
numeric or associative.
This way, one can easily convert both the results of sql queries and decoded
json, as well as session data and other sources.
How to use this?
To write the contents of an associative array to an object, one can use:
<?php use Stratadox\Deserializer\ObjectDeserializer; $deserialize = ObjectDeserializer::forThe(Foo::class); $foo = $deserialize->from([ 'bar' => 'Bar.', 'baz' => 'BAZ!', ]); assert($foo instanceof Foo); assert('Bar.' === $foo->bar); assert('BAZ!' === $foo->getBaz());
For writing the contents of a numerically indexed array into a collection object, use:
<?php use Stratadox\Deserializer\CollectionDeserializer; $deserialize = CollectionDeserializer::forImmutable(Numbers::class); $numbers = $deserialize->from([10, 11, 12]); assert($numbers instanceof Numbers); assert(count($numbers) === 3); assert($numbers[0] === 10); assert($numbers[1] === 11); assert($numbers[2] === 12);
Or
<?php use Stratadox\Deserializer\CollectionDeserializer; $deserialize = CollectionDeserializer::forMutable(ArrayObject::class); $numbers = $deserialize->from([10, 11, 12]); assert($numbers instanceof ArrayObject); assert(count($numbers) === 3); assert($numbers[0] === 10); assert($numbers[1] === 11); assert($numbers[2] === 12);
In cases where no deserialization is needed, but a Deserializer is expected,
one can use the ArrayDeserializer
:
<?php use Stratadox\Deserializer\ArrayDeserializer; $deserialize = ArrayDeserializer::make(); $input = ['foo', 'bar']; $output = $deserialize->from($input); assert($input === $output);
What else can it do?
By default, the collection deserializer uses a CollectionHydrator
and the
object deserializer uses an ObjectHydrator
for simple objects, or a
ReflectiveHydrator
when inheritance is involved.
This default behaviour can be changed by injecting custom (potentially decorated) hydrators and instantiators:
<?php use Stratadox\Deserializer\ObjectDeserializer; use Stratadox\Instantiator\Instantiator; use Stratadox\Hydrator\ObjectHydrator; $deserialize = ObjectDeserializer::using( Instantiator::forThe(Foo::class), ObjectHydrator::default() );
In some cases, the input can vary in such a way that a different deserializer is required for different types of data.
For instance, when the input data represents an inheritance structure:
<?php use Stratadox\Deserializer\ForDataSets; use Stratadox\Deserializer\Condition\HaveTheDiscriminatorValue; use Stratadox\Deserializer\ObjectDeserializer; use Stratadox\Deserializer\OneOfThese; $deserialize = OneOfThese::deserializers( ForDataSets::that( HaveTheDiscriminatorValue::of('type', 'A'), ObjectDeserializer::forThe(ChildA::class) ), ForDataSets::that( HaveTheDiscriminatorValue::of('type', 'B'), ObjectDeserializer::forThe(ChildB::class) ) ); $a = $deserialize->from([ 'type' => 'A', 'property' => 'value', ]); $b = $deserialize->from([ 'type' => 'B', 'attribute' => 'different value', ]); assert($a instanceof ChildA); assert($b instanceof ChildB);
These features can be combined into more advanced deserialization structures, such as conditionally applied deserializers that are configured with mapped hydrators.