ContextQMD
Back to Validation

KeyOptional

docs/validators/KeyOptional.md

3.1.12.4 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]> -->

KeyOptional

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

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

php
v::keyOptional('name', v::stringType())->assert([]);
// Validation passes successfully

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

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

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

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

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

php
v::keyOptional('age', v::intVal())->assert(['age' => 'Twenty-Five']);
// → `.age` must be an integer

Note

This validator 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.

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

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

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

Templates

Template placeholders

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

Categorization

  • Arrays
  • Structures

Changelog

VersionDescription
3.0.0Created from Key

See Also