acelot/automapper

Simple declarative data mapper for PHP 7

AutoMapper

, _(*1)

Simple declarative data mapper for PHP 7 & 8., _(*2)

AutoMapper can map data from array/object to existing array/object or marshal new ones. Mapping rules specified in declarative way using three simple definitions: - From definition (From::create or via short function from) — maps single field from source to target. Supports chainable functions: - ->convert(callable $callable) — converts input value to another one via any callable; - ->trim() — trims value to eliminate whitespaces (suitable for strings); - ->default($defaultValue) — returns default value if source field is missing; - ->ignoreMissing() — ignores target field if source field is missing; - ->ignoreEmpty() — ignores target field if source field is empty. - Aggregate definition (Aggregate::create or via short function aggregate) — maps multiple fields from source to single target field. Supports chainable functions: - ->trim() — trims aggregated value - ->ignoreEmpty() — ignores target field if aggregated value is empty. - Ignore definition (Ignore::create or via short function ignore) — simply ignores the field. - Value definition (Value::create or via short function value) — maps constant value to target field. Supports chainable functions: - ->trim() - ->ignoreEmpty(), _(*3)

All missing source fields can be ignored via AutoMapper::create(...)->ignoreAllMissing() modifier., _(*4)

Install

composer require acelot/automapper

Example

use function Acelot\AutoMapper\{
    field, from, value, aggregate
}

// Define mapper
$mapper = AutoMapper::create(
    field('id', from('id')->convert('intval')),
    field('title', from('text')->trim()),
    field('url', from('link')->trim()),
    field('isActive', from('is_active')->convert(function ($value) {
        return $value === 1;
    })->default(false)),
    field('count', value(100)),
    field('isEmpty', aggregate(function (SourceInterface $source) {
        return !empty($source->get('title')) && !empty($source->get('url'));
    })),
    field('ignoreThisField', ignore())
)->ignoreAllMissing();

// Source data
$source = [
    'id' => '100',
    'text' => 'Very useful text. ',
    'is_active' => 0
];

// Target
$target = $mapper->marshalArray($source);
var_dump($target);

Output:, _(*5)

array(5) {
  ["id"]=>
  int(100)
  ["title"]=>
  string(17) "Very useful text."
  ["isActive"]=>
  bool(false)
  ["count"]=>
  int(100)
  ["isEmpty"]=>
  bool(false)
}