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

Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance

This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.

2026-01-21 06:28:11 +00:00

2.1 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.1 KiB Raw Blame History

Key