Key

  • Key(int|string $key, Validatable $rule)

Validates the value of an array against a given rule.

v::key('name', v::stringType())->validate(['name' => 'The Respect Panda']); // true

v::key('email', v::email())->validate(['email' => 'therespectpanda@gmail.com']); // true

v::key('age', v::intVal())->validate([]); // false

You can also use Key to validate nested arrays:

v::key(
    'payment_details',
    v::key('credit_card', v::creditCard())
)->validate([
    '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: