respect-validation/docs/rules/Attribute.md
Henrique Moody 10df3211f5
Add "Categorization" section to rule documentations
Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
2019-05-11 19:16:21 +02:00

48 lines
853 B
Markdown

# Attribute
- `Attribute(string $name)`
- `Attribute(string $name, Validatable $rule)`
- `Attribute(string $name, Validatable $rule, bool $mandatory)`
Validates an object attribute, even private ones.
```php
$obj = new stdClass;
$obj->foo = 'bar';
v::attribute('foo')->validate($obj); // true
```
You can also validate the attribute itself:
```php
v::attribute('foo', v::equals('bar'))->validate($obj); // true
```
Third parameter makes the attribute presence optional:
```php
v::attribute('lorem', v::stringType(), false)->validate($obj); // true
```
The name of this validator is automatically set to the attribute name.
## Categorization
- Nesting
- Objects
- Structures
## Changelog
Version | Description
--------|-------------
0.3.9 | Created
***
See also:
- [Key](Key.md)
- [KeyNested](KeyNested.md)
- [ObjectType](ObjectType.md)