Alpha
extends AbstractValidator
in package
Alphabetical validator class
Tags
Table of Contents
Properties
- $input : mixed
- Input value to test
- $message : string|null
- Validator message - The message provided when the validation fails
- $results : mixed
- Validator results - Optional results to collect post-validation, would be something that was set by a custom validator in its "evaluate" method
- $value : mixed
- Validator value to test against
Methods
- __construct() : mixed
- Constructor
- evaluate() : bool
- Method to evaluate the validator
- getInput() : mixed
- GEt the validator input
- getMessage() : string|null
- Get the validator default message
- getResults() : mixed
- Get the validator results
- getValue() : mixed
- Get the validator value
- hasResults() : bool
- Has validator results
- setInput() : AbstractValidator
- Set the validator input
- setMessage() : AbstractValidator
- Set the validator condition
- setValue() : AbstractValidator
- Set the validator value
Properties
$input
Input value to test
protected
mixed
$input
= null
$message
Validator message - The message provided when the validation fails
protected
string|null
$message
= null
$results
Validator results - Optional results to collect post-validation, would be something that was set by a custom validator in its "evaluate" method
protected
mixed
$results
= null
$value
Validator value to test against
protected
mixed
$value
= null
Methods
__construct()
Constructor
public
__construct([mixed $value = null ][, string|null $message = null ]) : mixed
Instantiate the validator object
Parameters
- $value : mixed = null
- $message : string|null = null
evaluate()
Method to evaluate the validator
public
evaluate([mixed $input = null ]) : bool
Parameters
- $input : mixed = null
Return values
boolgetInput()
GEt the validator input
public
getInput() : mixed
getMessage()
Get the validator default message
public
getMessage() : string|null
Return values
string|nullgetResults()
Get the validator results
public
getResults() : mixed
getValue()
Get the validator value
public
getValue() : mixed
hasResults()
Has validator results
public
hasResults() : bool
Return values
boolsetInput()
Set the validator input
public
setInput([mixed $input = null ]) : AbstractValidator
Parameters
- $input : mixed = null
Return values
AbstractValidatorsetMessage()
Set the validator condition
public
setMessage([string|null $message = null ]) : AbstractValidator
Parameters
- $message : string|null = null
Return values
AbstractValidatorsetValue()
Set the validator value
public
setValue(mixed $value) : AbstractValidator
Parameters
- $value : mixed