guennichi/mapper

A lightweight library to map array data to PHP immutable objects

2.1.2 2024-01-15 13:00 UTC

Requires

• php: ^8.1
• phpdocumentor/reflection-docblock: ^5.3
• phpdocumentor/type-resolver: ^1.6
• symfony/filesystem: >=5.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• phpbench/phpbench: ^1.2
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^10
• symfony/property-access: ^6.2
• symfony/property-info: ^6.2
• symfony/serializer: ^6.2
• symfony/var-dumper: ^6.2

MIT

• Radhi Guennichi

README

A lightweight library to map array data into PHP immutable objects, collections and strongly typed arrays via constructors.

Benchmark

Check benchmark/ directory for more details about the implementation.

Benchmark	Revs	Its	mem_peak	Mode	rstdev
unserialize()	5000	5	1.724mb	9.547μs	±1.51%
symfony/serializer	5000	5	3.489mb	122.343μs	±0.84%
guennichi/mapper	5000	5	2.972mb	16.638μs	±0.41%

Installation

composer require guennichi/mapper

Usage

use Guennichi\Collection\Collection;

final class Person
{
    public function __construct(public readonly string $name) {}
}

/**
 * @extends Collection<Person>
 */
final class PersonCollection extends Collection
{
    public function __construct(Person ...$elements)
    {
        parent::__construct(...$elements);
    }
}

$input = [
    ['name' => 'Person1'],
    ['name' => 'Person2'],
    ['name' => 'Person3'],
];

$mapper = new Guennichi\Mapper\Mapper(/** dependencies */)

$output = $mapper->map($input, PersonCollection::class);
// Result instance of PersonCollection(Person{"name": "Person1"}, Person{"name": "Person2"}, Person{"name": "Person3"})

Dedication

Special thanks to my colleague @Gabriel Ostrolucký for his support and advices to make this happen.