respect-validation/docs/Between.md
Henrique Moody 0338e18e83
Rename rule "Date" to "DateTime"
Also change rules to use `DateTimeInterface` and `DateTimeImmutable`
when possible.
2017-05-01 13:16:59 +02:00

51 lines
1 KiB
Markdown

# Between
- `Between(mixed $start, mixed $end)`
- `Between(mixed $start, mixed $end, bool $inclusive)`
Validates ranges. Most simple example:
```php
v::intVal()->between(10, 20)->validate(15); // true
```
The type as the first validator in a chain is a good practice,
since between accepts many types:
```php
v::stringType()->between('a', 'f')->validate('c'); // true
```
Also very powerful with dates:
```php
v::dateTime()->between('2009-01-01', '2013-01-01')->validate('2010-01-01'); // true
```
Date ranges accept strtotime values:
```php
v::dateTime()->between('yesterday', 'tomorrow')->validate('now'); // true
```
A third parameter may be passed to validate the passed values inclusive:
```php
v::dateTime()->between(10, 20, true)->validate(20); // true
```
Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
## Changelog
Version | Description
--------|-------------
1.0.0 | Became inclusive by default
0.3.9 | Created
***
See also:
- [Length](Length.md)
- [Min](Min.md)
- [Max](Max.md)