Skip to content

Max.md

Latest commit

 

History

History
87 lines (63 loc) · 2.29 KB

Max.md

File metadata and controls

87 lines (63 loc) · 2.29 KB

Max

  • Max(Validator $validator)

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

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 with [GreaterThan][GreaterThan.md] to perform a stricter check:

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