deblan-mirror/respect-validation
deblan-mirror/respect-validation
1
0
Fork 0
mirror of https://github.com/Respect/Validation.git synced 2026-03-15 06:45:44 +01:00
Code Issues Projects Releases Packages Wiki Activity
respect-validation/docs/validators/KeySet.md
Alexandre Gomes Gaigalas 2a7f345e32 Streamline validators.md index 
Makes it so the index looks more like a cheatsheet, condensing
information instead of making long lists that require lots of
scrolling to explore.

Additionally, the happy path for each validator was also
added, providing a quick reference use for comparison.

The direct markdown links were replaced by titled markdown
references, offering mouse-over tooltips over links that
display the validator one-line description.

To ensure a proper source of truth for these new index
goodies, the AssertionMessageLinter was modified to
verify that the first assertion in each doc is a
single-line validator that passes (a happy path), further
making our documentation conventions more solid.
2026-01-28 12:47:08 +00:00

3.5 KiB
Raw Blame History

KeySet

  • KeySet(Validator $validator)
  • KeySet(Validator $validator, Validator ...$validators)

Validates a keys in a defined structure.

v::keySet(v::key('foo', v::intVal()))->assert(['foo' => 42]);
// Validation passes successfully

v::keySet(
    v::keyExists('foo'),
    v::keyExists('bar')
)->assert(['foo' => 'whatever', 'bar' => 'something']);
// Validation passes successfully

It will validate the keys in the array with the validators passed in the constructor.

v::keySet(
    v::key('foo', v::intVal())
)->assert(['foo' => 'string']);
// → `.foo` must be an integer value

Extra keys are not allowed:

v::keySet(
    v::key('foo', v::intVal())
)->assert(['foo' => 42, 'bar' => 'String']);
// → `.bar` must not be present

Missing required keys are not allowed:

v::keySet(
    v::key('foo', v::intVal()),
    v::key('bar', v::stringType()),
    v::key('baz', v::boolType())
)->assert(['foo' => 42, 'bar' => 'String']);
// → `.baz` must be present

Missing non-required keys are allowed:

v::keySet(
    v::key('foo', v::intVal()),
    v::key('bar', v::stringType()),
    v::keyOptional('baz', v::boolType())
)->assert(['foo' => 42, 'bar' => 'String']);
// Validation passes successfully

Alternatively, you can pass a chain of key-related validators to keySet():

v::keySet(
    v::init()
        ->key('foo', v::intVal())
        ->key('bar', v::stringType())
        ->keyOptional('baz', v::boolType())
)->assert(['foo' => 42, 'bar' => 'String']);
// Validation passes successfully

It is not possible to negate keySet() validators with not().

The keys' order is not considered in the validation.

Templates

KeySet::TEMPLATE_STANDARD

Mode Template
default {{subject}} validation failed
inverted {{subject}} validation passed

KeySet::TEMPLATE_BOTH

Mode Template
default {{subject}} contains both missing and extra keys
inverted {{subject}} contains no missing or extra keys.

KeySet::TEMPLATE_EXTRA_KEYS

Mode Template
default {{subject}} contains extra keys
inverted {{subject}} contains no extra keys

KeySet::TEMPLATE_MISSING_KEYS

Mode Template
default {{subject}} contains missing keys
inverted {{subject}} contains no missing keys

Template placeholders

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

Categorization

  • Arrays
  • Nesting
  • Structures

Changelog

Version Description
3.0.0 Requires at least one key-related validator
2.3.0 KeySet is NonNegatable, fixed message with extra keys
1.0.0 Created

See Also