ftv/merger

Merger with rules

Ftv Merger

This project is part of francetv zoom open source projects (iOS, Android and Angular)., _(*1)

This component allows you to merge multiple data sources in a single array and based on business rules., _(*2)

How to install

In composer.json, _(*3)

"repositories": [
    {
        "type": "vcs",
        "url": "git@github.com:francetv/merger.git"
    }
]

And run composer, _(*4)

composer require ftv/merger

How to use

Create rule class that implement RuleInterface, _(*5)

<?php

namespace App\Merger\Rules

use Ftv\Merger\Rule\RuleInterface;

class MyBusinessRule implement RuleInterface
{
    public function apply($merged, $firstSource, $secondSource)
    {
        if (!isset($secondSource['specific-key'])) {
            return $merged;
        }

        if ($secondSource['specific-key'] === "some specific value") {
            $merged['specific-key'] = "override value because business is business";
        }

        return $merged
    }
}

Then, create an instance of Merger and add this rule, _(*6)

//somewhere in your application
$merger = new Merger();
$merger->addRule(new MyBusinessRule());

And use it., _(*7)

//somewhere further in your application
$merged = $merger->merge($merged, $dataSource1, $dataSource2);

$merged must contain all your data merged with rules applied. If no rule is added, it merge all data source into merged array., _(*8)

How to use with Symfony

Declare rule as service, _(*9)

<service id="app.merger.rules.my_business" class="App\Merger\Rule\MyBusinessRule" />

Declare merger as service and add rule., _(*10)

<service id="app.merger" class="Ftv\Merger\Merger">
    <call method="addRule">
        <argument type="service" id="app.merger.rules.my_business" />
    </call>
</service>

In your app, call merger service, _(*11)

//somewhere in your application
$merged = $this->container->get('app.merger')->merge($merged, $dataSource1, $dataSource2);

That's it!, _(*12)