Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mawuva/laravel-request-sanitizer
Easily sanitize your form data
https://github.com/mawuva/laravel-request-sanitizer
Last synced: 7 days ago
JSON representation
Easily sanitize your form data
- Host: GitHub
- URL: https://github.com/mawuva/laravel-request-sanitizer
- Owner: mawuva
- License: mit
- Created: 2021-06-10T19:28:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-22T03:17:17.000Z (about 1 year ago)
- Last Synced: 2024-08-14T07:02:39.853Z (3 months ago)
- Language: PHP
- Homepage: https://packagist.org/packages/mawuekom/laravel-request-sanitizer?query=laravel-request-sanitizer
- Size: 19.5 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Request Sanitizer
### *Easily sanitize your form data*
This package provides an easy way and a fluent interface to sanitize form data.
- The request sanitizer allows you to easily
manipulate your form data before any validation or treatment.
- It's also compatible with Laravel's `FormRequest` object.
## Installation
You can install the package via composer:
```bash
composer require mawuekom/laravel-request-sanitizer
```
## Usage
Syntax is similar to the way `rules` are added to a [Form Request](https://laravel.com/docs/master/validation#form-request-validation).
```php
class StoreUserDataRequest extends FormRequest
{
use InputSanitizer;
protected $sanitizers = [
'name' => [
Uppercase::class,
],
'first_name' => [
CapitalizeEachWords::class,
],
'phone_number' => [
RemoveNonNumeric::class
],
];
}
```
## Available Sanitizers
Sanitizer | Description
:---------|:----------
[**`Capitalize`**](./src/Sanitizers/Capitalize.php) | Capitalizes the first character of a string
[**`CapitalizeEachWords`**](./src/Sanitizers/CapitalizeEachWords.php) | Capitalizes each first character of a new word in a string
[**`Cast`**](./src/Sanitizers/Cast.php) | Casts a variable into the given type.
[**`EscapeHTML`**](./src/Sanitizers/EscapeHTML.php) | Remove HTML tags and encode special characters from the given string.
[**`FilterVars`**](./src/Sanitizers/FilterVars.php) | Simple PHP `filter_var` sanitizer
[**`Lowercase`**](./src/Sanitizers/Lowercase.php) | Converts a string to lowercase
[**`RemoveNonNumeric`**](./src/Sanitizers/RemoveNonNumeric.php) | Removes any non numeric character
[**`StripTags`**](./src/Sanitizers/StripTags.php) | Strip HTML and PHP tags using php's `strip_tags()`
[**`Trim`**](./src/Sanitizers/Trim.php) | Trims a string using php's `trim()`
[**`TrimDuplicateSpaces`**](./src/Sanitizers/TrimDuplicateSpaces.php) | Replaces duplicate spaces with a single space.
[**`Uppercase`**](./src/Sanitizers/Uppercase.php) | Converts a string to uppercase
- Contributions are appreciated!
### FilterVars usage
The FilterVars sanitizer acts as a wrapper of the default PHP `filter_var` function.
It accepts the same (optional) parameters as the original function.
Both parameters can be either an `array` or `string` type:
```php
{
protected $sanitizers = [
'last_name' => [
FilterVars::class => [
'filter' => FILTER_SANITIZE_STRING,
'options' => FILTER_FLAG_STRIP_BACKTICK
]
]
];
}
```
Please check [PHP Documentation](https://www.php.net/manual/en/function.filter-var.php.) for more information on `filter_vars`.
## Writing your own Sanitizer
You can write your own sanitizer by implementing the `SanitizerContract` interface, which requires only one method.
```php
namespace Mawuekom\RequestSanitizer\Contracts;
/**
* Request sanitizer contract
*
* Class DataManagerRepo
*
* @package Mawuekom\RequestSanitizer\Contracts
*/
interface SanitizerContract
{
/**
* Sanitize an input and return it.
*
* @param $input
* @return mixed
*/
public function sanitize($input);
}
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.