docs/validators/NullOr.md
NullOr(Validator $validator)Validates the input using a defined validator when the input is not null.
v::nullOr(v::email())->assert(null);
// Validation passes successfully
v::nullOr(v::email())->assert('[email protected]');
// Validation passes successfully
v::nullOr(v::email())->assert('not an email');
// → "not an email" must be an email address or must be null
For convenience, you can use nullOr as a prefix to any validator:
v::nullOrEmail()->assert('not an email');
// → "not an email" must be an email address or must be null
v::nullOrBetween(1, 3)->assert(2);
// Validation passes successfully
v::nullOrBetween(1, 3)->assert(null);
// Validation passes successfully
NullOr::TEMPLATE_STANDARD| Mode | Template |
|---|---|
default | or must be null |
inverted | and must not be null |
The template serves as a suffix to the template of the inner validator.
v::nullOr(v::alpha())->assert('has1number');
// → "has1number" must consist only of letters (a-z) or must be null
v::not(v::nullOr(v::alpha()))->assert("alpha");
// → "alpha" must not consist only of letters (a-z) and must not be null
| 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 NullOr |
| 2.0.0 | Created as Nullable |