update the document, change class name,update

xiajianjun · xiajianjun · commit 1a068da986f8 · 2016-04-05T11:42:35.000+08:00
diff --git a/document.md b/document.md
@@ -25,22 +25,22 @@ _repositories_ add
 
 run: `composer update`
 
+<a name="how-to-use"></a>
 ### how to use
 
 - Method 1: create a new class
     e.g.
     
-```
-<?php
+```php
 
-    use slimExtend\validate\Validator;
+    use inhere\validate\Validation;
 
-    class PageRequest extends Validator
+    class PageRequest extends Validation
     {
         public function rules()
         {
             return [
-                ['tagId,userId,freeTime', 'required', 'msg' => '{attr} is required!'],
+                ['tagId,title,userId,freeTime', 'required', 'msg' => '{attr} is required!'],
                 ['tagId', 'size', 'min'=>4, 'max'=>567], // 4<= tagId <=567
                 ['title', 'min', 'min' => 40],
                 ['freeTime', 'number'],
@@ -50,6 +50,7 @@ run: `composer update`
                 }],
                 ['userId', 'number', 'scene' => 'scene1' ],
                 ['userId', 'int', 'scene'    => 'scene2' ],
+                ['title', 'customValidator', 'msg' => '{attr} error msg!' ],
                 ['status', function($status)
                 { 
 
@@ -61,6 +62,14 @@ run: `composer update`
             ];
         }
         
+        // custom validator at the class. return a bool.
+        protected function customValidator($title)
+        {
+            // some logic ...
+            
+            return true; // Or false;
+        }
+        
         // define field attribute's translate.
         public function attrTrans()
         {
@@ -77,9 +86,11 @@ run: `composer update`
             ];
         }
     }
