mirror of
https://github.com/Respect/Validation.git
synced 2026-03-17 15:50:03 +01:00
061a3c9c09The method has been renamed some time ago, but I haven't updated the documentation to cause less confusion. Now that I want to start updating the documentation, I switched the default branch on GitHub to the latest stable version, so I assume there will be less confusion in the documentation, and I can start updating the docs for the next version.
1.6 KiB
1.6 KiB
Key
Key(int|string $key, Validatable $rule)
Validates the value of an array against a given rule.
v::key('name', v::stringType())->isValid(['name' => 'The Respect Panda']); // true
v::key('email', v::email())->isValid(['email' => 'therespectpanda@gmail.com']); // true
v::key('age', v::intVal())->isValid([]); // false
You can also use Key to validate nested arrays:
v::key(
'payment_details',
v::key('credit_card', v::creditCard())
)->isValid([
'payment_details' => [
'credit_card' => '5376 7473 9720 8720',
],
]); // true
The name of this validator is automatically set to the key name.
v::key('email', v::email())->assert([]);
// message: email must be present
v::key('email', v::email())->assert(['email' => 'not email']);
// message: email must be valid email
Note
- To validate if a key exists, use KeyExists instead.
- To validate an array against a given rule if the key exists, use KeyOptional instead.
Categorization
- Arrays
- Nesting
- Structures
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Split by KeyExists and KeyOptional |
| 0.3.9 | Created |
See also: