respect-validation/docs/Attribute.md
Henrique Moody 66027b85a5 Documentation improvements
- Add a space after comments with `//`;
- Add missing "See also" sections in some files
2015-10-19 22:55:05 -02:00

33 lines
656 B
Markdown

# Attribute
- `v::attribute(string $name)`
- `v::attribute(string $name, v $validator)`
- `v::attribute(string $name, v $validator, boolean $mandatory = true)`
Validates an object attribute.
```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.
***
See also:
* [Key](Key.md)