respect-validation/docs/rules/PropertyExists.md

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	{{subject}} must be present
inverted	{{subject}} must not be present

Template placeholders

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

Caveats

PropertyExists defines the given $propertyName as the path, and because it is a standalone rule without children, it's not possible to display a fully custom name with it.

When no custom name is set, the path is displayed as {{name}}. When a custom name is set, the validation engine prepends the path to the custom name:

v::propertyExists('foo')->assert([]);
// Message: `.foo` must be present

v::propertyExists('foo')->setName('Custom name')->assert([]);
// Message: `.foo` (<- Custom name) must be present

If you want to display only a custom name while checking if a property exists, use Property with AlwaysValid:

v::property('foo', v::alwaysValid()->setName('Custom name'))->assert([]);
// Message: Custom name must be present

Categorization

• Objects
• Structures

Changelog

Version	Description
3.0.0	Created from Property

---

See also:

• AlwaysValid
• Attributes
• Key
• KeyExists
• KeyOptional
• ObjectType
• Property
• PropertyOptional