respect-validation/docs/validators/NullOr.md
Alexandre Gomes Gaigalas 16148e9593 Standardize and improve validation message templates
- Remove redundant "valid" prefix:
   Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version.

 - Remove redundant "value" suffix
   ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal.

 - Standardize "consist only of" phrasing
   Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit.

 - Improve file accessibility messages
   Directory, Executable, File, Image, Readable, SymbolicLink, Writable.

 - Improve grammar and article usage
   CreditCard, Extension, Mimetype, Regex, Size.
2026-02-03 19:58:55 +00:00

2.1 KiB

NullOr

  • NullOr(Validator $validator)

Validates the input using a defined validator when the input is not null.

Usage

v::nullOr(v::email())->assert(null);
// Validation passes successfully

v::nullOr(v::email())->assert('example@example.com');
// Validation passes successfully

v::nullOr(v::email())->assert('not an email');
// → "not an email" must be an email address or must be null

Prefix

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

Templates

NullOr::TEMPLATE_STANDARD

Mode Template
default or must be null
inverted and must not be null

Template as suffix

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

Template placeholders

Placeholder Description
subject The validated input or the custom validator name (if specified).

Categorization

  • Nesting

Changelog

Version Description
3.0.0 Templates changed
3.0.0 Renamed to NullOr
2.0.0 Created as Nullable

See Also