Downloads
Stars
Version
This package is a Sanitizer for PHP arrays. It's best used to sanitize request inputs like input from $_POST
and/or $_GET
.
composer require 'creativitykills/sanity'
Open config/app.php
and, to your "providers" array at the bottom, add:
"CreativityKills\Sanity\SanityServiceProvider"
Out of the box you can start running requests through the sanitizer.
<?php
// Possibly input from $_POST or $_GET global array
$someArray = ['name' => ' JOHN DOE ', 'email' => ' [email protected] '];
// Rules to validate against
$sanitizerRules = ['name' => 'ucwords|trim', 'email' => 'strtolower|trim'];
$sanitizer = new \CreativityKills\Sanity\Sanitizer;
$someArray = $sanitizer->sanitize($someArray, $sanitizerRules);
// array(
// 'name' => 'John Doe',
// 'email' => '[email protected]'
// )
var_dump($someArray);
The sweet aspect of Sanity is extending the Sanity class. You can create a custom extension of the class.
<?php
use CreativityKills\Sanity\Sanitizer;
class UserSanitizer extends Sanitizer {
protected $rules = [
'name' => 'ucwords|trim|remove_excess_white_spaces',
'email' => 'strtolower|trim'
];
public function sanitizeRemoveExcessWhiteSpaces($value)
{
return preg_replace('/\s+/', ' ', $value)
}
}
Notice the custom
remove_excess_white_spaces
sanitizer is called from the methodsanitizeRemoveExcessWhiteSpaces
. All snake cased sanitizer rules are converted to camel cases.
Now we can call our custom sanitizer from our application like so:
<?php
// Possibly input from $_POST or $_GET global array
$someArray = ['name' => ' JOHN DOE ', 'email' => ' [email protected] '];
$someArray = (new UserSanitizer)->sanitize($someArray);
// array(
// 'name' => 'John Doe',
// 'email' => '[email protected]'
// )
var_dump($someArray);