mirror of https://github.com/Respect/Validation.git synced 2026-03-15 06:45:44 +01:00

Henrique Moody d2198dfd01

Replace isValid() calls with assert()

There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.

2026-01-13 23:37:06 -07:00

2 KiB

Raw Blame History

Key

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

Validates the value of an array against a given validator.

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

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

v::key('age', v::intVal())->assert([]);
// → `.age` must be present

You can also use Key to validate nested arrays:

v::key(
    'payment_details',
    v::key('credit_card', v::creditCard())
)->assert([
    'payment_details' => [
        'credit_card' => '5376 7473 9720 8720',
    ],
]);
// Validation passes successfully

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

v::key('email', v::email())->assert([]);
// → `.email` must be present

v::key('email', v::email())->assert(['email' => 'not email']);
// → `.email` must be a valid email address

Note

To validate if a key exists, use KeyExists instead.
To validate an array against a given validator if the key exists, use KeyOptional instead.

Templates

Template placeholders

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

Categorization

Arrays
Nesting
Structures

Changelog

Version	Description
3.0.0	Split by KeyExists and KeyOptional
0.3.9	Created

2 KiB Raw Blame History

Key