ContextQMD
Back to Validation

Key

docs/validators/Key.md

3.1.12.3 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> -->

Key

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

Validates the value of an array against a given validator.

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

v::key('email', v::email())->assert(['email' => '[email protected]']);
// Validation passes successfully

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

You can also use Key to validate nested arrays:

php
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.

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

v::key('email', v::email())->assert(['email' => 'not email']);
// → `.email` must be an 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

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Arrays
  • Nesting
  • Structures

Changelog

VersionDescription
3.0.0Templates changed
3.0.0Split by KeyExists and KeyOptional
0.3.9Created

See Also