ContextQMD
Back to Validation

Property

docs/validators/Property.md

3.1.12.7 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> -->

Property

  • Property(string $propertyName, Validator $validator)

Validates an object property against a given validator.

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

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:

php
$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 postal code for "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

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Nesting
  • Objects
  • Structures

Changelog

VersionDescription
3.0.0Templates changed
3.0.0Renamed from Attribute to Property, and split by PropertyExists and PropertyOptional
0.3.9Created

See Also