alexmanno/pipeline-remix

Reinvented pipelines for PHP

pipeline-remix

Reinvented pipelines for PHP, _(*1)

, _(*2)

What's a Pipeline

A pipeline is a set of data processing elements connected in series, where the output of one element is the input of the next one., _(*3)

Installation

From Composer

To use this package, use Composer:, _(*4)

• from CLI: composer require alexmanno/pipeline-remix
• or, directly in your composer.json:

{
    "require": {
        "alexmanno/pipeline-remix": "dev-master"
    }
}

Architecture

Pipeline

A Pipeline is a simple SplQueue of Stage., _(*5)

You can initialize it in this way: $pipeline = new AlexManno\Remix\Pipelines\Pipeline();, _(*6)

You can add Stage to Pipeline using $pipeline->pipe($stage), _(*7)

Stage

A Stage is an object that implements AlexManno\Remix\Pipelines\Interfaces\StageInterface and has an __invoke() method., _(*8)

This object is the smallest part of the pipeline and it should be a single operation., _(*9)

You can create a class that implements that interface., _(*10)

Ex., _(*11)

 class MyCoolStage implements AlexManno\Remix\Pipelines\Interfaces\StageInterface
 {
    /**
     * @param Payload $payload
     */
    public function __invoke(Payload $payload)
    {
        $payload->setData('Hello!');

        return $payload;
    }
}

Payload

Payload is an object that implements PayloadInterface and can store any kind of data. For example in a web application it can store Request and Response., _(*12)

Ex., _(*13)

class Payload implements AlexManno\Remix\Pipelines\Interfaces\PayloadInterface
{
    /** @var RequestInterface */
    public $request;
    /** @var ResponseInterface */
    public $response;
}

Compose and run your pipeline

If you have already initialized Payload object and Stages objects you can compose your pipeline., _(*14)

Ex., _(*15)

// -- Initialized objects: $payload, $pipeline, $stage1, $stage2 --

$pipeline
    ->pipe($stage1) // Add $stage1 to queue
    ->pipe($stage2); // Add $stage2 to queue

$pipeline($payload);  // Run pipeline: invoke $stage1 and then $stage2 with payload from $stage1

You can also compose two or more pipelines together using method add(), _(*16)

Ex., _(*17)

// -- Initialized objects: $payload, $pipeline1, $pipeline2, $stage1, $stage2 --

$pipeline1->pipe($stage1); // Add $stage1 to $pipeline1
$pipeline2->pipe($stage2); // Add $stage2 to $pipeline2

$pipeline1->add($pipeline2); // Add stages from $pipeline2

$payload = $pipeline1($payload); // Run pipeline: invoke $stage1 (from $pipeline1) and then $stage2 (from $pipeline2) with payload from $stage1

Examples

• Using Classes Example-00

Conclusion

I hope you found useful this repo. Thanks for attention., _(*18)

Made with :heart: by @alexmanno, _(*19)