carbonclean/sanitizer

Sanitization library for PHP and the Laravel framework.

v1.0 2021-08-02 01:57 UTC

Requires

• php: ^7.4|^8.0
• illuminate/support: ^6.0|^7.0|^8.0
• illuminate/validation: ^6.0|^7.0|^8.0
• nesbot/carbon: ^1.0|^2.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Ashley Bailey

• input
• laravel
• sanitation
• input filter
• input sanitation
• input sanitizer
• transform input

README

Sanitization library for PHP and the Laravel framework.

Installation

composer require carbonclean/sanitizer

Usage

use CarbonClean\Sanitizer\Sanitizer;

$data = [
    'title' => ' ',
    'name' => ' John Doe ',
    'birth_date' => '06/25/1980',
    'email' => '[e-mail]',
    'json' => '{"name":"value"}',
];

$filters = [
    'title' => 'trim|empty_string_to_null',
    'name' => 'trim|empty_string_to_null|capitalize',
    'birth_date' => 'trim|empty_string_to_null|format_date:"m/d/Y","F j, Y"',
    'email' => ['trim', 'empty_string_to_null', 'lowercase'],
    'json' => 'cast:array',
];

$sanitizer = new Sanitizer($data, $filters);

var_dump($sanitizer->sanitize());

Will result in:

[
    'title' => null,
    'name' => 'John Doe',
    'birth_date' => 'June 25, 1980',
    'email' => '[e-mail]',
    'json' => ['name' => 'value'],
];

Laravel

In Laravel, you can use the Sanitizer through the Facade:

$newData = \Sanitizer::make($data, $filters)->sanitize();

You may also Sanitize input in your own FormRequests by using the SanitizesInput trait, and adding a filters method that returns the filters that you want applied to the input.

namespace App\Http\Requests;

use CarbonClean\Sanitizer\Laravel\SanitizesInput;

class MyAwesomeRequest extends Request
{
    use SanitizesInput;
    
    public function filters()
    {
        return [
            'name' => 'trim|capitalize',
        ];
    }
}

Optional

If you are planning to use sanitizer for all of your HTTP requests, you can optionally disable Laravel's TrimStrings and ConvertEmptyStringsToNull middleware from your HTTP kernel.

protected $middleware = [
    [...]
    // \App\Http\Middleware\TrimStrings::class,
    // \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    [...]
];

Then, instead, you can use trim and empty_string_to_null filters:

$filters = [
    'some_string_parameter' => 'trim|empty_string_to_null',
];

Available Filters

The following filters are available out of the box:

Filter	Description
trim	Trims a string
empty_string_to_null	If the given string is empty set it to null
escape	Escapes HTML and special chars using php's filter_var
lowercase	Converts the given string to all lowercase
uppercase	Converts the given string to all uppercase
capitalize	Capitalize a string
cast	Casts a variable into the given type. Options are: integer, float, string, boolean, object, array and Laravel Collection.
format_date	Always takes two arguments, the date's given format and the target format, following DateTime notation.
strip_tags	Strip HTML and PHP tags using php's strip_tags
digit	Get only digit characters from the string
boolean	If the given value is not a boolean set it to null

Custom Filters

It is possible to use a closure or name of a class that implements CarbonClean\Sanitizer\Contracts\Filter interface.

class RemoveStringsFilter implements \CarbonClean\Sanitizer\Contracts\Filter
{
    public function apply($value, array $options = [])
    {
        return str_replace($options, '', $value);
    }
}

$filters = [
    'remove_strings' => RemoveStringsFilter::class,
    'password' => fn ($value, array $options = []) => sha1($value),
];

$sanitize = new Sanitizer($data, $filters);

Laravel

You can easily extend the Sanitizer library by adding your own custom filters, just like you would the Validator library in Laravel, by calling extend from a ServiceProvider like so:

\Sanitizer::extend($filterName, $closureOrClassName);