README

This library sanitizes an array based on another array ruleset. The ruleset can have specific settings to force array values such as boolean, string, integer, decimal and others, as well as force regular expression pattern matching. This library is intended to be used as a compliment to our Array Validation library.

Requirements

• PHP 5.5+

Installation

The easiest way to install this library is to use composer. To install, simply include the following in your composer.json file:

"require": {
    "multidimensional/array-sanitization": "*"
}

Or run the following command from a terminal or shell:

composer require --prefer-dist multidimensional/array-sanitization

You can also specify version constraints, with more information available here.

Usage

This library utilizes PSR-4 autoloading, so make sure you include the library near the top of your class file:

use Multidimensional\ArraySanitization\Sanitization;

How to use in your code:

Create Ruleset

$rules = ['keyName' => ['type' => 'integer']];

Sanitize an array against that ruleset

$array = ['keyName' => 10.1];
$result = Sanitization::sanitize($array, $rules);
print_r ($result);

/*
 * $result = array('keyName' => 10);
 */

Advanced Rulesets

Specific ruleset examples can be found in the SanitizationTest.php file. For more advanced rulesets, view the README.md from our Array Validation library.

Contributing

We appreciate all help in improving this library by either adding functions or improving existing functionality. If you do want to add to our library, please ensure you use PSR-2 formatting and add unit testing for all added functions.

Feel free to fork and submit a pull request!

License

MIT License

Copyright (c) 2017 - 2019 multidimension.al

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.