deblan-mirror/respect-validation
deblan-mirror/respect-validation
1
0
Fork 0
mirror of https://github.com/Respect/Validation.git synced 2026-03-16 15:25:45 +01:00
Code Issues Projects Releases Packages Wiki Activity
respect-validation/docs/rules/KeySet.md
Alexandre Gomes Gaigalas fc8230acef Make KeySet impossible to wrap in not(), fix structure message 
The use case for negating a keyset is very confusing, and can
lead to validators that don't do what they expect.

This commit introduces NonNegatable rules, which will throw
a Component exception if you try to wrap them in `Not`.

This change was necessary to ensure proper message reporting
when extra keys exist on the keyset.

This fixes #1349
2023-02-19 00:19:10 -03:00

1.2 KiB
Raw Blame History

KeySet

  • KeySet(Key ...$rule)

Validates a keys in a defined structure.

$dict = ['foo' => 42];

v::keySet(
    v::key('foo', v::intVal())
)->validate($dict); // true

Extra keys are not allowed:

$dict = ['foo' => 42, 'bar' => 'String'];

v::keySet(
    v::key('foo', v::intVal())
)->validate($dict); // false

Missing required keys are not allowed:

$dict = ['foo' => 42, 'bar' => 'String'];

v::keySet(
    v::key('foo', v::intVal()),
    v::key('bar', v::stringType()),
    v::key('baz', v::boolType())
)->validate($dict); // false

Missing non-required keys are allowed:

$dict = ['foo' => 42, 'bar' => 'String'];

v::keySet(
    v::key('foo', v::intVal()),
    v::key('bar', v::stringType()),
    v::key('baz', v::boolType(), false)
)->validate($dict); // true

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

The keys' order is not considered in the validation.

Categorization

  • Arrays
  • Nesting
  • Structures

Changelog

Version Description
2.3.0 KeySet is NonNegatable, fixed message with extra keys
1.0.0 Created

See also: