sphplayground sphplayground

Validating numeric data

Numeric data validators validate float values and int values and numeric strings. A PHP string is considered numeric if it can be interpreted as an int or a float[1].

Validators:

  1. SmallerThan is lower bound validator: the length of the input must be atleast a given limit.
  2. GreaterThan is upper bound validator: the length of the input must be below a given limit.
  3. Between validator: value must be between the lower and upper limits.

About error messages provided by validators: An error message is a relatively short text message that describes a problematic situation. An error message generally indicates that an operation failed and may imply if not direct the user to a corrective action.[2]

Predefined error message Template formatting parameters:

  1. :value - the string representation of the validated $value
  2. :type - the datatype of the validated $value
    1. :type = "boolean" - for boolean type
    2. :type = "integer" - for integer type
    3. :type = "float" - for float type
    4. :type = "string" - for string type
    5. :type = "array" - for array type
    6. :type = "object" - for object type
    7. :type = "resource" - for resource type
    8. :type = "resource (closed)" - for closed resource type
    9. :type = "NULL" - for nulls
    10. :type = "unknown type" - for unknown types
  3. :strict-type - the strict datatype of the validated $value differs from :type
    1. any object corresponds to the name of the class get_class() results

The Between validator

The Between validator validates whether numeric input is between two numbers. This range is either inclusive or exclusive.

Validator specific predefined errormessage Template formatting parameters:

  1. :min - the minumum allowed value of the validated $value
  2. :max - the maximum allowed value of the validated $value
Synopsis
class Between extends AbstractLimitValidator
ID for error message describing values not matching an exclusive limit
public const string INVALID_TYPE
ID for default error message
public const string INVALID
Constructs a new validator
public __construct(float $min, float $max, bool $inclusive = true)
Validates given value
public isValid(mixed $value):bool
Checks whether the the limit is set as inclusive or not
public isInclusive():bool
Invoke validator as a command
public __invoke(mixed $value):bool
Sets an error message template
public setErrorTemplate(string|int $id, TemplateInterface|string $template):void
Returns error message templates
public getErrorTemplates():TemplateContainer
Returns error messages
public getErrors():MessageContainer

The SmallerThan validator

The SmallerThan validator validates whether a float or an int input is msaller than or equal to a treshold value.

Validator specific predefined errormessage Template formatting parameters:

  1. :max - the maximum allowed value of the validated $value
Synopsis
class SmallerThan extends AbstractLimitValidator
ID for error message describing values not matching an exclusive limit
public const string INVALID_TYPE
ID for default error message
public const string INVALID
Constructs a new validator
public __construct(float $max, bool $inclusive = true)
Validates given value
public isValid(mixed $value):bool
Checks whether the the limit is set as inclusive or not
public isInclusive():bool
Invoke validator as a command
public __invoke(mixed $value):bool
Sets an error message template
public setErrorTemplate(string|int $id, TemplateInterface|string $template):void
Returns error message templates
public getErrorTemplates():TemplateContainer
Returns error messages
public getErrors():MessageContainer

The GreaterThan validator

The GreaterThan validator validates whether a float or an int input is greater than or equal to a treshold value.

Validator specific predefined errormessage Template formatting parameters:

  1. :min - the minumum allowed value of the validated $value
Synopsis
class GreaterThan extends AbstractLimitValidator
ID for error message describing values not matching an exclusive limit
public const string INVALID_TYPE
ID for default error message
public const string INVALID
Constructs a new validator
public __construct(float $min, bool $inclusive = true)
Validates given value
public isValid(mixed $value):bool
Checks whether the the limit is set as inclusive or not
public isInclusive():bool
Invoke validator as a command
public __invoke(mixed $value):bool
Sets an error message template
public setErrorTemplate(string|int $id, TemplateInterface|string $template):void
Returns error message templates
public getErrorTemplates():TemplateContainer
Returns error messages
public getErrors():MessageContainer