graze/array-merger

Merge arrays recusively using custom value choosers

0.2 2018-09-12 14:12 UTC

This package is auto-updated.

Last update: 2021-12-23 23:02:15 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Array Merger allows you to recursively merge arrays and choose how the values should be merged.

Merge

Why

The php function: array_merge_recursive does indeed merge arrays, but it converts values with duplicate keys to arrays rather than overwriting the value in the first array with the duplicate value in the second array, as array_merge does. I.e., with array_merge_recursive, this happens (documented behaviour).

$a = ['key' => 'org value', 'key2' => 'first'];
$b = ['key' => 'new value', 'key2' => null];
array_merge_recursive($a, $b);
// ['key' => ['org value', 'new value'], 'key2' => ['first', null]];

There is also array_replace_recursive which replaces values in the first with values in the second, but it handles value arrays differently and only supports replacing with the last value.

array_replace_recursive($a, $b);
// ['key' => 'new value', 'key2' => null];

This library gives you the flexibility to ensure you get the values you actually want in the merge.

RecursiveArrayMerger::lastNonNull($a, $b);
// ['key' => 'new value', 'key2' => 'first']);

Install

Via Composer

composer require graze/array-merger

Value Mergers

  • LastValue: Takes the last value (default) equivalent to array_replace_recursive
  • LastNonNullValue: Takes the last value, unless it is null then the first
  • FirstValue: Takes the first value
  • FirstNonNullValue: Takes the first value, unless it is null, then the second
  • RandomValue: Takes a random value
  • SumValue: If both values are numeric, will add them together
  • ProductValue: If both values are numeric, will multiply them together
  • BothValues: Will return both values in an array, equivalent to array_merge_recursive

Usage

There is an ArrayMerger which will only merge at the top level, and a RecursiveArrayMerger which will merge recursively.

The mergers can take any number of arguments, and will treat the first argument as the base array to merge the subsequent arrays into.

$merger = new Graze\ArrayMerger\ArrayMerger();
$merger->merge(
    ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'fish']],
    ['a' => 'second', 'b' => ['d' => 'money']]
);
// ['a' => 'second', 'b' => ['d' => 'money']]

$merger = new Graze\ArrayMerger\RecursiveArrayMerger();
$merger->merge(
    ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'fish']],
    ['a' => 'second', 'b' => ['d' => 'money']],
    ['a' => 'third', 'b' => ['e' => 'planets']],
);
// ['a' => 'third', 'b' => ['c' => 'cake', 'd' => 'money', 'e' => 'planets]]

Supplying a Value Merger

By default the last value will be used when merging, however you can supply a different Value Merger to change the behaviour of the merged value.

$merger = new Graze\ArrayMerger\RecursiveArrayMerger(new LastNonNullValue());
$merger->merge(
    ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'fish']],
    ['a' => 'second', 'b' => ['d' => null]]
);

// ['a' => 'second', 'b' => ['c' => 'cake', 'd' => 'fish']]

The Value Merger is a callable that can take 2 arguments. This allows you to use in-built and in-line functions:

$merger = new Graze\ArrayMerger\RecursiveArrayMerger('max');
$merger->merge(
    ['a' => 1, 'b' => ['c' => 2, 'd' => 3]],
    ['a' => 4, 'b' => ['d' => 1]]
);
// ['a' => 4, 'b' => ['c' => 2, 'd' => 3]]

// or some strange value choose of your choice
$merger = new Graze\ArrayMerger\RecursiveArrayMerger(
    function ($a, $b) {
        return $a % $b == 0 ? $a : $b;
    }
);
$merger->merge(
    ['a' => 1, 'b' => ['c' => 2, 'd' => 3]],
    ['a' => 4, 'b' => ['d' => 1]]
);
// ['a' => 1, 'b' => ['c' => 2, 'd' => 0]]

Calling Statically

You can call merge statically and specify the Value Merger of your choice:

RecursiveArrayMerger::mergeUsing(
    new LastValue(),
    ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'fish']],
    ['a' => 'second', 'b' => ['d' => 'money']]
);
// ['a' => 'second', 'b' => ['c' => 'cake', 'd' => 'money']]

Each of the supplied value mergers also have static helper methods to call them:

RecursiveArrayMerger::lastNonNull(
    ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'fish']],
    ['a' => null, 'b' => ['d' => 'money']]
);
// ['a' => 'first', 'b' => ['c' => 'cake', 'd' => 'money']]

Value Arrays

By default value arrays (arrays with no indexes supplied) will be appended onto each other, if you want to treat them as associative arrays, you can supply this flag: RecursiveArrayMerger::FLAG_MERGE_VALUE_ARRAY.

$a = ['a' => 'first', 'b' => ['a','c','d']];
$b = ['a' => 'second', 'b' => ['e']];
$merger = new Graze\ArrayMerger\RecursiveArrayMerger(new LastValue());
$merger->merge($a,$b);
// ['a' => 'second', 'b' => ['a','c','d','e']]

$merger = new Graze\ArrayMerger\RecursiveArrayMerger(new LastValue(), RecursiveArrayMerger::FLAG_MERGE_VALUE_ARRAY);
$merger->merge($a,$b);
// ['a' => 'second', 'b' => ['e','c','d']]

Unique Values

By default, when we append value arrays it will keep duplicate values. If you want to remove the duplicate values you can supply the flag: RecursiveArrayMerger::FLAG_UNIQUE_VALUE_ARRAY. This flag will only be relevant if the RecursiveArrayMerger::FLAG_MERGE_VALUE_ARRAY flag is not supplied.

$a = ['a' => 'first', 'b' => ['a','c','d']];
$b = ['a' => 'second', 'b' => ['d','e']];
$merger = new Graze\ArrayMerger\RecursiveArrayMerger(new LastValue());
$merger->merge($a,$b);
// ['a' => 'second', 'b' => ['a','c','d','d','e']]

$merger = new Graze\ArrayMerger\RecursiveArrayMerger(new LastValue(), RecursiveArrayMerger::FLAG_UNIQUE_VALUE_ARRAY);
$merger->merge($a,$b);
// ['a' => 'second', 'b' => ['a','c','d','e']]

Testing

make build test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@graze.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.