mirror of https://github.com/Respect/Validation.git synced 2026-03-14 22:35:45 +01:00

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.3 KiB

Raw Permalink Blame History

UndefOr

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.

Usage

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

Prefix

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

Templates

`UndefOr::TEMPLATE_STANDARD`

Mode	Template
`default`	or must be undefined
`inverted`	and must not be undefined

Template as suffix

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

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 `UndefOr`
1.0.0	Created as `Optional`

2.3 KiB Raw Permalink Blame History