README

rekalogika/mapper is an object mapper for PHP and Symfony, also commonly known as an automapper. It maps an object to another object. Primarily used to map an entity to a DTO, but also useful for other mapping purposes. It removes the complexity of mapping an object to another object, and even an object graph to another object graph.

Full documentation is available at rekalogika.dev/mapper.

Installation

composer require rekalogika/mapper

Usage

use App\Entity\Book;
use Rekalogika\Mapper\MapperInterface;

// map a single object:

/** @var MapperInterface $mapper */
/** @var Book $book */

$result = $mapper->map($book, BookDto::class);

// map a single object to an existing object:

$bookDto = new BookDto();
$mapper->map($book, $bookDto);

// map an iterable of objects:

/** @var IterableMapperInterface $iterableMapper */
/** @var iterable<Book> $books */

$bookDtos = $iterableMapper->mapIterable($books, BookDto::class);

Why Use a Mapper?

Why do we need to use a mapper to save a few keystrokes, and not just use something simple like this?

class BookDto
{
    public static function create(Book $book): self
    {
        $dto = new self();
        // ...

        return $dto;
    }
}

Everyone must have that idea at some point. However, as the project grows, the target classes (DTOs) may start to reference each other, and become a rich object graph. Your code will start to have many special cases, and is no longer as simple as you thought it would be. It becomes harder to maintain, and then eventually forces you to sit back and try to resolve the problem. When (if?) you successfully engineer a solution, you will end up with something that resembles a mapping framework anyway.

Mapping can be simple, but can also become a highly complex task. A mapper is created out of necessity to handle the complexity, not just as a means of saving a few keystrokes.

Features

General

Automatically lists the properties of the source and target, detects their types, and maps them accordingly.
Reads the type from PHP type declaration and PHPDoc annotations, including the type of the nested objects.
Does not attempt to circumvent your class constraints. Reads only from and writes only to public properties, getters, setters. Does not instantiate objects without their constructor.
Constructor initialization.
Handles nested objects.
Handles recursion and circular references.
Inheritance support. Maps to abstract classes and interfaces using an inheritance map attribute.
Maps to and from stdClass, objects extending stdClass, and other objects with dynamic properties (#[AllowDynamicProperties]).
Maps an object to an array, and vice versa.

Custom Mapping

Override the mapping of a specific property using a custom property mapper.
Override the mapping between two specific classes using a custom object mapper.
Extend the mapper by creating new transformers, or decorating the existing ones.
Match classes using attributes in your transformers, in addition to using class names.
Preset mapping. Provide a table of predetermined mappings that the mapper can use.

Object Lazy-Loading

If possible, target objects are lazy-loaded. The mapping does not take place until the target is accessed, and will never take place if it is never accessed.
Attempts to detect identifier properties on the source side. Those properties will be mapped eagerly to the target side, as they should not trigger the hydration of the source. As an example, API Platform will be able to generate IRIs without causing the hydration of the entire object graph.

Arrays and Array-Like Objects

Handles the mapping between array or array-like objects.
Handles adder methods on the target side.
Handles non-string & non-integer keys in array-like objects, including SplObjectStorage.

Array-Like Lazy-Loading

Lazy loading if the target is type-hinted with ArrayAccess, Traversable or CollectionInterface. The target will not iterate the source object until it is accessed, or never if it is never accessed.
Stream mapping. Maps the source members to the target side as they are being iterated. This may consume less memory.
With lazy loading, if the source is a Countable, then the target will also be a Countable. With an extra-lazy Doctrine Collection, the consumer will be able to count the target without causing a full hydration of the source.

Development Experience (DX)

Helpful exception messages.
Console commands for debugging.
Data collector and profiler integration.
Coded from the start using PHP 8, strict types, and maxed-out PHPStan and Psalm level.

To-Do List

Option to read & write to private properties.
Migrate engine to symfony/type-info.
Auto-detect static factory method.
Use our own interface for proxy objects.
MapFrom and MapTo attributes.
Support ramsey/uuid
Improve non-framework usage.
Warm up proxies on build time from the list of classes provided by the user.
Lazy-loading using Doctrine Collection type hint on the target side.

Documentation

rekalogika.dev/mapper

License

MIT

rekalogika / mapper

Maintainers

Details