respect-validation/docs/validators/Key.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
Introduces a Markdown linter for checking the Changelog format.

"See Also" was transformed into a section to make it easier to
handle it with the `Content` class. The "Related" linter was
simplified to reflect that change too.

An additional "alignment" parameter was added to markdown table
generators, allowing the padding and headers to be explicitly
marked with a specific left (-1), middle (0) or right(1)
alignment.

Existing files were fixed using the `fix` option after the
changes.
2026-01-26 19:11:00 +00:00

2.1 KiB

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

See Also