docs/validators/PropertyOptional.md
PropertyOptional(string $propertyName, Validator $validator)Validates an object property against a given validator only if the property exists.
$object = new stdClass;
$object->name = 'The Respect Panda';
$object->email = '[email protected]';
v::propertyOptional('name', v::notBlank())->assert($object);
// Validation passes successfully
v::propertyOptional('email', v::email())->assert($object);
// Validation passes successfully
v::propertyOptional('age', v::intVal())->assert($object);
// Validation passes successfully
v::propertyOptional('website', v::url())->assert($object);
// Validation passes successfully
v::propertyOptional('name', v::lowercase())->assert($object);
// → `.name` must consist only of lowercase letters
The name of this validator is automatically set to the property name.
v::propertyOptional('email', v::endsWith('@example.com'))->assert($object);
// → `.email` must end with "@example.com"
This validator will validate public, private, protected, uninitialised, and static properties. However, it will pass for anything that is not an object because it will always pass when it doesn't find a property in the input. If you want to ensure the input is an object, use ObjectType with it.
v::propertyOptional('name', v::notBlank())->assert('Not an object');
// Validation passes successfully
v::objectType()->propertyOptional('name', v::notBlank())->assert('Not an object');
// → "Not an object" must be an object
| Placeholder | Description |
|---|---|
subject | The validated input or the custom validator name (if specified). |
| Version | Description |
|---|---|
| 3.0.0 | Created from Property |