mirror of https://github.com/Respect/Validation.git synced 2026-03-17 23:59:51 +01:00

Henrique Moody be72a54845

Add templates to each rule documentation

They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.

2024-12-06 00:21:47 +01:00

1.6 KiB

Raw Blame History

PropertyExists

PropertyExists(string $propertyName)

Validates if an object property exists.

$object = new stdClass;
$object->name = 'The Respect Panda';
$object->email = 'therespectpanda@gmail.com';

v::propertyExists('name')->isValid($object); // true
v::propertyExists('email')->isValid($object); // true
v::propertyExists('website')->isValid($object); // false

Notes

This rule will validate public, private, protected, uninitialised, and static properties.

To validate a property against a given rule requiring the property to exist, use Property instead.
To validate a property against a given rule only if the property exists, use PropertyOptional instead.

Templates

PropertyExists::TEMPLATE_STANDARD

Mode	Template
`default`	{{name}} must be present
`inverted`	{{name}} must not be present

Template placeholders

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

Categorization

Objects
Structures

Changelog

Version	Description
3.0.0	Created from Property

1.6 KiB Raw Blame History