sanitizer maintained by elegantweb
Description
Sanitization library for PHP and the Laravel framework.
Authors
Last update
2024/03/28 03:33 (dev-master)
License
Downloads
704 851
Tags
Last update
2024/03/28 03:33
License
Require
- php ^8.0
- illuminate/support ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/validation ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- nesbot/carbon ^1.0|^2.0|^3.0
Last update
2024/03/24 11:14
License
Require
- php ^8.0
- illuminate/support ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/validation ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- nesbot/carbon ^1.0|^2.0|^3.0
Last update
2023/02/23 14:41
License
Require
- php ^8.0
- illuminate/support ^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/validation ^6.0|^7.0|^8.0|^9.0|^10.0
- nesbot/carbon ^1.0|^2.0
Last update
2022/03/20 09:09
License
Require
- php ^8.0|^8.1
- illuminate/support ^6.0|^7.0|^8.0|^9.0
- illuminate/validation ^6.0|^7.0|^8.0|^9.0
- nesbot/carbon ^1.0|^2.0
Last update
2022/02/09 18:10
License
Require
- php ^8.0|^8.1
- illuminate/support ^6.0|^7.0|^8.0|^9.0
- illuminate/validation ^6.0|^7.0|^8.0|^9.0
- nesbot/carbon ^1.0|^2.0
Last update
2021/07/11 14:49
License
Require
- 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
Last update
2021/02/17 09:47
License
Require
- 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
Last update
2021/01/10 19:16
License
Require
- 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
Last update
2020/09/09 20:12
License
Require
- php ^7.4
- illuminate/support ^6.0|^7.0|^8.0
- illuminate/validation ^6.0|^7.0|^8.0
- nesbot/carbon ^1.0|^2.0
Last update
2020/08/27 09:49
License
Require
- illuminate/support ^6.0|^7.0
- illuminate/validation ^6.0|^7.0
- nesbot/carbon ^1.0|^2.0
Last update
2020/08/19 10:13
License
Require
- illuminate/support ^6.0|^7.0
- illuminate/validation ^6.0|^7.0
- nesbot/carbon ^1.0|^2.0
Last update
2020/08/11 19:02
License
Require
- illuminate/support ^6.0|^7.0
- illuminate/validation ^6.0|^7.0
- nesbot/carbon ^1.0|^2.0
comments powered by Disqus
Sanitization library for PHP and the Laravel framework.
composer require elegantweb/sanitizeruse Elegant\Sanitizer\Sanitizer;
use Elegant\Sanitizer\Filters\Enum;
$data = [
'title' => ' ',
'name' => ' sina ',
'birth_date' => '06/25/1980',
'email' => 'JOHn@DoE.com',
'json' => '{"name":"value"}',
'enum' => 'H',
];
$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',
'enum' => ['trim', new Enum(BackedEnum::class)],
];
$sanitizer = new Sanitizer($data, $filters);
var_dump($sanitizer->sanitize());Will result in:
[
'title' => null,
'name' => 'Sina',
'birth_date' => 'June 25, 1980',
'email' => 'john@doe.com',
'json' => ['name' => 'value'],
'enum' => BackedEnum::Hearts,
];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 Elegant\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 the given string |
| empty_string_to_null | If the given string is empty set it to null
|
| escape | Removes HTML tags and encodes special characters of the given string |
| lowercase | Converts the given string to all lowercase |
| uppercase | Converts the given string to all uppercase |
| capitalize | Capitalizes the given string |
| cast | Casts the given value into the given type. Options are: integer, float, string, boolean, object, array and Laravel Collection. |
| format_date | Always takes two arguments, the given date's format and the target format, following DateTime notation. |
| strip_tags | Strips HTML and PHP tags from the given string |
| digit | Removes all characters except digits from the given string |
| enum | Casts the given value to its corresponding enum type |
It is possible to use a closure or name of a class that implements Elegant\Sanitizer\Contracts\Filter interface.
class RemoveStringsFilter implements \Elegant\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);