ValidatorInterface
Contract for a validator
Table of Contents
Methods
- getOptions() : array<string|int, mixed>
- Returns the options of this validator which can be specified by setOptions().
- getRequest() : ServerRequestInterface|null
- Returns the request object of the validator.
- setOptions() : void
- Receive validator options from framework.
- setRequest() : void
- Sets the request object to the validator.
- validate() : Result
- Checks if the given value is valid according to the validator, and returns the Error Messages object which occurred.
Methods
getOptions()
Returns the options of this validator which can be specified by setOptions().
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getRequest()
Returns the request object of the validator.
public
getRequest() : ServerRequestInterface|null
Return values
ServerRequestInterface|nullsetOptions()
Receive validator options from framework.
public
setOptions(array<string|int, mixed> $options) : void
Parameters
- $options : array<string|int, mixed>
setRequest()
Sets the request object to the validator.
public
setRequest(ServerRequestInterface|null $request) : void
Parameters
- $request : ServerRequestInterface|null
validate()
Checks if the given value is valid according to the validator, and returns the Error Messages object which occurred.
public
validate(mixed $value) : Result
Parameters
- $value : mixed
-
The value that should be validated