Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated documentation

  • Loading branch information...
commit e3dea80cba4bdf67244af2f7b354420d7a704382 1 parent 66f5ea2
@spiechu authored
Showing with 7 additions and 3 deletions.
  1. +7 −3 README.md
View
10 README.md
@@ -9,12 +9,16 @@ Nothing special here. Just make sure You have at least PHP 5.3.0 and perform `re
## Documentation
Static Validator's class is designed to check if given variable or table of variables meet certain conditions.
+
Basically every check method starts with `check` word, and then You can use separator `_` and type next condition which tested variable is supposed to meet.
+
For exaple `StaticValidator::check_notNull_isInt_gt5($testedVariable);` we can translate to `!is_null($testedVariable) && is_int($testedVariable) && ($testedVariable > 5)` You can see we gain some concise and some flexibility (`gt5`).
+
We can distinguish three main components in PHP Static Validator:
-* simple wrappers (for eg. isSet, notSet, isNull, notNull, isInt, notInt, isString, notString)
-* regular expressions based (for eg. onlyLetters, onlyNumbers)
-* magic functions (for eg. eq3, gt3, lt3, minLength5)
+
+- simple wrappers (for eg. isSet, notSet, isNull, notNull, isInt, notInt, isString, notString)
+- regular expressions based (for eg. onlyLetters, onlyNumbers)
+- magic functions (for eg. eq3, gt3, lt3, minLength5)
## Known Issues
Please sign in to comment.
Something went wrong with that request. Please try again.