mirror of
https://github.com/Respect/Validation.git
synced 2024-06-29 10:40:24 +02:00
Better docs, quick reference
This commit is contained in:
parent
e46dc1d36c
commit
644d521663
186
README.md
186
README.md
|
@ -10,24 +10,38 @@ Respect\Validation is the most awesome validation engine ever created for PHP. F
|
||||||
- PHP 5.3 only
|
- PHP 5.3 only
|
||||||
- Possible integration with Zend 2.0 and Symfony 2.0 validators
|
- Possible integration with Zend 2.0 and Symfony 2.0 validators
|
||||||
|
|
||||||
Quick Reference
|
Roadmap
|
||||||
===============
|
-------
|
||||||
|
|
||||||
|
- Custom validators (create your own validation rules and exceptions)
|
||||||
|
- Validation message improvements (translation, contextualization)
|
||||||
|
|
||||||
|
|
||||||
|
Feature Guide
|
||||||
|
=============
|
||||||
|
|
||||||
Namespace import
|
Namespace import
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
Respect\Validation is namespaced, but you can make your life easier by importing
|
||||||
|
a single class into your context:
|
||||||
|
|
||||||
<?php
|
<?php
|
||||||
use Respect\Validation\Validator as v;
|
use Respect\Validation\Validator as v;
|
||||||
|
|
||||||
Simple validation
|
Simple validation
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
|
The Hello World validator is something like this:
|
||||||
|
|
||||||
$number = 123;
|
$number = 123;
|
||||||
v::numeric()->validate($number); //true
|
v::numeric()->validate($number); //true
|
||||||
|
|
||||||
Chained validation
|
Chained validation
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
It is possible to group and chain several validators:
|
||||||
|
|
||||||
//From 1 to 15 non-whitespace alphanumeric characters
|
//From 1 to 15 non-whitespace alphanumeric characters
|
||||||
$validUsername = v::alnum()
|
$validUsername = v::alnum()
|
||||||
->noWhitespace()
|
->noWhitespace()
|
||||||
|
@ -37,6 +51,8 @@ Chained validation
|
||||||
|
|
||||||
Validating object attributes
|
Validating object attributes
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
|
You can validate attributes of objects or keys of arrays and its values too:
|
||||||
|
|
||||||
$validUser = v::attribute('username', $validUsername) //reusing!
|
$validUser = v::attribute('username', $validUsername) //reusing!
|
||||||
->attribute('birthdate', v::date('Y-m-d'));
|
->attribute('birthdate', v::date('Y-m-d'));
|
||||||
|
@ -50,6 +66,8 @@ Validating object attributes
|
||||||
Validator reuse (works on nested, big validators too!)
|
Validator reuse (works on nested, big validators too!)
|
||||||
------------------------------------------------------
|
------------------------------------------------------
|
||||||
|
|
||||||
|
Once created, you can reuse your validator anywhere:
|
||||||
|
|
||||||
$validUsername->validate('respect'); //true
|
$validUsername->validate('respect'); //true
|
||||||
$validUsername->validate('alexandre gaigalas'); //false
|
$validUsername->validate('alexandre gaigalas'); //false
|
||||||
$validUsername->validate('#$%'); //false
|
$validUsername->validate('#$%'); //false
|
||||||
|
@ -57,7 +75,8 @@ Validator reuse (works on nested, big validators too!)
|
||||||
Cool, informative exceptions
|
Cool, informative exceptions
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
The following code:
|
Respect\Validation produces a tree of validation messages that reflects
|
||||||
|
the groups, nests and composite validators you declared. The following code:
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$validUsername->assert('really messed up screen#name');
|
$validUsername->assert('really messed up screen#name');
|
||||||
|
@ -72,10 +91,21 @@ Produces this message:
|
||||||
|-"really messed up screen#name" contains whitespace
|
|-"really messed up screen#name" contains whitespace
|
||||||
\-"really messed up screen#name" length is not between 1 and 15
|
\-"really messed up screen#name" length is not between 1 and 15
|
||||||
|
|
||||||
|
Validation Methods
|
||||||
|
------------------
|
||||||
|
|
||||||
|
There are three different ways to validate something:
|
||||||
|
|
||||||
|
$validUsername->validate('alganet'); //returns true or false (quicker)
|
||||||
|
$validUsername->check('alganet'); //throws only the first error found (quicker)
|
||||||
|
$validUsername->assert('alganet'); //throws all of the errors found (slower)
|
||||||
|
|
||||||
Message finding on nested Exceptions
|
Message finding on nested Exceptions
|
||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
Consider the following scenario:
|
Nested exceptions are cool, but sometimes you need to retrieve a single message
|
||||||
|
from the validator. In these cases you can use the findRelated() method. Consider
|
||||||
|
the following scenario:
|
||||||
|
|
||||||
$validBlogPost = v::object()
|
$validBlogPost = v::object()
|
||||||
->attribute('title', v::string()->length(1,32))
|
->attribute('title', v::string()->length(1,32))
|
||||||
|
@ -87,7 +117,7 @@ Consider the following scenario:
|
||||||
$blogPost->author = clone $validUser;
|
$blogPost->author = clone $validUser;
|
||||||
$blogPost->author->username = '# invalid #';
|
$blogPost->author->username = '# invalid #';
|
||||||
|
|
||||||
The following code:
|
Then, the following validation code:
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$validBlogPost->assert($blogPost);
|
$validBlogPost->assert($blogPost);
|
||||||
|
@ -102,15 +132,149 @@ Finds the specific noWhitespace message inside author->username and prints it:
|
||||||
Using Zend and/or Symfony validators
|
Using Zend and/or Symfony validators
|
||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
|
It is also possible to reuse validators from other frameworks (you need to put them
|
||||||
|
in your autoload routines):
|
||||||
|
|
||||||
$validHostName = v::zend('hostname')->assert('google.com');
|
$validHostName = v::zend('hostname')->assert('google.com');
|
||||||
$validTime = v::sf('time')->assert('22:00:01');
|
$validTime = v::sf('time')->assert('22:00:01');
|
||||||
|
|
||||||
Cool, isn't it?
|
|
||||||
|
|
||||||
Roadmap
|
Quick Reference
|
||||||
=======
|
==============
|
||||||
|
|
||||||
- Custom validators (create your own validation rules and exceptions)
|
A quick, possibly incomplete, list of validators and use reference:
|
||||||
- Validation message improvements (translation, contextualization)
|
|
||||||
|
|
||||||
|
Alphanumeric:
|
||||||
|
|
||||||
|
v::alnum()->assert('abc 123');
|
||||||
|
v::alnum('_|')->assert('a_bc _1|23');
|
||||||
|
|
||||||
|
Alpha chars:
|
||||||
|
|
||||||
|
v::alpha()->assert('ab c');
|
||||||
|
v::alpha('.')->assert('a. b.c');
|
||||||
|
|
||||||
|
Check if it is an array (works on every Traversable, Countable ArrayAccess):
|
||||||
|
|
||||||
|
v::arr()->assert(array());
|
||||||
|
v::arr()->assert(new \ArrayObject);
|
||||||
|
|
||||||
|
An attribute of an object ant its value:
|
||||||
|
|
||||||
|
$myObject = new \stdClass;
|
||||||
|
$myObject->foo = "bar";
|
||||||
|
v::attribute("foo", v::string())->assert($myObject);
|
||||||
|
|
||||||
|
Between (works on numbers, digits and dates):
|
||||||
|
|
||||||
|
v::between(5, 15)->assert(10);
|
||||||
|
v::between('a', 'f')->assert('b');
|
||||||
|
|
||||||
|
A value after a function call (works with closures):
|
||||||
|
|
||||||
|
v::call('implode', v::int())->assert(array(1, 2, 3, 4));
|
||||||
|
|
||||||
|
Validates using the return of a callback:
|
||||||
|
|
||||||
|
v::callback('is_string')->assert('something');
|
||||||
|
|
||||||
|
Dates and date formats:
|
||||||
|
|
||||||
|
v::date('Y-m-d')->assert('2010-10-10');
|
||||||
|
v::date()->assert('Jan 10 2008');
|
||||||
|
|
||||||
|
Strings with digits:
|
||||||
|
|
||||||
|
v::digits()->assert('02384');
|
||||||
|
|
||||||
|
Iterates and validates each element:
|
||||||
|
|
||||||
|
v::each(v::hexa())->assert(array('AF', 'D1', '09'));
|
||||||
|
|
||||||
|
Check for equality:
|
||||||
|
|
||||||
|
v::equals('foobar')->assert('foobar');
|
||||||
|
|
||||||
|
Float numbers
|
||||||
|
|
||||||
|
v::float()->assert(1.5);
|
||||||
|
|
||||||
|
Hexadecimals:
|
||||||
|
|
||||||
|
v::hexa()->assert('FAFAF');
|
||||||
|
|
||||||
|
Checks if a value is inside a set:
|
||||||
|
|
||||||
|
v::in(array(1, 1, 2, 3, 5, 8))->assert(5);
|
||||||
|
|
||||||
|
Checks if an object is instance of a specific class or interface:
|
||||||
|
|
||||||
|
v::instance('\stdClass')->assert(new \stdClass);
|
||||||
|
|
||||||
|
Integer numbers:
|
||||||
|
|
||||||
|
v::int()->assert(1548);
|
||||||
|
|
||||||
|
IP addresses:
|
||||||
|
|
||||||
|
v::ip()->assert('200.226.220.222');
|
||||||
|
|
||||||
|
Length of strings, arrays or everything Countable:
|
||||||
|
|
||||||
|
v::length(5, 10)->assert('foobar');
|
||||||
|
v::length(5, 10)->assert(array(1, 2, 3, 4, 5));
|
||||||
|
|
||||||
|
Max and Min:
|
||||||
|
|
||||||
|
v::max(5)->assert(3);
|
||||||
|
v::min(5)->assert(7);
|
||||||
|
|
||||||
|
Positive and Negative:
|
||||||
|
|
||||||
|
v::negative()->assert(-5);
|
||||||
|
v::positive()->assert(3);
|
||||||
|
|
||||||
|
Whitespace, empty and null
|
||||||
|
|
||||||
|
v::noWhitespace()->assert('abc');
|
||||||
|
v::notEmpty()->assert('aaa');
|
||||||
|
v::nullValue()->assert(null);
|
||||||
|
|
||||||
|
Numeric values of all kinds:
|
||||||
|
|
||||||
|
v::numeric()->assert(1.56e-5);
|
||||||
|
|
||||||
|
Objects:
|
||||||
|
|
||||||
|
v::object()->assert(new \DateTime());
|
||||||
|
|
||||||
|
Regex evaluations:
|
||||||
|
|
||||||
|
v::regex('^[a-f]+$')->assert('abcdef');
|
||||||
|
|
||||||
|
Strings:
|
||||||
|
|
||||||
|
v::string()->assert('Hello World');
|
||||||
|
|
||||||
|
AllOf (checks all validators inside a composite):
|
||||||
|
|
||||||
|
v::allOf(
|
||||||
|
v::string(), //any string v::length(5, 20), //between 5 and 20 chars
|
||||||
|
v::noWhitespace() //no whitespace allowed
|
||||||
|
)->assert('alganet');
|
||||||
|
|
||||||
|
v::string()
|
||||||
|
->length(5, 20)
|
||||||
|
->noWhitespace()
|
||||||
|
->assert('alganet');
|
||||||
|
|
||||||
|
OneOf (checks for one valid inside of a composite):
|
||||||
|
|
||||||
|
$v = v::oneOf(
|
||||||
|
v::int()->positive(), //positive integer or;
|
||||||
|
v::float()->negative(), //negative float or;
|
||||||
|
v::nullValue() //null
|
||||||
|
);
|
||||||
|
$v->assert(null); //true
|
||||||
|
$v->assert(12); //true
|
||||||
|
$v->assert(-1.1); //true
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
<active>yes</active>
|
<active>yes</active>
|
||||||
</lead>
|
</lead>
|
||||||
<date>2011-02-07</date>
|
<date>2011-02-07</date>
|
||||||
<time>12:23:14</time>
|
<time>12:46:01</time>
|
||||||
<version>
|
<version>
|
||||||
<release>0.1.0</release>
|
<release>0.1.0</release>
|
||||||
<api>0.1.0</api>
|
<api>0.1.0</api>
|
||||||
|
|
Loading…
Reference in a new issue