Filterus - A flexible PHP 5.3 filter package
Filter Methods:
Each filter class has two primary methods:
$filter->filter($var)- returns a modified version of$varfiltered to the options. If it cannot be safely modified, a default value will be returned.$filter->validate($var)- Returns a boolean identifying if the value is valid.
Simple Filters (with options):
alnum- Alpha numericmin- 0 - Minimum lengthmax- PHP_INT_MAX - Maximum lengthdefault-''- Default return value
array- Array matchingmin- 0 - Minimum sizemaximum- PHP_INT_MAX - Maximum sizekeys-null- Filter to run on the keysvalues-null- Filter to run on the valuesdefault-array()- Default return value
bool- Boolean matchingdefault-null- Default return value
email- Matches emailsfloat- Floating point numbersmin-null- Minimum lengthmax-null- Maximum lengthdefault- 0.0 - Default return value
int- Integers numbersmin-null- Minimum lengthmax-null- Maximum lengthdefault- 0 - Default return value
ip- Matches IP addressesipv4-true- Boolean to match IPv4 addressesipv6-true- Boolean to match IPv6 addressesprivate-true- Include private addresses?reserved-true- Include reserved addresses?
object- Objectsclass-''- Required class or interface namedefault-null- The default valuedefaultFactory-null- A callback to instantiate a return value
raw- Returns whatever is passed inregex- Matches strings via a regexmin- 0 - Minimum lengthmax- PHP_INT_MAX - Maximum lengthdefault-''- Default return valueregex-/.?/- The regex to run
string- Matches stringsmin- 0 - Minimum lengthmax- PHP_INT_MAX - Maximum lengthdefault-''- Default return value
url- Matches URLspath-false- Force a path to be presentquery-false- Force a query string to be present
Complex Filters
Filter::map(array())- "maps" several filters over key-value pairs. Useful for filtering associative arrays or stdclass objects.Filter::chain($filter1, $filter2...)- Chains multiple filters together to run on the same value (similar toANDjoining filters).Filter::pool($filter1, $filter2...)- Runs the same value through multiple filters using the first valid return (similar toORjoining filters)
Usage:
Simple filters can be specified using a comma-separated-value list. So a filter specifying a string with minimum length of 5 could be represented as:
$filter = Filter::factory('string,min:5');
Or
$filter = new Filters\String(array('min' => 5));
If you pass a filter to Filter::factory(), it will be returned unmodified. So you can write functions like:
function foo($bar, $filter) {
// do something with $bar and set in $baz
return Filter::factory($filter)->filter($baz);
}
Complex chaining can also be supported. So if you wanted to check if an array with a minimum size of 4, with numeric keys and containing strings of minimum length 5, that could be built like so:
$filter = Filter::array('min:4', 'int', 'string,min:5');
If we wanted to validate an associative array, we would use a "map" filter:
$array = array(
'foo' => 2,
'bar' => 'test',
);
$filter = Filter::map(array(
'foo' => 'int',
'bar' => 'string,min:4',
));
var_dump($filter->validate($array)); // true
Procedural Interface
Filterus also ships with a procedural interface for calling filters.
\Filterus\filter($var, $filter);
And
\Filterus\validate($var, $filter);
Any filter is supported (both are basically simple wrappers):
function \Filterus\filter($var, $filter) {
return \Filterus\Filter::factory($filter)->filter($var);
}
Both are just convenience functions.
Security Vulnerabilities
If you have found a security issue, please contact the author directly at me@ircmaxell.com.