mirror of https://github.com/Respect/Validation.git synced 2026-03-16 23:35:45 +01:00

Henrique Moody d2198dfd01

Replace isValid() calls with assert()

There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.

2026-01-13 23:37:06 -07:00

2.3 KiB

Raw Blame History

Property

Property(string $propertyName, Validator $validator)

Validates an object property against a given validator.

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

v::property('name', v::equals('The Respect Panda'))->assert($object);
// Validation passes successfully

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

v::property('email', v::email()->endsWith('@example.com'))->assert($object);
// → `.email` must end with "@example.com"

You can also use Property to validate nested objects:

$object = new stdClass();
$object->address = new stdClass();
$object->address->postalCode = '1017 BS';

v::property(
    'address',
    v::property('postalCode', v::postalCode('BR'))
)->assert($object);
// → `.address.postalCode` must be a valid postal code on "BR"

Note

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

To only validate if a property exists, use PropertyExists instead.
To validate a property against a given validator only if the property exists, use PropertyOptional instead.

Templates

Template placeholders

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

Categorization

Nesting
Objects
Structures

Changelog

Version	Description
3.0.0	Renamed from `Attribute` to `Property`, and split by PropertyExists and PropertyOptional
0.3.9	Created

2.3 KiB Raw Blame History