respect-validation/docs/rules/KeyExists.md
Henrique Moody 061a3c9c09
Rename method "validate()" to "isValid()"
The method has been renamed some time ago, but I haven't updated the
documentation to cause less confusion. Now that I want to start updating
the documentation, I switched the default branch on GitHub to the latest
stable version, so I assume there will be less confusion in the
documentation, and I can start updating the docs for the next version.
2024-12-02 22:11:57 +01:00

1.1 KiB

KeyExists

  • KeyExists(int|string $key)

Validates if the given key exists in an array.

v::keyExists('name')->isValid(['name' => 'The Respect Panda']); // true
v::keyExists('name')->isValid(['email' => 'therespectpanda@gmail.com']); // false

v::keyExists(0)->isValid(['a', 'b', 'c']); // true
v::keyExists(4)->isValid(['a', 'b', 'c']); // false

v::keyExists('username')->isValid(new ArrayObject(['username' => 'therespectpanda'])); // true
v::keyExists(5)->isValid(new ArrayObject(['a', 'b', 'c'])); // false

Notes

  • To validate an array against a given rule if the key exists, use KeyOptional 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: