docs/validators/UndefOr.md
UndefOr(Validator $validator)Validates the input using a defined validator when the input is not null or an empty string ('').
This validator can be particularly useful when validating form fields.
v::undefOr(v::alpha())->assert('');
// Validation passes successfully
v::undefOr(v::digit())->assert(null);
// Validation passes successfully
v::undefOr(v::alpha())->assert('username');
// Validation passes successfully
v::undefOr(v::alpha())->assert('has1number');
// → "has1number" must consist only of letters (a-z) or must be undefined
For convenience, you can use the undefOr as a prefix to any validator:
v::undefOrEmail()->assert('not an email');
// → "not an email" must be an email address or must be undefined
v::undefOrBetween(1, 3)->assert(2);
// Validation passes successfully
UndefOr::TEMPLATE_STANDARD| Mode | Template |
|---|---|
default | or must be undefined |
inverted | and must not be undefined |
The template serves as a suffix to the template of the inner validator.
v::undefOr(v::alpha())->assert('has1number');
// → "has1number" must consist only of letters (a-z) or must be undefined
v::not(v::undefOr(v::alpha()))->assert("alpha");
// → "alpha" must not consist only of letters (a-z) and must not be undefined
| Placeholder | Description |
|---|---|
subject | The validated input or the custom validator name (if specified). |
| Version | Description |
|---|---|
| 3.0.0 | Templates changed |
| 3.0.0 | Renamed to UndefOr |
| 1.0.0 | Created as Optional |