PositiveNumberValidationRule
in package
implements
ValidationRule
This filter ensures that a number provided to it was positive.
Tags
Interfaces, Classes and Traits
- ValidationRule
- Classes implementing this one indicate their ability to test a variable and verify that it's contents are according to what was expected.
Table of Contents
- $extendedMessage : string
- Additional information given to the user in case the validation did not succeed. This message can hold additional infos on how to solve the error.
- $message : string
- A message the validation error generated by this object should carry to give the end user information about the reason his input was rejected.
- __construct() : mixed
- test() : ValidationError|bool
- Tests a value with this validation rule. Returns the errors detected for this element or boolean false on no errors.
Properties
$extendedMessage
Additional information given to the user in case the validation did not succeed. This message can hold additional infos on how to solve the error.
private
string
$extendedMessage
$message
A message the validation error generated by this object should carry to give the end user information about the reason his input was rejected.
private
string
$message
Methods
__construct()
public
__construct(mixed $message[, mixed $extendedMessage = '' ]) : mixed
Parameters
- $message : mixed
- $extendedMessage : mixed = ''
Return values
mixed —test()
Tests a value with this validation rule. Returns the errors detected for this element or boolean false on no errors.
public
test(mixed $value) : ValidationError|bool
Parameters
- $value : mixed