mirror of https://github.com/Respect/Validation.git synced 2026-03-16 23:35:45 +01:00

Henrique Moody be72a54845

Add templates to each rule documentation

They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.

2024-12-06 00:21:47 +01:00

1.9 KiB

Raw Blame History

Max

Max(Rule $rule)

Validates the maximum value of the input against a given rule.

v::max(v::equals(30))->isValid([10, 20, 30]); // true

v::max(v::between('e', 'g'))->isValid(['b', 'd', 'f']); // true

v::max(v::greaterThan(new DateTime('today')))
        ->isValid([new DateTime('yesterday'), new DateTime('tomorrow')]); // true

v::max(v::greaterThan(15))->isValid([4, 8, 12]); // false

Note

This rule uses IterableType and NotEmpty internally. If an input is non-iterable or empty, the validation will fail.

Templates

Max::TEMPLATE_STANDARD

Mode	Template
`default`	As the maximum of {{name}},
`inverted`	As the maximum of {{name}},

Max::TEMPLATE_NAMED

Mode	Template
`default`	The maximum of
`inverted`	The maximum of

Template placeholders

Placeholder	Description
`name`	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

1.9 KiB Raw Blame History

Max