respect-validation/docs/rules/When.md
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.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: