deblan-mirror/respect-validation
deblan-mirror/respect-validation
1
0
Fork 0
mirror of https://github.com/Respect/Validation.git synced 2026-03-14 22:35:45 +01:00
Code Issues Projects Releases Packages Wiki Activity
respect-validation/docs/validators/KeyOptional.md
Henrique Moody 7db3bea8a6
 Enhance LintSpdxCommand with contributor tracking and header normalization 
Improves SPDX header linting to ensure consistent license metadata across
the codebase.

Key changes:

- Enforce deterministic tag ordering (License-Identifier, FileCopyrightText,
  FileContributor) to ensure consistency, prevent merge conflicts, and
  simplify code reviews

- Add contributor alias mapping to consolidate contributors with multiple
  emails or name variations (e.g., "nickl-" → "Nick Lombard")

- Add --contributions-strategy option with "blame" (current code authors)
  and "log" (all historical contributors) to support different attribution
  philosophies

- Add optional path argument to lint specific files or directories

- Add --fix option to automatically correct header issues

Assisted-by: Claude Code (claude-opus-4-5-20251101)
2026-02-03 15:23:20 +01:00

2.3 KiB
Raw Blame History

KeyOptional

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

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

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' => 'therespectpanda@gmail.com']);
// Validation passes successfully

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

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

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

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.

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

Placeholder Description
subject The validated input or the custom validator name (if specified).

Categorization

  • Arrays
  • Structures

Changelog

Version Description
3.0.0 Created from Key

See Also