Back to Validation

Max

docs/validators/Max.md

3.1.12.3 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> -->

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 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

ModeTemplate
defaultThe maximum of
invertedThe maximum of

Template as prefix

The template serves as a prefix to the template of the inner validator.

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Comparisons
  • Transformations

Changelog

VersionDescription
3.0.0Became a transformation
2.0.0Became always inclusive
1.0.0Became inclusive by default
0.3.9Created

See Also