PropertyExists

• PropertyExists(string $propertyName)

Validates if an object property exists.

$object = new stdClass;
$object->name = 'The Respect Panda';
$object->email = '[email protected]';

v::propertyExists('name')->assert($object);
// Validation passes successfully

v::propertyExists('email')->assert($object);
// Validation passes successfully

v::propertyExists('website')->assert($object);
// → `.website` must be present

Notes

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

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

Templates

PropertyExists::TEMPLATE_STANDARD

Template placeholders

Caveats

PropertyExists defines the given $propertyName as the path, and because it is a standalone validator 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([]);
// → `.foo` must be present

v::named('Custom name', v::propertyExists('foo'))->assert([]);
// → `.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::named('Custom name', v::alwaysValid()))->assert([]);
// → Custom name must be present

Categorization

• Objects
• Structures

Changelog

See Also

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