Class SchemaValidator
Default parameter validator
- Guzzle\Service\Description\SchemaValidator implements Guzzle\Service\Description\ValidatorInterface
Methods summary
-
public staticgetInstance ( ) -
public__construct ( bool $castIntegerToStringType = true ) -
publicvalidate ( Guzzle\Service\Description\Parameter $param, mixed & $value )Validate a value against the acceptable types, regular expressions, minimum, maximums, instanceOf, enums, etc Add default and static values to the passed in variable. If the validation completes successfully, the input must be run correctly through the matching schema's filters attribute.
-
publicgetErrors ( )Get the errors encountered while validating
-
protectedrecursiveProcess ( Guzzle\Service\Description\Parameter $param, mixed & $value, string $path = '', int $depth = 0 )Recursively validate a parameter
-
protecteddetermineType ( string $type, mixed $value )From the allowable types, determine the type that the variable matches
Methods detail
Parameters
- $castIntegerToStringType
boolean
$castIntegerToStringType Set to true to convert integers into strings when a required type is a string and the input value is an integer. Defaults to true.
Validate a value against the acceptable types, regular expressions, minimum, maximums, instanceOf, enums, etc Add default and static values to the passed in variable. If the validation completes successfully, the input must be run correctly through the matching schema's filters attribute.
Parameters
- $param
Guzzle\Service\Description\Parameter
$param Schema that is being validated against the value- $value
mixed
$value Value to validate and process. The value may change during this process.
Returns
booleanReturns true if the input data is valid for the schema
Implementation of
Get the errors encountered while validating
Returns
arrayImplementation of
protected
boolean
recursiveProcess( Guzzle\Service\Description\Parameter $param, mixed & $value, string $path = '', integer $depth = 0 )
Recursively validate a parameter
Parameters
- $param
Guzzle\Service\Description\Parameter
$param API parameter being validated- $value
mixed
$value Value to validate and validate. The value may change during this validate.- $path
string
$path Current validation path (used for error reporting)- $depth
integer
$depth Current depth in the validation validate
Returns
booleanReturns true if valid, or false if invalid
From the allowable types, determine the type that the variable matches
Parameters
- $type
string
$type Parameter type- $value
mixed
$value Value to determine the type
Returns
string|booleanReturns the matching type on
Magic methods summary
Properties summary
protected static
|
$instance |
#
Cache instance of the object |
protected
boolean
|
$castIntegerToStringType |
#
Whether or not integers are converted to strings when an integer is received for a string input |
protected
array
|
$errors |
#
Errors encountered while validating |