respect-validation/docs/rules/Key.md
Henrique Moody 10df3211f5
Add "Categorization" section to rule documentations
Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
2019-05-11 19:16:21 +02:00

835 B

Key

  • Key(mixed $key)
  • Key(mixed $key, Validatable $rule)
  • Key(mixed $key, Validatable $rule, bool $mandatory)

Validates an array key.

$dict = [
    'foo' => 'bar'
];

v::key('foo')->validate($dict); // true

You can also validate the key value itself:

v::key('foo', v::equals('bar'))->validate($dict); // true

Third parameter makes the key presence optional:

v::key('lorem', v::stringType(), false)->validate($dict); // true

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

Categorization

  • Arrays
  • Nesting
  • Structures

Changelog

Version Description
0.3.9 Created

See also: