Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexmanno/pipeline-remix
Reinvented pipelines for PHP
https://github.com/alexmanno/pipeline-remix
oop php7 php71 php72 pipelines stage state
Last synced: about 1 month ago
JSON representation
Reinvented pipelines for PHP
- Host: GitHub
- URL: https://github.com/alexmanno/pipeline-remix
- Owner: alexmanno
- License: mit
- Created: 2017-11-24T23:18:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-13T07:51:50.000Z (about 7 years ago)
- Last Synced: 2024-09-24T20:10:04.453Z (3 months ago)
- Topics: oop, php7, php71, php72, pipelines, stage, state
- Language: PHP
- Size: 63.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pipeline-remix
Reinvented pipelines for PHP
[](https://packagist.org/packages/alexmanno/pipeline-remix)
[](//packagist.org/packages/alexmanno/pipeline-remix)
[](https://github.com/alexmanno/pipeline-remix/blob/master/LICENSE.md)
[](https://packagist.org/packages/alexmanno/pipeline-remix)
[](https://scrutinizer-ci.com/g/alexmanno/pipeline-remix/?branch=master)
[](https://scrutinizer-ci.com/g/alexmanno/pipeline-remix/?branch=master)
[](https://scrutinizer-ci.com/g/alexmanno/pipeline-remix/build-status/master)
## 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.
## Installation
### From Composer
To use this package, use Composer:
* from CLI: `composer require alexmanno/pipeline-remix`
* or, directly in your `composer.json`:
```json
{
"require": {
"alexmanno/pipeline-remix": "dev-master"
}
}
```
## Architecture
### Pipeline
A Pipeline is a simple SplQueue of Stage.
You can initialize it in this way: `$pipeline = new AlexManno\Remix\Pipelines\Pipeline();`
You can add Stage to Pipeline using `$pipeline->pipe($stage)`
### Stage
A Stage is an object that implements `AlexManno\Remix\Pipelines\Interfaces\StageInterface` and has an `__invoke()` method.
This object is the smallest part of the pipeline and it should be a single operation.
You can create a class that implements that interface.
Ex.
```php
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`.
Ex.
```php
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.
Ex.
```php
// -- 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()`
Ex.
```php
// -- 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](examples/example-00.php)
## Conclusion
I hope you found useful this repo. Thanks for attention.
Made with :heart: by [@alexmanno](https://aka.am)