daylerees/sanitizer

, _(*1)

Sanitizer Package

Sanitizers can be used to standardize data to ease validation, or provide data consistency., _(*2)

Basic Usage

First construct a rules array., _(*3)

$rules = [
    'name'      => 'trim',
    'email'     => 'trim|strtolower'
];

Rules can contain either callable functions, or the name of a sanitizer binding (more later). You can use either a pipe | or an array to specify multiple sanitization rules., _(*4)

The sanitizer can be executed in the following fashion., _(*5)

$sanitizer = new Sanitizer;
$sanitizer->sanitize($rules, $data);

Here's a full example., _(*6)

// Construct rules array.
$rules = [
    'name'      => 'trim',
    'email'     => 'trim|strtolower'
];

// Data array to be sanitized.
$data = [
    'name' => ' Dayle ',
    'email' => ' me@DAYLEREES.com'
];

// Construct a new sanitizer.
$sanitizer = new Sanitizer;

// Execute the sanitizer.
$sanitizer->sanitize($rules, $data);

Here's the content of $data after execution., _(*7)

[
    'name' => 'Dayle',
    'email' => 'me@daylerees.com'
]

Using the Laravel facade, the syntax can be made a little cleaner., _(*8)

Sanitizer::sanitize($rules, $data);

Sanitize a single value like so., _(*9)

$rules = 'trim|strtolower';
$data = '  Dayle';

Sanitizer::sanitizeValue($rules, $data);

Here is the value returned., _(*10)

dayle

Custom Sanitization Rules

Sanitizers can be added multiple ways., _(*11)

Using a Closure.

Sanitizer::register('reverse', function ($field) {
    return strrev($field);
});

Using a Callback.

Sanitizer::register('reverse', [new ClassHere, 'method']);

Using a class/method pair.

Sanitizer::register('reverse', 'Namespace\Class\Here@method');

The class will be resolved through an instance of the Illuminate IoC container, if no method is provided then sanitize() is assumed., _(*12)

Installation

The Sanitizer package can be used stand-alone or with the Laravel Framework., _(*13)

Stand-alone

First include the sanitizer package., _(*14)

"daylerees/sanitizer": "dev-master"

Now simply use the Sanitizer class., _(*15)

use Rees\Sanitizer\Sanitizer;

With Laravel

Include the Service Provider class within the app/config/app.php file., _(*16)

'providers' => array(
    ...
    'Rees\Sanitizer\SanitizerServiceProvider'
)

Now simply add the facade alias., _(*17)

'aliases' => array(
    ...
    'Sanitizer' => 'Rees\Sanitizer\Facade'
)