respect-validation/docs/Key.md
Henrique Moody 2a2e1d577e
Change how documentation of rules are presented
Rules are not always used from the alias `v`, neither called staticaly.
2017-03-27 17:26:21 +02:00

605 B

Key

  • new Key(string $name)
  • new Key(string $name, Validatable $rule)
  • new Key(string $name, 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.


See also: