aviator / pipe
Chain callables using a simple wrapper class.
Installs: 1 180
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 1
Requires
- php: >=7.0.0
Requires (Dev)
- phpunit/phpunit: ~6.4.0
This package is auto-updated.
Last update: 2024-10-21 19:45:34 UTC
README
PHP code can be frustratingly opaque, especially when dealing with nested functions. Why not chain those functions instead?
$filter = function ($item) { return $item === 'SOME'; }; // Offputting one-liner echo implode('.', array_filter(explode('-', strtoupper(trim(' some-value'))), $filter)) // Multiple assignments $value = ' some-value'; $value = trim($value); $value = strtoupper($value); $value = explode('-', $value); $value = array_filter($value, $filter); echo implode('.', $value); // Easy to read pipe echo take(' some-value') ->trim() ->strtoupper() ->explode('-', '$$') ->array_filter($filter) ->implode('.', '$$') ->get(); // prints 'SOME'
Installation
Via Composer:
composer require aviator/pipe
Testing
Via Composer:
composer test
Usage
Get a Pipe
object:
$value = new Pipe('value'); $value = Pipe::take('value'); $value = take('value');
Then you can chain callables:
$value->pipe('strtoupper');
And get the mutated value:
echo $value->get(); // prints 'VALUE'
The pipe method is chainable:
echo Pipe::take(' value') ->pipe('trim') ->pipe('strtoupper') ->get(); // prints 'VALUE'
Pipe uses a magic __call
to redirect other methods to the pipe
method, so you don't have to use pipe(...)
at all:
echo Pipe::take(' value') ->trim() ->strtoupper() ->get(); // prints 'VALUE'
Arguments
You can use callables with arguments:
echo Pipe::take('value') ->str_repeat(3) ->strtoupper() ->get(); // prints 'VALUEVALUEVALUE'
Pipe
will always pass the value you're mutating ('value' in the example above) as the first parameter.
This works most of the time, but since PHP has some unique parameter ordering, there are cases where it doesn't. In these cases you can use the placeholder, by default $$
, to represent the mutating value.
For example, implode()
:
echo Pipe::take(['some', 'array']) ->implode('.', '$$') ->get(); // prints 'some.array'
Because implode()
takes the input value as its second parameter, we tell Pipe
where to put it using '$$'. Then when called the value is swapped in.
Closures
You may pipe any callable, including a closure:
$closure = function ($item) { return $item . '-postfixed'; }; echo Pipe::take('value') ->pipe($closure) ->get(); // prints 'value-postfixed'
Other Stuff
License
This package operates under the MIT License (MIT). Please see LICENSE for more information.
Thanks
This is largely based on Sebastiaan Luca's idea and his Pipe\Item
class.