Awesome

The best PHP mapper you've ever seen =)

You can see some examples here:

• 01.normalization
  • 01.object-normalization
  • 02.date-normalization
  • 03.date-format-normalization
  • 04.untyped-object-normalization
  • 05.typed-object-normalization
  • 06.inherited-types-normalization
  • 07.collection-types-normalization
  • 08.object-output-normalization
• 02.errors
  • 01.custom-type-printer
  • 02.extended-type-printer
  • 03.custom-path-printer
  • 04.custom-value-printer
• 03.types
  • 01.type-platforms
  • 02.custom-type
  • 03.custom-type-template-arguments
  • 04.custom-platform
  • 05.custom-type-callable
  • 06.custom-type-psr-container
• 04.mapping
  • 01.reflection-mapping
  • 02.attribute-mapping
  • 03.driver-inheritance-mapping
  • 04.phpdoc-mapping
  • 05.phpdoc-custom-tags-mapping
  • 06.cache

Full documentation in progress...

Installation

Mapper package is available as Composer repository and can be installed using the following command in a root of your project:

composer require type-lang/mapper

Quick Start

use TypeLang\Mapper\Mapping\MapType;

class ExampleObject
{
    public function __construct(
        #[MapType('list<non-empty-string>')]
        public readonly array $names,
    ) {}
}

$mapper = new \TypeLang\Mapper\Mapper();

$result = $mapper->normalize(
    new ExampleObject(['Example'])
);
// Expected Result:
//
// array:1 [
//   "names" => array:1 [
//     0 => "Example"
//   ]
// ]


$result = $mapper->denormalize([
    'names' => ['first', 'second']
], ExampleObject::class);
// Expected Result:
//
// ExampleObject {#324
//   +names: array:2 [
//     0 => "first"
//     1 => "second"
//   ]
// }


$result = $mapper->denormalize([
    'names' => ['first', 'second', ''],
], ExampleObject::class);
// Expected Result:
//
// InvalidFieldTypeValueException: Passed value of field "names" must be of type
//   list<non-empty-string>, but array(3)["first", "second", ""] given at $.names[2]

Benchmarks

Results here like this.

Sample: An object that contains a collection of objects, which contains another collection of objects.

ExampleObject
{
    name: string,
        items
:
    list<ExampleObject>
}

The results are sorted by mode time.

Denormalization

Denormalization: Transformation from raw payload (array) to concrete object.

Denormalization + Cache

Normalization

Normalization: Transformation from object to raw payload (array).

Normalization + Cache