respect-validation/docs/validators/Between.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
Introduces a Markdown linter for checking the Changelog format.

"See Also" was transformed into a section to make it easier to
handle it with the `Content` class. The "Related" linter was
simplified to reflect that change too.

An additional "alignment" parameter was added to markdown table
generators, allowing the padding and headers to be explicitly
marked with a specific left (-1), middle (0) or right(1)
alignment.

Existing files were fixed using the `fix` option after the
changes.
2026-01-26 19:11:00 +00:00

67 lines
1.9 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# Between
- `Between(mixed $minValue, mixed $maxValue)`
Validates whether the input is between two other values.
```php
v::intVal()->between(10, 20)->assert(10);
// Validation passes successfully
v::intVal()->between(10, 20)->assert(15);
// Validation passes successfully
v::intVal()->between(10, 20)->assert(20);
// Validation passes successfully
```
Validation makes comparison easier, check out our supported
[comparable values](../comparable-values.md).
Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
## Templates
### `Between::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :------------------------------------------------------------ |
| `default` | {{subject}} must be between {{minValue}} and {{maxValue}} |
| `inverted` | {{subject}} must not be between {{minValue}} and {{maxValue}} |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `maxValue` | The minimum value passed to the validator. |
| `minValue` | The maximum value passed to the validator. |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Comparisons
## Changelog
| Version | Description |
| ------: | :-------------------------- |
| 2.0.0 | Became always inclusive |
| 1.0.0 | Became inclusive by default |
| 0.3.9 | Created |
## See Also
- [BetweenExclusive](BetweenExclusive.md)
- [DateTime](DateTime.md)
- [GreaterThan](GreaterThan.md)
- [GreaterThanOrEqual](GreaterThanOrEqual.md)
- [Length](Length.md)
- [LessThan](LessThan.md)
- [LessThanOrEqual](LessThanOrEqual.md)
- [Max](Max.md)
- [Min](Min.md)