yalesov / arg-validator
Validate function arguments, extending typehinting capabilities of PHP.
Installs: 23 215
Dependents: 28
Suggesters: 0
Security: 0
Stars: 8
Watchers: 4
Forks: 3
Open Issues: 0
Requires
- php: >=5.3.3
Requires (Dev)
README
Solving several function argument validation/typehinting issues in PHP:
Primitive typehints:
function foo(string $foo) {}
Mixed / advanced typehints:
function foo(array|string|null $foo, int/*between 3-10*/ $bar) {}
"array of X" typehints:
function foo(Array_of_strings $foo) {}
Validating / typehinting "pseudo named function paramters" through array members:
/** * @param array $params * - 'foo' => string * - 'bar' => int */ function foo(array $params) {}
Declaring required constants in classes (interface-style function):
class Foo { /* const BAR required */ /* const BAZ required */ }
Installation
{ "require": { "yalesov/arg-validator": "2.*" } }
Usage
Simple argument validation
Validates that $foo
is an integer, throwing an InvalidArgumentException
if validation failed.
use Yalesov\ArgValidator\ArgValidator; function foo($foo) { ArgValidator::assert($foo, 'int'); // throw InvalidArgumentException if $foo is not int // do something }
Validates that $foo
is an integer, return boolean.
use Yalesov\ArgValidator\ArgValidator; function foo($foo) { $result = ArgValidator::assert($foo, 'int', false); // $result = false if invalid // do something }
Full function signature:
public static function assert($arg, $checks, $exception = true)
Valid argument types are specified through the $checks
parameter. A string, or an array of the following accepted. $arg
will be considered valid if it satisfies any one of the specified checks.
- Flags
arrayof
: will check for an array of remaining specified types, instead of plain types, e.g.array('arrayOf', 'string', 'int')
= an array of string, or an array of int. Note: Empty array will be considered validmin
,max
- combine with
int
,float
: min and max value - combine with
string
: min and max length - combine with
array
: min and max count
- combine with
- Types
int
float
numeric
string
array
null
callable
bool
resource
notEmpty
: equivalent to!empty()
- (an array of scalars for in_array check), e.g.
array('foo', 'bar')
will check forin_array($arg, array('foo', 'bar'))
. Note:ArgValidator::assert($arg, array('foo', 'bar'))
will be interpreted as instanceof checks againstfoo
andbar
. To specify an in_array check, wrap it in another array:ArgValidator::assert($arg, array(array('foo', 'bar')))
. - (a string): assumed to be an instanceof check, should be a fully-qualified name of Class/Interface
"Named parameters" validation
use Yalesov\ArgValidator\ArgValidator; function foo(array $params) { ArgValidator::arrayAssert($params, array( 'foo' => 'float', 'bar' => array('string', 'notSet'), 'baz' => array('int', 'string', 'min' => 2), )); // $params['foo'] should be a float // $params['bar'] should be a string, if set, or not set at all // $params['baz'] can be either an int (>=2), or a string (strlen >= 2) }
Full function signature:
public static function arrayAssert(array $arg, array $checks, $exception = true)
Valid argument types are same as above, except with the addition of a notSet
type.
Check class constants
namespace Foo; use Yalesov\ArgValidator\ArgValidator; class FooClass { const FOO = 'foo'; const BAR = 2; } ArgValidator::assertClassConstant('Foo\FooClass', array('FOO', 'BAR')); // \Foo\FooClass must have the constants 'FOO' and 'BAR' set
Full function signature:
public static function assertClassConstant($className, $constants, $exception = true)
$className
should be a fully-qualified class name; $constants
should be an array of strings, each member being the constant name.
ArgValidator::assertClassConstant()
will check for:
- the class
$className
exists - the class has declared the required constants specified in
$constants
Misc
To centralize exception handling on argument validations, ArgValidator also provides two helper functions:
Assert that a class exists, throw InvalidArgumentException
otherwise:
public static function assertClass($className, $exception = true)
Throw an InvalidArgumentException
about the given variable name is not set:
public static function throwIssetException($argName)
Note: this function doesn't actually perform the isset
check. I can't find a way to abstract the isset
check away, without the variable being set in the first place (in order to act as argument to call this function with).