+```
+
+use, at other class
 
-//
-//  use, at other class
+```php
 
 $valid = PageRequest::make($_POST,)->validate();
 if ( $valid->fail() ) {
@@ -92,15 +103,15 @@ if ( $valid->fail() ) {
 
 - Method 2: direct use
 
-```
-<?php
-    use slimExtend\validate\Validator;
+```php
+
+    use inhere\validate\Validation;
 
     class SomeClass 
     {
         public function demo()
         {
-            $valid = Validator::make($_POST,[
+            $valid = Validation::make($_POST,[
                 // add rule
                 ['title', 'min', 'min' => 40],
                 ['freeTime', 'number'],
@@ -116,13 +127,36 @@ if ( $valid->fail() ) {
     }
 ```
 
+### how to add custom validator
+
+- add in the subclass of the `inhere\validate\Validation`. see [how-to-use](#how-to-use) method 1.
+- add validator by method `addValidator`. e.g:
+
+```php
+
+$valid = Validation::make($_POST,[
+            // add rule
+            ['title', 'min', 'min' => 40],
+            ['freeTime', 'number'],
+            ['title', 'checkTitle', 'msg' => 'Title didn't pass the validate!' ],
+        ])
+        ->addValidator('checkTitle',function($title){
+            // some logic ...
+            
+            return true; // if validate fail, return false.
+        })
+        ->validate();
+
+```
+
 ### keywords 
 
 - scene -- 设置验证场景
+
 > 如果需要让一个验证器在多个类似情形下使用,在验证时也表明要验证的场景
 
 ```
-// at validator class
+// at a subclass of the Validation class
 <?php 
     
     '''
@@ -135,26 +169,28 @@ if ( $valid->fail() ) {
         ];
     }
 ```
-> 在下面设置了场景时，将只会使用上面的第 1 3 条规则. (第 1 条没有限制规则使用场景的，在所有场景都可用)
+
+> 在下面设置了场景时，将只会使用上面的第 1,3 条规则. (第 1 条没有限制规则使用场景的，在所有场景都可用)
 
 ```
 // at logic 
 <?php
 
     ...
-    $valid = ValidatorClass::make($_POST)->setScene('scene2')->validate();
+    $valid = ValidationClass::make($_POST)->setScene('scene2')->validate();
     ...
 
 ```
 
 - when -- 规则的前置条件
+
 > 只有在先满足了(`when`)前置条件时才会验证这条规则
 如在下面的例子中，检查到第二条规则时，会先执行闭包(`when`)，
 当其返回 `true` 验证此条规则，
 否则不会验证此条规则
 
 ```
-// at validator class
+// at a subclass of the Validation class
 <?php 
     
     '''
diff --git a/example/DataModel.php b/example/DataModel.php
@@ -1,7 +1,14 @@
 <?php
 
-class DataModel extends \slimExtend\validate\Validator
+/**
+ * Class DataModel
+ *
+ * custom extend the trait 'ValidationTrait' like the class 'Validation'
+ */
+class DataModel
 {
 
+    use \inhere\validate\ValidationTrait;
+
 
 }
diff --git a/example/PageRequest.php b/example/PageRequest.php
@@ -9,7 +9,7 @@
 /**
  * Class PageRequest
  */
-class PageRequest extends \slimExtend\validate\Validator
+class PageRequest extends \inhere\validate\Validation
 {
     public function rules()
     {
diff --git a/src/Validation.php b/src/Validation.php
@@ -9,12 +9,12 @@
 namespace inhere\validate;
 
 /**
- * Class Validator
+ * Class Validation
  * @package inhere\validate
  */
-class Validator
+class Validation
 {
-    use ValidatorTrait {
+    use ValidationTrait {
         set as traitSet;
         get as traitGet;// Methods to define an alias, can be used in the current class.
     }
diff --git a/src/ValidationTrait.php b/src/ValidationTrait.php
@@ -10,12 +10,12 @@
 namespace inhere\validate;
 
 /**
- * Trait ValidatorTrait
+ * Trait ValidationTrait
  * @package inhere\validate
  *
  * @property array $data
  */
-trait ValidatorTrait
+trait ValidationTrait
 {
     /**
      * 当前验证的场景 -- 如果需要让一个验证器在多个类似情形下使用
@@ -49,6 +49,11 @@ trait ValidatorTrait
      */
     private $_rules   = [];
 
+    /**
+     * @var array
+     */
+    private $_validators   = [];
+
     /**
      * attribute field translate list
      * @var array
@@ -99,7 +104,7 @@ public function attrTrans()
     }
 
     /**
-     * custom validator's message
+     * custom validator's message, to override default message.
      * @return array
      */
     public function messages()
@@ -115,7 +120,7 @@ public function messages()
     public function beforeValidate(){}
 
     /**
-     * [Validator::required] 验证是必定被调用的
+     * [ValidatorList::required] 验证是必定被调用的
      * @author inhere
      * @date   2015-08-11
      * @param array $onlyChecked 只检查一部分属性
@@ -217,28 +222,62 @@ protected function doValidate($data, $name, $validator, $copy)
 
             // if it's a closure
             if ( is_callable($validator) && $validator instanceof \Closure) {
-                $result = call_user_func_array($validator, $copy);
+                $callback  = $validator;
                 $validator = 'callback';
 
-            // if it is a method of the subclass.
+            // if it is a custom add callback in the property {@see $_validators}.
+            } elseif ( is_string($validator) && isset($this->_validators['validator']) ) {
+
+                $callback = $this->_validators['validator'];
+
+            // if it is a custom method of the subclass.
             } elseif ( is_string($validator) && method_exists($this, $validator) ) {
 
-                $result = call_user_func_array( [ $this, $validator ] , $copy);
+                $callback = [ $this, $validator ];
 
             // it's a method of the class 'ValidatorList'
-            } elseif ( is_callable([ValidatorList::class, $validator]) ) {
+            } elseif ( is_string($validator) && is_callable([ValidatorList::class, $validator]) ) {
 
-                $result = call_user_func_array( [ ValidatorList::class, $validator ] , $copy);
+                $callback = [ ValidatorList::class, $validator];
             } else {
                 throw new \InvalidArgumentException("validator [$validator] don't exists!");
             }
+
+            $result = call_user_func_array($callback, $copy);
         }
 
         return [$result,$validator];
     }
 
     public function afterValidate(){}
 
+    /**
+     * add a custom validator
+     *
+     * ```
+     * $valid = ValidatorClass::make($_POST)
+     *          ->addValidator('name',function($var [, $arg1, $arg2 ... ]){
+     *              return $var === 23;
+     *          });
+     * $valid->validate();
+     * ```
+     *
+     * @param string $name
+     * @param \Closure $callback
+     * @param string $msg
+     * @return $this
+     */
+    public function addValidator($name, \Closure $callback, $msg = '')
+    {
+        $this->_validators[$name] = $callback;
+
+        if ($msg) {
+            $this->defaultMessages[$name] = $msg;
+        }
+
+        return $this;
+    }
+
     /**
      * @return array
      */
@@ -345,33 +384,30 @@ public function lastError($onlyMsg=true)
      * (过滤器)默认的错误提示信息
      * @return array
      */
-    public function defaultMessages()
-    {
-        return [
-            'int'    => '{attr} must be an integer!',
-            'number' => '{attr} must be an integer greater than 0!',
-            'bool'   => '{attr} must be is boolean!',
-            'float'  => '{attr} must be is float!',
-            'regexp' => '{attr} does not meet the conditions',
-            'url'    => '{attr} not is url address!',
-            'email'  => '{attr} not is email address!',
-            'ip'     => '{attr} not is ip address!',
-            'required' => '{attr} is not block!',
-            'length' => '{attr} length must at rang {min} ~ {max}',
-            'size'  => '{attr} must be an integer and at rang {min} ~ {max}',
-            'min'   => '{attr} minimum boundary is {value}',
-            'max'   => '{attr} maximum boundary is {value}',
-            'in'    => '{attr} must in ({value})',
-            'string' => '{attr} must be a string',
-            'isArray' => '{attr} must be an array',
-            'callback' => 'The custom callback validation fails of the [{attr}]!',
-            '_' => '{attr} validation is not through!',
-        ];
-    }
+    public $defaultMessages = [
+        'int'    => '{attr} must be an integer!',
+        'number' => '{attr} must be an integer greater than 0!',
+        'bool'   => '{attr} must be is boolean!',
+        'float'  => '{attr} must be is float!',
+        'regexp' => '{attr} does not meet the conditions',
+        'url'    => '{attr} not is url address!',
+        'email'  => '{attr} not is email address!',
+        'ip'     => '{attr} not is ip address!',
+        'required' => '{attr} is not block!',
+        'length' => '{attr} length must at rang {min} ~ {max}',
+        'size'  => '{attr} must be an integer and at rang {min} ~ {max}',
+        'min'   => '{attr} minimum boundary is {value}',
+        'max'   => '{attr} maximum boundary is {value}',
+        'in'    => '{attr} must in ({value})',
+        'string' => '{attr} must be a string',
+        'isArray' => '{attr} must be an array',
+        'callback' => 'The custom callback validation fails of the [{attr}]!',
+        '_'      => '{attr} validation is not through!',
+    ];
 
     public function getMessages()
     {
-        return array_merge($this->defaultMessages(), $this->messages());
+        return array_merge($this->defaultMessages, $this->messages());
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,14 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-class DataModel extends \slimExtend\validate\Validator`
	`3`	`+/**`
	`4`	`+ * Class DataModel`
	`5`	`+ *`
	`6`	`+ * custom extend the trait 'ValidationTrait' like the class 'Validation'`
	`7`	`+ */`
	`8`	`+class DataModel`
`4`	`9`	`{`
`5`	`10`
	`11`	`+ use \inhere\validate\ValidationTrait;`
	`12`	`+`
`6`	`13`
`7`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`/**`
`10`	`10`	`* Class PageRequest`
`11`	`11`	`*/`
`12`		`-class PageRequest extends \slimExtend\validate\Validator`
	`12`	`+class PageRequest extends \inhere\validate\Validation`
`13`	`13`	`{`
`14`	`14`	`public function rules()`
`15`	`15`	`{`