respect-validation/docs/rules/When.md
Henrique Moody 061a3c9c09
Rename method "validate()" to "isValid()"
The method has been renamed some time ago, but I haven't updated the
documentation to cause less confusion. Now that I want to start updating
the documentation, I switched the default branch on GitHub to the latest
stable version, so I assume there will be less confusion in the
documentation, and I can start updating the docs for the next version.
2024-12-02 22:11:57 +01:00

1.1 KiB

When

  • When(Validatable $if, Validatable $then)
  • When(Validatable $if, Validatable $then, Validatable $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

Categorization

  • Conditions
  • Nesting

Changelog

Version Description
0.8.0 Allow to use rule without else
0.3.9 Created

See also: