respect-validation/docs/validators/When.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

1.6 KiB

When

  • When(Validator $when, Validator $then)
  • When(Validator $when, Validator $then, Validator $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::notBlank())->assert(1);
// Validation passes successfully

v::when(v::intVal(), v::positive(), v::notBlank())->assert('non-blank string');
// Validation passes successfully

v::when(v::intVal(), v::positive(), v::notBlank())->assert(-1);
// → -1 must be a positive number

v::when(v::intVal(), v::positive(), v::notBlank())->assert('');
// → "" must not be blank

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 blank. When $else is not defined use AlwaysInvalid

Templates

Template placeholders

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

Categorization

  • Conditions
  • Nesting

Changelog

Version Description
0.8.0 Allow to use validator without else
0.3.9 Created

See also: