03-rules_range.md

Range

Validates that a value is between a minimum and maximum value. Can compare between strings, numbers and dates.

Range(
    mixed $min,
    mixed $max,
    ?string $message = null
);

Basic Usage

Values equal to the defined minimum and maximum values are considered valid.

Validator::range(1, 20)->validate(10); // true
Validator::range(1, 20)->validate(1); // true

Validator::range(1.5, 3.5)->validate(2.5); // true
Validator::range(1.5, 3.5)->validate(3.5); // true

Validator::range('alpha', 'gamma')->validate('beta'); // true
Validator::range('alpha', 'gamma')->validate('alpha'); // true

Validator::range(new DateTime('yesterday'), new DateTime('tomorrow'))->validate(new DateTime('today')); // true
Validator::range(new DateTime('yesterday'), new DateTime('tomorrow'))->validate(new DateTime('tomorrow')); // true

Note

String comparison is case-sensitive, meaning that comparing "hello" with "Hello" is different. Check strcmp for more information.

Note

An UnexpectedValueException will be thrown when trying to compare incomparable values, like a string with an int.

Options

min

type: mixed required

It defines the minimum range value. Can be a string, int, float or DateTimeInterface object.

max

type: mixed required

It defines the maximum range value. Can be a string, int, float or DateTimeInterface object.

message

type: ?string default: The {{ name }} value should be between {{ min }} and {{ max }}.

Message that will be shown if the value is not between the minimum and maximum values.

The following parameters are available:

Parameter	Description
{{ value }}	The current invalid value
{{ name }}	Name of the invalid value
{{ min }}	The minimum range value
{{ max }}	The maximum range value

Changelog

• 0.1.0 Created