LiittleCookie/valitron
1
0
Fork 0
mirror of https://github.com/vlucas/valitron.git synced 2025-12-30 23:01:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Usage documentation adjusted

Browse Source
This commit is contained in:
Tobias Hinz 2019-05-09 16:38:39 +02:00
parent 0976fa3a79
commit c4ea1db371
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -447,7 +447,7 @@ $v->validate();
## listContains fields usage ## listContains fields usage
The `listContains` rule checks that the field is present in a given array of values. The `listContains` rule checks that the field is present in a given array of values.
```php ```php
$v->rule('in', 'color', 'yellow'); $v->rule('listContains', 'color', 'yellow');
``` ```
Alternate syntax. Alternate syntax.
@ -988,7 +988,7 @@ Valitron\Validator::addRule('alwaysFail', function($field, $value, array $params
``` ```
You can also use one-off rules that are only valid for the specified You can also use one-off rules that are only valid for the specified
fields. fields.
```php ```php
$v = new Valitron\Validator(array("foo" => "bar")); $v = new Valitron\Validator(array("foo" => "bar"));
@ -1000,12 +1000,12 @@ $v->rule(function($field, $value, $params, $fields) {
This is useful because such rules can have access to variables This is useful because such rules can have access to variables
defined in the scope where the `Validator` lives. The Closure's defined in the scope where the `Validator` lives. The Closure's
signature is identical to `Validator::addRule` callback's signature is identical to `Validator::addRule` callback's
signature. signature.
If you wish to add your own rules that are not static (i.e., If you wish to add your own rules that are not static (i.e.,
your rule is not static and available to call `Validator` your rule is not static and available to call `Validator`
instances), you need to use `Validator::addInstanceRule`. instances), you need to use `Validator::addInstanceRule`.
This rule will take the same parameters as This rule will take the same parameters as
`Validator::addRule` but it has to be called on a `Validator` `Validator::addRule` but it has to be called on a `Validator`
instance. instance.
@ -1085,7 +1085,7 @@ You can also add rules on a per-field basis:
$rules = [ $rules = [
'required', 'required',
['lengthMin', 4] ['lengthMin', 4]
]; ];
$v = new Valitron\Validator(array('foo' => 'bar')); $v = new Valitron\Validator(array('foo' => 'bar'));
$v->mapFieldRules('foo', $rules); $v->mapFieldRules('foo', $rules);
@ -1173,4 +1173,3 @@ before running the tests:
6. Push to the branch (`git push origin my-new-feature`) 6. Push to the branch (`git push origin my-new-feature`)
7. Create new Pull Request 7. Create new Pull Request
8. Pat yourself on the back for being so awesome 8. Pat yourself on the back for being so awesome