README

wundii/data-mapper-laravel-package

A Laravel integration for wundii/data-mapper. This library is an extremely fast and strictly typed object mapper built for modern PHP (8.2+). It seamlessly transforms data from formats like JSON, NEON, XML, YAML, arrays, and standard objects into well-structured PHP objects.

Ideal for developers who need reliable and efficient data mapping without sacrificing code quality or modern best practices.

Features

Mapping source data into objects
Mapping source data with a list of elements into a list of objects
Initialize object via constructor, properties or methods
Map nested objects, arrays of objects
Class mapping for interfaces or other classes
Custom root element for starting with the source data
Auto-casting for float types (eu to us decimal separator)
Target alias via Attribute for properties and methods

Supported Types

null
bool|?bool
int|?int
float|?float
string|?string
array
- int[]
- float[]
- string[]
- object[]
object|?object
enum|?enum

Supported Formats

optional formats are marked with an asterisk *

array
json
neon*
object
- public property
- public getters
- method toArray()
- attribute SourceData('...')
xml
yaml*

Installation

Require the bundle and its dependencies with composer:

composer require wundii/data-mapper-laravel-package

Create a Laravel configuration file config/data-mapper.php with the command:

php artisan data-mapper:publish-config

Configuration File

The following setting options are available

<?php

return [
    'data_config' => [
        'approach' => \Wundii\DataMapper\Enum\ApproachEnum::SETTER,
        'accessible' => \Wundii\DataMapper\Enum\AccessibleEnum::PUBLIC,
        'class_map' => [
            \DateTimeInterface::class => \DateTime::class,
            // ... additional mappings can be added here
        ],
    ],
];

Use as Laravel DataMapper Facade version

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use App\Http\Dto\TestClass;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Wundii\DataMapper\LaravelPackage\Facades\DataMapper;

final class YourController extends Controller
{
    public function doSomething(Request $request): JsonResponse
    {
        // Automatic recognition of the format based on the content type of the request
        // returns an instance of TestClass or an Exception
        $testClass = DataMapper::request($request, TestClass::class);
        
        // or you can use tryRequest to avoid exceptions, null will be returned instead
        $testClass = DataMapper::tryRequest($request, TestClass::class);
        DataMapper::getMapStatusEnum();
        DataMapper::getErrorMessage();
        
        // Do something with $testClass
        
        return response()->json(...);
    }
}

Use as Native or Laravel DataMapper version

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use App\Http\Dto\TestClass;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Wundii\DataMapper\DataMapper as DataMapperNative;
use Wundii\DataMapper\LaravelPackage\DataMapper as DataMapperLaravel;

final class YourController extends Controller
{
    public function __construct(
        private readonly DataMapperNative $dataMapperNative,
        private readonly DataMapperLaravel $dataMapperLaravel,
    ) {
    }

    public function doSomething(Request $request): JsonResponse
    {
        // you can use the native DataMapper methods 
        $testClass = $this->dataMapperNative->json($request->getContent(), TestClass::class);
        
        // or you can use the Laravel DataMapper methods 
        $testClass = $this->dataMapperLaravel->request($request, TestClass::class);
        
        // Do something with $testClass
        
        return response()->json(...);
    }
}

wundii / data-mapper-laravel-package

Maintainers

Details