deblan-mirror/respect-validation
deblan-mirror/respect-validation
1
0
Fork 0
mirror of https://github.com/Respect/Validation.git synced 2026-03-14 22:35:45 +01:00
Code Issues Projects Releases Packages Wiki Activity
respect-validation/docs/validators/Property.md
Alexandre Gomes Gaigalas 16148e9593 Standardize and improve validation message templates 
- Remove redundant "valid" prefix:
   Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version.

 - Remove redundant "value" suffix
   ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal.

 - Standardize "consist only of" phrasing
   Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit.

 - Improve file accessibility messages
   Directory, Executable, File, Image, Readable, SymbolicLink, Writable.

 - Improve grammar and article usage
   CreditCard, Extension, Mimetype, Regex, Size.
2026-02-03 19:58:55 +00:00

2.7 KiB
Raw Permalink 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 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

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

Categorization

  • Nesting
  • Objects
  • Structures

Changelog

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

See Also