KeyOptional

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

Validates the value of an array against a given rule when the key exists.

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

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

v::keyOptional('age', v::intVal())->validate(['age' => 'Twenty-Five']); // false

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

v::keyOptional('age', v::intVal())->assert(['age' => 'Twenty-Five']);
// message: age must be an integer number

Note

This rule will pass for anything that is not an array because it will always pass when it doesn't find a key. If you want to ensure the input is an array, use ArrayType with it.

v::arrayType()->keyOptional('phone', v::phone())->assert('This is not an array');
// message: "This is not an array" must be of type array

Below are some other rules that are tightly related to KeyOptional:

  • To validate if a key exists, use KeyExists instead.
  • To validate an array against a given rule requiring the key to exist, use Key instead.

Categorization

  • Arrays
  • Structures

Changelog

Version Description
3.0.0 Created from Key
***
See also: