mirror of https://github.com/Respect/Validation.git synced 2026-03-14 14:25: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.4 KiB

Raw Blame History

KeyOptional

KeyOptional(string|int $key, Validator $validator)

Validates the value of an array against a given validator when the key exists.

v::keyOptional('name', v::stringType())->assert([]);
// Validation passes successfully

v::keyOptional('name', v::stringType())->assert(['name' => 'The Respect Panda']);
// Validation passes successfully

v::keyOptional('email', v::email())->assert([]);
// Validation passes successfully

v::keyOptional('email', v::email())->assert(['email' => 'therespectpanda@gmail.com']);
// Validation passes successfully

v::keyOptional('age', v::intVal())->assert(['age' => 'Twenty-Five']);
// → `.age` must be an integer

The name of this validator is automatically set to the key name.

v::keyOptional('age', v::intVal())->assert(['age' => 'Twenty-Five']);
// → `.age` must be an integer

Note

This validator will pass for anything that is not an array because it will always pass when it doesn't find a key. If you want to ensure the input is an array, use ArrayType with it.

v::arrayType()->keyOptional('phone', v::phone())->assert('This is not an array');
// → "This is not an array" must be an array

Below are some other validators that are tightly related to KeyOptional:

To validate if a key exists, use KeyExists instead.
To validate an array against a given validator requiring the key to exist, use Key instead.

Templates

Template placeholders

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

Categorization

Arrays
Structures

Changelog

Version	Description
3.0.0	Created from Key

2.4 KiB Raw Blame History