mirror of https://github.com/Respect/Validation.git synced 2024-06-08 00:32:16 +02:00

Organize documentation for "Read the Docs"

The current documentation is hosted via GitHub pages rendered by
"Couscous". Every time we need a new version of the documentation
published we need to manually execute the "couscous".

This commit reorganize the documentation to be published to
"Read the Docs" because it will also allow us to have documentations per
version of the library most importantly provider a search field for the
documentation.

The documentation will be then published on:
https://respect-validation.readthedocs.io/

Signed-off-by: Henrique Moody <henriquemoody@gmail.com>

2018-08-23 01:59:39 +02:00

656 B

Raw Blame History

Attribute

v::attribute(string $name)
v::attribute(string $name, v $validator)
v::attribute(string $name, v $validator, boolean $mandatory = true)

Validates an object attribute.

$obj = new stdClass;
$obj->foo = 'bar';

v::attribute('foo')->validate($obj); // true

You can also validate the attribute itself:

v::attribute('foo', v::equals('bar'))->validate($obj); // true

Third parameter makes the attribute presence optional:

v::attribute('lorem', v::stringType(), false)->validate($obj); // true

The name of this validator is automatically set to the attribute name.

656 B Raw Blame History

Attribute

656 B

Raw Blame History