mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 14:55:44 +01:00
7c681fec66I ran the `bin/console spdx --fix` with different strategies for different files. For most of the core classes, since they've been drastically rebuilt, I've run it with the `git-blame` strategy, for for the `src/Validators`, in which the API changed completely but the logic remains the same, I use the `git-log` strategy.
87 lines
2.3 KiB
Markdown
87 lines
2.3 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
-->
|
|
|
|
# Max
|
|
|
|
- `Max(Validator $validator)`
|
|
|
|
Validates the maximum value of the input against a given validator.
|
|
|
|
```php
|
|
v::max(v::equals(30))->assert([10, 20, 30]);
|
|
// Validation passes successfully
|
|
|
|
v::max(v::between('e', 'g'))->assert(['b', 'd', 'f']);
|
|
// Validation passes successfully
|
|
|
|
v::max(v::greaterThan(new DateTime('today')))
|
|
->assert([new DateTime('yesterday'), new DateTime('tomorrow')]);
|
|
// Validation passes successfully
|
|
|
|
v::max(v::greaterThan(15))->assert([4, 8, 12]);
|
|
// → The maximum of `[4, 8, 12]` must be greater than 15
|
|
```
|
|
|
|
## Note
|
|
|
|
This validator will pass if the input is empty. Use [Length](Length.md) with [GreaterThan][GreaterThan.md] to perform a stricter check:
|
|
|
|
```php
|
|
v::max(v::equals(10))->assert([]);
|
|
// Validation passes successfully
|
|
|
|
v::length(v::greaterThan(0))->max(v::equals(10))->assert([]);
|
|
// → The length of `[]` must be greater than 0
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Max::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :------------- |
|
|
| `default` | The maximum of |
|
|
| `inverted` | The maximum of |
|
|
|
|
## Template as prefix
|
|
|
|
The template serves as a prefix to the template of the inner validator.
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Comparisons
|
|
- Transformations
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :-------------------------- |
|
|
| 3.0.0 | Became a transformation |
|
|
| 2.0.0 | Became always inclusive |
|
|
| 1.0.0 | Became inclusive by default |
|
|
| 0.3.9 | Created |
|
|
|
|
## See Also
|
|
|
|
- [All](All.md)
|
|
- [Between](Between.md)
|
|
- [BetweenExclusive](BetweenExclusive.md)
|
|
- [DateTimeDiff](DateTimeDiff.md)
|
|
- [Falsy](Falsy.md)
|
|
- [GreaterThan](GreaterThan.md)
|
|
- [GreaterThanOrEqual](GreaterThanOrEqual.md)
|
|
- [IterableType](IterableType.md)
|
|
- [Length](Length.md)
|
|
- [LessThan](LessThan.md)
|
|
- [LessThanOrEqual](LessThanOrEqual.md)
|
|
- [Min](Min.md)
|