rename class name, update readme

Author: inhere

README.md

@@ -489,7 +489,7 @@ $v = Validation::make($_POST,[
 <a name="built-in-filters"></a>
 ## 内置的过滤器
 
-> 一些 php 内置的函数可直接使用。 e.g `trim|ucfirst` `json_decode`
+> 一些 php 内置的函数可直接使用。 e.g `trim|ucfirst` `json_decode` `md5`
 
 过滤器 | 说明 | 示例
 -------|-------------|------------
@@ -507,6 +507,7 @@ $v = Validation::make($_POST,[
 `timestamp/strToTime` | 字符串日期转换时间戳 | `['pulishedAt', 'number', 'filter' => 'strToTime'],`
 `url` | URL 过滤,移除所有不符合 URL 的字符 | `['field', 'url', 'filter' => 'url'],`
 `str2list/str2array` | 字符串转数组 `'tag0,tag1' -> ['tag0', 'tag1']` | `['tags', 'strList', 'filter' => 'str2array'],`
+`unique` | 去除数组中的重复值(by `array_unique()`) | `['tagIds', 'intList', 'filter' => 'unique'],`
 `email` | email 过滤,移除所有不符合 email 的字符 | `['field', 'email', 'filter' => 'email'],`
 `encoded` | 去除 URL 编码不需要的字符,与 `urlencode()` 函数很类似 | `['imgUrl', 'url', 'filter' => 'encoded'],`
 `clearSpace` | 清理空格 | `['title', 'string', 'filter' => 'clearSpace'],`
@@ -528,7 +529,7 @@ $v = Validation::make($_POST,[
 `bool/boolean`  | 验证是否是 bool. [关于bool值](#about-bool-value) | `['open', 'bool']`
 `float` | 验证是否是 float | `['price', 'float']`
 `string`    | 验证是否是 string. **支持长度检查** | `['name', 'string']`, `['name', 'string', 'min'=>4, 'max'=>16]`
-`accepted`  | 验证的字段必须为 `yes/on/1/true` 这在确认「服务条款」是否同意时有用(from laravel) | `['agree', 'accepted']`
+`accepted`  | 验证的字段必须为 `yes/on/1/true` 这在确认「服务条款」是否同意时有用(ref laravel) | `['agree', 'accepted']`
 `url`   | 验证是否是 url | `['myUrl', 'url']`
 `email` | 验证是否是 email | `['userEmail', 'email']`
 `alpha`   | 验证值是否仅包含字母字符 | `['name', 'alpha']`
@@ -558,18 +559,18 @@ $v = Validation::make($_POST,[
 `notBe`   | 不能等于给定值 | `['status', 'notBe', 0]`
 `compare/same/equal` | 字段值比较: 相同 | `['passwd', 'compare', 'repasswd']`
 `different/notEqual` | 字段值比较: 不能相同 | `['userId', 'notEqual', 'targetId']`
-`requiredIf` | 指定的其它字段（ anotherField ）值等于任何一个 `value` 时，此字段为 **必填** | `['city', 'requiredIf', 'myCity', ['chengdu'] ]`
-`requiredUnless` | 指定的其它字段（ anotherField ）值等于任何一个 `value` 时，此字段为 **不必填** | `['city', 'requiredUnless', 'myCity', ['chengdu'] ]`
-`requiredWith` | 指定的字段中的 _任意一个_ 有值且不为空，则此字段为 **必填** | `['city', 'requiredWith', ['myCity'] ]`
-`requiredWithAll` | 如果指定的 _所有字段_ 都有值，则此字段为 **必填** | `['city', 'requiredWithAll', ['myCity', 'myCity1'] ]`
-`requiredWithout` | 如果缺少 _任意一个_ 指定的字段值，则此字段为 **必填** | `['city', 'requiredWithout', ['myCity', 'myCity1'] ]`
-`requiredWithoutAll` | 如果所有指定的字段 **都没有值**，则此字段为 **必填** | `['city', 'requiredWithoutAll', ['myCity', 'myCity1'] ]`
+`requiredIf` | 指定的其它字段（ anotherField ）值等于任何一个 `value` 时，此字段为 **必填**(ref laravel) | `['city', 'requiredIf', 'myCity', ['chengdu'] ]`
+`requiredUnless` | 指定的其它字段（ anotherField ）值等于任何一个 `value` 时，此字段为 **不必填**(ref laravel) | `['city', 'requiredUnless', 'myCity', ['chengdu'] ]`
+`requiredWith` | 指定的字段中的 _任意一个_ 有值且不为空，则此字段为 **必填**(ref laravel) | `['city', 'requiredWith', ['myCity'] ]`
+`requiredWithAll` | 如果指定的 _所有字段_ 都有值，则此字段为 **必填**(ref laravel) | `['city', 'requiredWithAll', ['myCity', 'myCity1'] ]`
+`requiredWithout` | 如果缺少 _任意一个_ 指定的字段值，则此字段为 **必填**(ref laravel) | `['city', 'requiredWithout', ['myCity', 'myCity1'] ]`
+`requiredWithoutAll` | 如果所有指定的字段 **都没有值**，则此字段为 **必填**(ref laravel) | `['city', 'requiredWithoutAll', ['myCity', 'myCity1'] ]`
 `date` | 验证是否是 date | `['publishedAt', 'date']`
 `dateFormat` | 验证是否是 date, 并且是指定的格式 | `['publishedAt', 'dateFormat', 'Y-m-d']`
 `dateEquals` | 验证是否是 date, 并且是否是等于给定日期 | `['publishedAt', 'dateEquals', '2017-05-12']`
-`beforeDate` | 验证字段值必须是给定日期之前的值 | `['publishedAt', 'beforeDate', '2017-05-12']`
-`beforeOrEqualDate` | 字段值必须是小于或等于给定日期的值 | `['publishedAt', 'beforeOrEqualDate', '2017-05-12']`
-`afterOrEqualDate` | 字段值必须是大于或等于给定日期的值 | `['publishedAt', 'afterOrEqualDate', '2017-05-12']`
+`beforeDate` | 验证字段值必须是给定日期之前的值(ref laravel) | `['publishedAt', 'beforeDate', '2017-05-12']`
+`beforeOrEqualDate` | 字段值必须是小于或等于给定日期的值(ref laravel) | `['publishedAt', 'beforeOrEqualDate', '2017-05-12']`
+`afterOrEqualDate` | 字段值必须是大于或等于给定日期的值(ref laravel) | `['publishedAt', 'afterOrEqualDate', '2017-05-12']`
 `afterDate` | 验证字段值必须是给定日期之前的值 | `['publishedAt', 'afterDate', '2017-05-12']`
 `json`   | 验证是否是json字符串(默认严格验证，必须以`{` `[` 开始) | `['goods', 'json']` `['somedata', 'json', false]` - 非严格，普通字符串`eg 'test'`也会通过
 `file`   | 验证是否是上传的文件 | `['upFile', 'file']`
@@ -594,7 +595,28 @@ $v = Validation::make($_POST,[
 ['createdAt, updatedAt', 'safe']
 ```
 
-### 关于文件验证
+### 一些补充说明
+
+<a name="about-empty-value"></a>
+#### 关于为空判断
+
+字段符合下方任一条件时即为「空」
+
+- 该值为 `null`.
+- 该值为空字符串 `''`
+- 该值为空数组 `[]`
+- 该值为空对象 -- 空的 `可数` 对象
+- 该值为没有路径的上传文件
+
+<a name="about-bool-value"></a>
+#### 关于布尔值
+
+值符合下列的任意一项即认为是为bool值(不区分大小写)
+
+- 是 "1"、"true"、"on" 和 "yes" (`TRUE`)
+- 是 "0"、"false"、"off"、"no" 和 "" (`FALSE`)
+
+#### 关于文件验证
 
 文件验证时注意要设置文件信息源数据
 
@@ -609,18 +631,10 @@ $v = Validation::make($_POST, [
 // ...
 ```
 
-### (注意)一些补充说明
+#### 提示和注意
 
 - **请将 `required*` 系列规则写在规则列表的最前面**
-- 关于为空判断：字段符合下方任一条件时即为「空」<a name="about-empty-value"></a>
-  - 该值为 `null`.
-  - 该值为空字符串 `''`
-  - 该值为空数组 `[]`
-  - 该值为空对象 -- 空的 `可数` 对象
-  - 该值为没有路径的上传文件
-- 关于布尔值: 值符合下列的任意一项即认为是为bool值<a name="about-bool-value"></a>
-  - 是 "1"、"true"、"on" 和 "yes" (`TRUE`)
-  - 是 "0"、"false"、"off"、"no" 和 "" (`FALSE`)
+- 验证大小范围 `int` 是比较大小。 `string` 和 `array` 是检查长度。大小范围 是包含边界值的 
 - `size/range` `length` 可以只定义 `min` 或者  `max` 值
 - 支持对数组的子级值验证 
 
@@ -639,8 +653,31 @@ $v = Validation::make($_POST, [
     ['goods.pear', 'max', 30], //goods 下的 pear 值最大不能超过 30
 ```
 
-- `required*` 系列规则参考自 laravel
-- 验证大小范围 `int` 是比较大小。 `string` 和 `array` 是检查长度。大小范围 是包含边界值的 
+- 支持对数组的子级值进行遍历验证 
+
+```php
+[
+'goods' => [
+     'apple' => 34,
+     'pear' => 50,
+ ],
+'users' => [
+     ['id' => 34, 'name' => 'tom'],
+     ['id' => 89, 'name' => 'john'],
+ ]
+]
+```
+
+```php
+    ['goods.*', 'each', 'number'], //goods 下的 每个值 都必须为大于0 的整数
+    // 写法是等效的
+    // ['goods', 'each', 'number'], //goods 下的 每个值 都必须为大于0 的整数
+    
+    // 多维数组
+    ['users.*.id', 'each', 'required'],
+    ['users.*.id', 'each', 'number', 'min' => 34],
+    ['users.*.name', 'each', 'string', 'min' => 5],
+```
 
 ## 一些关键方法API
 

src/Filter/FilterList.php renamed to src/Filter/Filters.php

@@ -9,11 +9,18 @@
 use Inhere\Validate\Utils\Helper;
 
 /**
- * Class FilterList
+ * Class Filters
  * @package Inhere\Validate\Filter
  */
-final class FilterList
+final class Filters
 {
+    /**
+     * don't allow create instance.
+     */
+    private function __construct()
+    {
+    }
+
     /**
      * 布尔值验证，转换成字符串后是下列的一个，就认为他是个bool值
      *   - "1"、"true"、"on" 和 "yes" (equal TRUE)
@@ -35,7 +42,7 @@ public static function boolean($val, $nullAsFalse = false)
     }
 
     /**
-     * @see ValidatorList::boolean()
+     * @see Validators::boolean()
      * {@inheritdoc}
      */
     public static function bool($val, $nullAsFalse = false)
@@ -59,7 +66,7 @@ public static function integer($val)
     }
 
     /**
-     * @see FilterList::integer()
+     * @see Filters::integer()
      * {@inheritdoc}
      */
     public static function int($val)
@@ -133,7 +140,7 @@ public static function string($val, $flags = 0)
     }
 
     /**
-     * @see FilterList::string()
+     * @see Filters::string()
      * {@inheritdoc}
      */
     public static function stripped($val, $flags = 0)
@@ -520,4 +527,18 @@ public static function callback($val, $callback)
     {
         return filter_var($val, FILTER_CALLBACK, ['options' => $callback]);
     }
+
+    /**
+     * 去除数组中的重复值
+     * @param mixed $val
+     * @return array
+     */
+    public static function unique($val)
+    {
+        if (!$val || \is_array($val)) {
+            return $val;
+        }
+
+        return array_unique($val);
+    }
 }

src/Utils/DataFiltersTrait.php

@@ -8,7 +8,7 @@
 
 namespace Inhere\Validate\Utils;
 
-use Inhere\Validate\Filter\FilterList;
+use Inhere\Validate\Filter\Filters;
 
 /**
  * Trait DataFiltersTrait
@@ -86,8 +86,8 @@ protected function callStringCallback($filter, ...$args)
             $value = $this->$filter(...$args);
 
             // $filter is a method of the class 'FilterList'
-        } elseif (method_exists(FilterList::class, $filter)) {
-            $value = FilterList::$filter(...$args);
+        } elseif (method_exists(Filters::class, $filter)) {
+            $value = Filters::$filter(...$args);
 
             // it is function name
         } elseif (\function_exists($filter)) {

src/Utils/Rule.php

@@ -14,6 +14,11 @@
  */
 final class Rule
 {
+    /**
+     * @var string
+     */
+    public $field;
+
     /**
      * validator name OR validator object
      * @var string|callable
@@ -30,11 +35,22 @@ final class Rule
      */
     public $when;
 
+    /**
+     * @var mixed
+     */
+    public $value;
+
     /**
      * @var mixed
      */
     public $default;
 
+    /**
+     * default error message
+     * @var mixed
+     */
+    public $message;
+
     /**
      * check Empty
      * @var callable
@@ -50,4 +66,30 @@ final class Rule
      * @var array|null
      */
     public $filters;
+
+    public function initByArray(array $config)
+    {
+
+    }
+
+    /**
+     * @param string $field 属性名称
+     * @param mixed $value 属性值
+     * @param \Closure|string $validator 验证器
+     * @param array $params 验证需要的参数
+     * @param string $message default error message
+     * @param mixed $default default value
+     * @return Rule
+     */
+    public function init(string $field, $value, $validator, array $params, $message, $default): Rule
+    {
+        $this->field = $field;
+        $this->value = $value;
+        $this->validator = $validator;
+        $this->params = $params;
+        $this->message = $message;
+        $this->default = $default;
+
+        return $this;
+    }
 }

src/Utils/UserAndContextValidatorsTrait.php

@@ -8,7 +8,7 @@
 
 namespace Inhere\Validate\Utils;
 
-use Inhere\Validate\ValidatorList;
+use Inhere\Validate\Validators;
 
 /**
  * trait UserAndContextValidatorsTrait
@@ -133,7 +133,7 @@ public static function getValidators(): array
 
     /**
      * 验证字段必须存在，且输入数据不为空。
-     * @see ValidatorList::isEmpty() 如何鉴定为空
+     * @see Validators::isEmpty() 如何鉴定为空
      * @param string $field
      * @param null|mixed $value
      * @return bool
@@ -151,7 +151,7 @@ public function required(string $field, $value = null)
             $val = $this->uploadedFiles[$field];
         }
 
-        return !ValidatorList::isEmpty($val);
+        return !Validators::isEmpty($val);
     }
 
     /**
@@ -458,7 +458,7 @@ public function differentValidator($val, string $compareField)
     public function inFieldValidator($val, string $anotherField)
     {
         if ($anotherField && $dict = $this->getByPath($anotherField)) {
-            return ValidatorList::in($val, $dict);
+            return Validators::in($val, $dict);
         }
 
         return false;
@@ -477,7 +477,7 @@ public function inFieldValidator($val, string $anotherField)
     public function eachValidator(array $values, ...$args)
     {
         if (!$validator = array_shift($args)) {
-            throw new \InvalidArgumentException('must setting a validator for each validate.');
+            throw new \InvalidArgumentException('must setting a validator for \'each\' validate.');
         }
 
         foreach ($values as $value) {
@@ -488,7 +488,7 @@ public function eachValidator(array $values, ...$args)
             } elseif (\is_string($validator)) {
                 // special for required
                 if ('required' === $validator) {
-                    $passed = !ValidatorList::isEmpty($value);
+                    $passed = !Validators::isEmpty($value);
 
                 } elseif (isset(self::$_validators[$validator])) {
                     $callback = self::$_validators[$validator];
@@ -497,8 +497,8 @@ public function eachValidator(array $values, ...$args)
                 } elseif (method_exists($this, $method = $validator . 'Validator')) {
                     $passed = $this->$method($value, ...$args);
 
-                } elseif (method_exists(ValidatorList::class, $validator)) {
-                    $passed = ValidatorList::$validator($value, ...$args);
+                } elseif (method_exists(Validators::class, $validator)) {
+                    $passed = Validators::$validator($value, ...$args);
 
                     // it is function name
                 } elseif (\function_exists($validator)) {

src/ValidationTrait.php

@@ -175,7 +175,7 @@ public function validate(array $onlyChecked = null, $stopOnError = null)
             $validator = $rule[0];
 
             // 如何判断属性为空 默认使用 ValidatorList::isEmpty(). 也可自定义
-            $isEmpty = [ValidatorList::class, 'isEmpty'];
+            $isEmpty = [Validators::class, 'isEmpty'];
             if (!empty($rule['isEmpty']) && (\is_string($rule['isEmpty']) || $rule['isEmpty'] instanceof \Closure)) {
                 $isEmpty = $rule['isEmpty'];
             }
@@ -258,7 +258,6 @@ public function validate(array $onlyChecked = null, $stopOnError = null)
         // fix : deny repeat validate
         $this->_validated = true;
 
-        unset($data);
         return $this;
     }
 
@@ -335,8 +334,8 @@ protected function valueValidate(string $field, $value, $validator, array $args,
             } elseif (method_exists($this, $method = $validator . 'Validator')) {
                 $passed = $this->$method($value, ...$args);
 
-            } elseif (method_exists(ValidatorList::class, $validator)) {
-                $passed = ValidatorList::$validator($value, ...$args);
+            } elseif (method_exists(Validators::class, $validator)) {
+                $passed = Validators::$validator($value, ...$args);
 
                 // it is function name
             } elseif (\function_exists($validator)) {