Sanitization library for PHP and the Laravel framework.
composer require carbonclean/sanitizeruse CarbonClean\Sanitizer\Sanitizer;
$data = [
'title' => ' ',
'name' => ' John Doe ',
'birth_date' => '06/25/1980',
'email' => 'JOHn@DoE.com',
'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' => 'john@doe.com',
'json' => ['name' => 'value'],
];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',
];
}
}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',
];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
|
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);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);