respect-validation/docs/validators/When.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.
2026-01-21 06:28:11 +00:00

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