flsouto/pipe

There is no license information available for the latest version (1.0.3) of this package.

apply a chain of filters and validations to input data

1.0.3 2021-01-23 19:03 UTC

Unknown License

• Fabio Souto

README

Overview

This library exposes a simple API that allows you to apply a chain of filters and/or validators against arbitrary data.

Installation

Through composer:

composer require flsouto/pipe

Usage

The following example adds a 'trim' filter and a custom filter which replaces 4, 1 and 0 with a,i and o:

require_once('vendor/autoload.php');
use FlSouto\Pipe;

$pipe = new Pipe();
$pipe->add('trim')->add(function($value){
	return str_replace(['4','1','0'],['a','i','o'],$value);
});

$result = $pipe->run(' f4b10 ');

echo $result->output;

The above code will output:

fabio

So all your filter function has to do is to accept a value, modify and return it.

Validation

The next example uses the same API but this time makes sure the input value doesn't have a number '4'.

use FlSouto\Pipe;

$pipe = new Pipe();
$pipe->add(function($value){
	if(strstr($value,'4')){
		echo 'The value cannot contain the number 4.';
	}
});
$result = $pipe->run('f4b10');

echo $result->error;

The above snippet outputs:

The value cannot contain the number 4.

So, if your filter prints something out, then it is considered to be a validator instead of a regular filter. The printed error message will be available in the $result->error property.

Using Filters and Validation Together

In the following code snippet you have a filter happening before the validation, so the validation does not failed.

$pipe = new Pipe();
$pipe->add(function($value){
	return str_replace('4','a',$value);
});
$pipe->add(function($value){
	if(strstr($value,'4')){
		echo 'The value cannot contain the number 4.';
	}
});
$result = $pipe->run('f4b10');

This is just to ilustrate that filters and validators can work together. Notice the order they are applied is the same order they are added to the pipe.

Defining a Fallback

The fallback method allows you to define a default value to be returned in case any error occurs. The default fallback is always the input itself:

$pipe = new Pipe();
$pipe->add(function($v){
    iF(preg_match("/\d/",$v)){
        echo "The value cannot contain digits.";
    }
});

$result = $pipe->run($input="My name is 12345");

echo $result->output;

My name is 12345

Use the fallback method to change the default value:

$pipe = new Pipe();
$pipe->fallback('default');
   $pipe->add(function($v){
       iF(preg_match("/\d/",$v)){
           echo "The value cannot contain digits.";
       }
   });
$result = $pipe->run('My name is 12345');

echo $result->output;

The output will be:

default

Notice: the fallback value is also used when the input value is null. Example:

$pipe = new Pipe();
$pipe->fallback('default');
$result = $pipe->run(null);

echo $result->output;

The output will be:

default

However this behaviour does not follow on empty strings:

$pipe = new Pipe();
$pipe->fallback('default');
$result = $pipe->run('');

var_dump($result->output);

string(0) ""

Customizing the fallback behaviour

If you want, for instance, to fallback on null, empty string or zero, you have to provide the second parameter to the fallback method:

$pipe = new Pipe();
$pipe->fallback('default',[null,'',0]);
$result = $pipe->run('');

echo $result->output;

The output will be:

default

Alternative syntax

You can use the addArray method to add an array of filters at once or you can instantiate the Pipe class through the create method which accepts an array of filters too:

  	$pipe = Pipe::create([
  		'trim',
  		function($value){ return str_replace('_','/',$value); }
  	]);

Final Thoughts

There are no final thoughts - this is just the beginning (: