mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 14:55:44 +01:00
16148e9593
- 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.
84 lines
2.4 KiB
Markdown
84 lines
2.4 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
-->
|
|
|
|
# KeyOptional
|
|
|
|
- `KeyOptional(string|int $key, Validator $validator)`
|
|
|
|
Validates the value of an array against a given validator when the key exists.
|
|
|
|
```php
|
|
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.
|
|
|
|
```php
|
|
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](ArrayType.md) with it.
|
|
|
|
```php
|
|
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](KeyExists.md) instead.
|
|
- To validate an array against a given validator requiring the key to exist, use [Key](Key.md) 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](Key.md) |
|
|
|
|
## See Also
|
|
|
|
- [ArrayType](ArrayType.md)
|
|
- [ArrayVal](ArrayVal.md)
|
|
- [Each](Each.md)
|
|
- [Key](Key.md)
|
|
- [KeyExists](KeyExists.md)
|
|
- [Property](Property.md)
|
|
- [PropertyExists](PropertyExists.md)
|
|
- [PropertyOptional](PropertyOptional.md)
|
|
|
|
[array]: https://www.php.net/array
|
|
[ArrayAccess]: https://www.php.net/arrayaccess
|