respect-validation/docs/rules/When.md
Henrique Moody 0c07060a04
Rename "Consecutive" to "Circuit"
The "Consecutive" rule is now renamed to "Circuit" to better reflect its
behavior of stopping at the first failure. I also favour this name
because it's much shorter.
2024-12-20 16:53:56 +01:00

1.4 KiB

When

  • When(Rule $if, Rule $then)
  • When(Rule $if, Rule $then, Rule $else)

A ternary validator that accepts three parameters.

When the $if validates, returns validation for $then. When the $if doesn't validate, returns validation for $else, if defined.

v::when(v::intVal(), v::positive(), v::notEmpty())->isValid(1); // true
v::when(v::intVal(), v::positive(), v::notEmpty())->isValid('not empty'); // true

v::when(v::intVal(), v::positive(), v::notEmpty())->isValid(-1); // false
v::when(v::intVal(), v::positive(), v::notEmpty())->isValid(''); // false

In the sample above, if $input is an integer, then it must be positive. If $input is not an integer, then it must not be empty. When $else is not defined use AlwaysInvalid

Templates

Template placeholders

Placeholder Description
name The validated input or the custom validator name (if specified).

Categorization

  • Conditions
  • Nesting

Changelog

Version Description
0.8.0 Allow to use rule without else
0.3.9 Created

See also: