yuloh/pipeline

A simple functional pipeline

Pipeline

![Software License][ico-license] , _(*1)

Introduction

yuloh/pipeline is a simple functional pipeline. You can easily chain functions together to process a payload. It's a lot easier to read, and there are less temporary variables than doing it the old fashioned way., _(*2)

Goals

This package aims to expose the simplest API possible., _(*3)

The programming language elixir has a pipe operator (|>) which lets you easily chain functions:, _(*4)

1 |> inc |> double

I really liked that syntax, and I wanted to write a pipeline package where I didn't have to write pipe or add over and over, hence this package., _(*5)

Why PHP 7 Only?

PHP 7 introduced the Uniform Variable Syntax, which means we can do this:, _(*6)

pipe('hello world')('strrev')('strtoupper')();

Instead of something like this:, _(*7)

pipe('hello world')->pipe('strrev')->pipe('strtoupper')->process();

Install

Via Composer, _(*8)

``` bash $ composer require yuloh/pipeline, <sub>(*9)</sub>

## Usage

To create a new pipeline, invoke the `Yuloh\Pipeline\pipe` function with your payload.

```php
use function Yuloh\Pipeline\Pipe;

$pipe = pipe([1, 2]);

Once it's created you can keep chaining stages by invoking the pipeline. The stage must be a valid PHP callable., <sub>(*10)</sub>

$pipe('array_sum')('sqrt');

If you invoke the pipeline without a stage, the pipeline will be processed and the processed payload is returned., <sub>(*11)</sub>

$result = $pipe();

All together, it looks like this:, <sub>(*12)</sub>

pipe([1, 2])('array_sum')('sqrt')();

Passing Arguments

When adding a stage, any additional arguments will be passed to the stage after the payload. For instance, if you were processing a JSON payload the pipeline might look like this:, <sub>(*13)</sub>

``` php use function Yuloh\Pipeline\Pipe;, <sub>(*14)</sub>

$pastTimes = pipe('{"name": "Matt", "pastTimes": ["playing Legend of Zelda", "programming"]}') ('json_decode', true) (function ($data) { return $data['pastTimes']; }) ('implode', ', ') ();, <sub>(*15)</sub>

echo $pastTimes; // playing Legend of Zelda, programming, <sub>(*16)</sub>

In the previous example, `json_decode` would be invoked as `json_decode($payload, true)` to return an array.

### Alternative Method Call Usage

You can also add stages as method calls instead of function arguments.  It's a little more readable for pipelines that are only using standard functions.

```php
pipe('hello world')
    ->strrev()
    ->strtoupper()
    ->get();

Testing

bash $ composer test, <sub>(*17)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>