ParameterValidationRule

This function is an inner wrapper for ParameterTypeValidator inside ValidationHandler parameter maps. <b>Don't instantiate this class</b>, if you want to add custom ParameterTypeValidator to a parameter use functions in

see
package

Default

Methods

__construct

__construct() 

allowEmptyValue is used in query, header, cookie and form parameters. This is its behaviour: <ol> <li>During validation, the ValidationHandler check if there's a parameter with combination of location and name as defined in this rule </li> <li>If it not exists, It will check allowEmptyValue and if there's a default value set inside ParameterTypeValidator:</li> <ul> <li>If this condition it's true, It marks as validated the parameter and returns the default value (inside RequestParameter)</li> <li>If this condition it's false, It throws ValidationException</li> </ul> <li>If the parameter exists, It checks if parameter is null or empty string:</li> <ul> <li>If allowEmptyValue it's true, It marks as validated the parameter and returns the default value if it exists (inside RequestParameter)</li> <li>If allowEmptyValue it's false, It throws ValidationException</li> </ul> </ol>

allowEmptyValue() : boolean

Response

boolean

value of allowEmptyValue

This function return the name of the parameter expected into parameter lists

getName() : string

Response

string

name of the parameter

Return true if parameter is optional

isOptional() : boolean

Response

boolean

true if is optional, false otherwise

Return ParameterTypeValidator instance used inside this parameter validation rule

parameterTypeValidator() : \io\vertx\jphp\ext\web\api\validation\ParameterTypeValidator

This function will be called when there is a List<String> that need to be validated. It must check if array is expected or not. It will throw a ValidationError in an error during validation occurs

validateArrayParam( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

array

Response

\io\vertx\jphp\ext\web\api\RequestParameter

This function will be called when there is only a string as parameter. It will throw a ValidationError in an error during validation occurs

validateSingleParam( $arg0) : \io\vertx\jphp\ext\web\api\RequestParameter

Arguments

$arg0

string

Response

\io\vertx\jphp\ext\web\api\RequestParameter