mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 14:55:44 +01:00
b701fac656This commit introduces a mechanism for validators to return early once the validation outcome is determined, rather than evaluating all child validators. The ShortCircuit validator evaluates validators sequentially and stops at the first failure, similar to how PHP's && operator works. This is useful when later validators depend on earlier ones passing, or when you want only the first error message. The ShortCircuitCapable interface allows composite validators (AllOf, AnyOf, OneOf, NoneOf, Each, All) to implement their own short-circuit logic. Why "ShortCircuit" instead of "FailFast": The name "FailFast" was initially considered but proved misleading. While AllOf stops on failure (fail fast), AnyOf stops on success (succeed fast), and OneOf stops on the second success. The common behavior is not about failing quickly, but about returning as soon as the outcome is determined—which is exactly what short-circuit evaluation means. This terminology is familiar to developers from boolean operators (&& and ||), making the behavior immediately understandable. Co-authored-by: Alexandre Gomes Gaigalas <alganet@gmail.com> Assisted-by: Claude Code (Opus 4.5)
63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
-->
|
|
|
|
# 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.
|
|
|
|
```php
|
|
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](AlwaysInvalid.md)
|
|
|
|
## 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
|
|
|
|
- [AllOf](AllOf.md)
|
|
- [AlwaysInvalid](AlwaysInvalid.md)
|
|
- [AnyOf](AnyOf.md)
|
|
- [NoneOf](NoneOf.md)
|
|
- [OneOf](OneOf.md)
|
|
- [ShortCircuit](ShortCircuit.md)
|