up: update readme, action script. format codes

Author: inhere

.github/workflows/php.yml

@@ -1,6 +1,11 @@
 name: Unit-tests
 
-on: [push]
+on:
+  push:
+    paths:
+      - '**.php'
+      - 'composer.json'
+      - '**.yml'
 
 jobs:
   test:
@@ -10,8 +15,15 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.1, 7.2, 7.3, 7.4] #
+        php: [7.3, 7.4, 8.0] # 7.1, 7.2,
         os: [ubuntu-latest] # windows-latest, macOS-latest
+        include:
+          - os: 'ubuntu-latest'
+            php: '7.2'
+            phpunit: '8.5.13'
+          - os: 'ubuntu-latest'
+            php: '7.1'
+            phpunit: '7.5.20'
 
     steps:
       - name: Checkout
@@ -23,7 +35,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php}}
-          tools: pecl, php-cs-fixer, phpunit
+          tools: pecl, php-cs-fixer, phpunit:${{ matrix.phpunit }}
           extensions: mbstring, dom, fileinfo, mysql, openssl, igbinary, redis # , swoole-4.4.19 #optional, setup extensions
           ini-values: post_max_size=56M, short_open_tag=On #optional, setup php.ini configuration
           coverage: none #optional, setup coverage driver: xdebug, none
@@ -32,10 +44,11 @@ jobs:
         run: env
 
       - name: Install dependencies
-        run: composer install --no-progress --no-suggest
+        run: composer install --no-progress
 
       # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
       # Docs: https://getcomposer.org/doc/articles/scripts.md
 
-      - name: Run test suite
-        run: composer run test
+      - name: Run unit tests
+        # run: composer run test
+        run: phpunit -vv

README.md

@@ -17,7 +17,7 @@
 - 支持自定义每个验证的错误消息，字段翻译，消息翻译，支持默认值
 - 支持基本的数组检查，数组的子级(`'goods.apple'`)值检查, 通配符的子级检查 (`'users.*.id' 'goods.*'`)
 - 方便的获取错误信息，验证后的安全数据获取(只会收集有规则检查过的数据)
-- 已经内置了60多个常用的验证器[内置验证器](#built-in-validators)
+- 已经内置了大量的常用的验证器[内置验证器](#built-in-validators)
 - 规则设置参考 `yii`, `laravel`, `Respect/Validation`
 - 独立的过滤器 `Inhere\Validate\Filter\Filtration`，可单独用于数据过滤
 
@@ -62,7 +62,7 @@ validate 同时支持两种规则配置方式，对应了两种规则的收集
 
 ## 安装
 
-```php
+```bash
 composer require inhere/php-validate
 // composer require inhere/php-validate ^2.2
 ```
@@ -135,19 +135,19 @@ class PageRequest extends Validation
             // 4<= tagId <=567
             ['tagId', 'size', 'min'=>4, 'max'=>567, 'filter' => 'int'],
 
-            // title length >= 40. 注意只需一个参数的验证，无需加 key, 如这里的 40
-            ['title', 'min', 40, 'filter' => 'trim'],
+            // title length >= 40. 注意只需一个参数的验证，无需加 key, 如这里的 40
+            ['title', 'min', 40, 'filter' => 'trim'],
 
-            // 大于 0
-            ['freeTime', 'number'],
+            // 大于 0
+            ['freeTime', 'number'],
 
             // 含有前置条件
             ['tagId', 'number', 'when' => function($data) {
                 return isset($data['status']) && $data['status'] > 2;
             }],
 
             // 在验证前会先过滤转换为 int。并且仅会在指明场景名为 'scene1' 时规则有效
-            ['userId', 'number', 'on' => 'scene1', 'filter' => 'int'],
+            ['userId', 'number', 'on' => 'scene1', 'filter' => 'int'],
             ['username', 'string', 'on' => 'scene2', 'filter' => 'trim'],
 
             // 使用自定义正则表达式
@@ -164,8 +164,8 @@ class PageRequest extends Validation
                 return false;
             }],
 
-            // 标记字段是安全可靠的 无需验证
-            ['createdAt, updatedAt', 'safe'],
+            // 标记字段是安全可靠的 无需验证
+            ['createdAt, updatedAt', 'safe'],
         ];
     }
 
@@ -308,11 +308,20 @@ class UserController
 
 ## 添加自定义验证器
 
-- **方式1**在继承了 `Inhere\Validate\Validation` 的子类添加验证方法. 请看上面的 [使用方式1](#how-to-use2)
+底层调用验证器是支持：
+
+- 一个闭包
+- 一个函数名称
+- 一个当前验证类的方法名
+  - 在继承了 `Inhere\Validate\Validation` 的子类添加验证方法. 请看上面的 [使用方式1](#how-to-use2)
+- 一个通过 `Validation->addValidator()` 添加的临时验证器
+- 一个通过 `Validator\UserValidators::set` 注册的全局验证器
+- 一个实现了 `Validator\ValidatorInterface` 的对象
+- 一个可调用的对象(有 `__invoke` 方法)
 
 > 注意： 写在当前类里的验证器方法必须带有后缀 `Validator`, 以防止对内部的其他的方法造成干扰
 
-- **方式2**通过 `Validation::addValidator()` 添加自定义验证器. e.g:
+### 示例
 
 ```php
 $v = Validation::make($_POST,[
@@ -329,7 +338,7 @@ $v = Validation::make($_POST,[
     ->validate();
 ```
 
-- **方式3**直接写闭包进行验证 e.g:
+直接写闭包进行验证 e.g:
 
 ```php
     ['status', function($status) { // 第一个参数是字段值。最后一个参数总是 $data
@@ -341,16 +350,14 @@ $v = Validation::make($_POST,[
     }]
 ```
 
-- **方式4**定义一个闭包验证类进行验证,这种方法能提高验证方法的复用性
+定义一个闭包验证类进行验证,这种方法能提高验证方法的复用性
 
 > 别忘了继承 `\Inhere\Validate\Validator\AbstractValidator`,和实现必须方法`validate`
 
 ```php
-
 class AdemoValidator extends \Inhere\Validate\Validator\AbstractValidator
 {
 
-
     public function validate($value, $data): bool
     {
         if ($value == 1) {
@@ -361,7 +368,8 @@ class AdemoValidator extends \Inhere\Validate\Validator\AbstractValidator
 
 }
 
-    ['status', new AdemoValidator()]
+// 使用
+    ['status', new AdemoValidator()],
 ```
 
 <a name="on-in-Validation"></a>

composer.json

@@ -15,14 +15,15 @@
     {
       "name": "inhere",
       "email": "in.798@qq.com",
-      "homepage": "http://www.yzone.net/"
+      "homepage": "https://github.com/inhere"
     }
   ],
   "require": {
-    "php": ">7.1.0"
+    "php": ">7.1.0",
+    "toolkit/stidlib": "~1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.5"
+    "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5"
   },
   "autoload": {
     "psr-4": {

src/Traits/ErrorMessageTrait.php

@@ -239,7 +239,7 @@ public function lastError(bool $onlyMsg = true)
     }
 
     /**
-     * @param bool|null $_stopOnError
+     * @param bool|mixed|null $_stopOnError
      *
      * @return $this
      */

src/Validation.php

@@ -39,8 +39,8 @@ public function rules()
     */
 
     /**
-     * @param string $key
-     * @param null   $value
+     * @param string     $key
+     * @param mixed|null $value
      *
      * @return mixed
      */

src/ValidationInterface.php

@@ -87,7 +87,9 @@ public function lastError(bool $onlyMsg = true);
     public function getMessages(): array;
 
     /**
+     * @param bool $asObject
+     *
      * @return array|stdClass
      */
-    public function getSafeData();
+    public function getSafeData(bool $asObject = false);
 }

src/ValidationTrait.php

@@ -16,12 +16,14 @@
 use Inhere\Validate\Traits\ErrorMessageTrait;
 use Inhere\Validate\Traits\ScopedValidatorsTrait;
 use Inhere\Validate\Validator\UserValidators;
+use Inhere\Validate\Validator\ValidatorInterface;
 use InvalidArgumentException;
 use stdClass;
 use function array_keys;
 use function array_merge;
 use function array_shift;
 use function array_values;
+use function count;
 use function explode;
 use function function_exists;
 use function in_array;
@@ -397,7 +399,7 @@ protected function fieldValidate(string $field, $value, string $validator, array
      * @param mixed                $value     Field value
      * @param Closure|string|mixed $validator Validator
      * @param array                $args      Arguments for validate
-     * @param string               $defMsg
+     * @param string|array         $defMsg
      *
      * @return bool
      * @throws InvalidArgumentException
@@ -411,15 +413,21 @@ protected function valueValidate(string $field, $value, $validator, array $args,
         }
 
         $rawArgs = $args;
-        $args    = array_values($args);
+        $passed = false;
 
-        // if $validator is a closure OR a object has method '__invoke'
-        if (is_object($validator) && method_exists($validator, '__invoke')) {
-            $args[] = $this->data;
-            $passed = $validator($value, ...$args);
+        $args    = array_values($args);
+        if (is_object($validator)) {
+            // if $validator is a object has method '__invoke'
+            if (method_exists($validator, '__invoke')) {
+                $args[] = $this->data;
+                $passed = $validator($value, ...$args);
+            } elseif ($validator instanceof ValidatorInterface) {
+                 $args[] = $this->data;
+                 $passed = $validator->validate($value, ...$args);
+             }
         } elseif (is_string($validator)) {
             $realName = Validators::realName($validator);
-            // is global user validator
+            // is user validator
             if ($callback = $this->getValidator($validator)) {
                 $args[] = $this->data;
                 $passed = $callback($value, ...$args);
@@ -684,7 +692,7 @@ public function isValidated(): bool
      */
     public function hasRule(): bool
     {
-        return $this->getRules() ? true : false;
+        return count($this->getRules()) > 0;
     }
 
     /**
@@ -698,7 +706,7 @@ public function getRules(): array
     /**
      * @param array $rules
      *
-     * @return $this|mixed
+     * @return $this|static
      */
     public function setRules(array $rules)
     {
@@ -894,7 +902,7 @@ public function setSafe(string $key, $value): void
      *
      * @return array|stdClass
      */
-    public function safeData($asObject = false)
+    public function safeData(bool $asObject = false)
     {
         return $this->getSafeData($asObject);
     }
@@ -904,7 +912,7 @@ public function safeData($asObject = false)
      *
      * @return array|stdClass
      */
-    public function getSafeData($asObject = false)
+    public function getSafeData(bool $asObject = false)
     {
         return $asObject ? (object)$this->_safeData : $this->_safeData;
     }
@@ -913,7 +921,7 @@ public function getSafeData($asObject = false)
      * @param array $safeData
      * @param bool  $clearOld
      */
-    public function setSafeData(array $safeData, $clearOld = false): void
+    public function setSafeData(array $safeData, bool $clearOld = false): void
     {
         if ($clearOld) {
             $this->_safeData = [];

src/Validator/AbstractValidator.php

@@ -2,18 +2,22 @@
 
 namespace Inhere\Validate\Validator;
 
+/**
+ * Class AbstractValidator
+ * @package Inhere\Validate\Validator
+ */
 abstract class AbstractValidator implements ValidatorInterface
 {
     /**
      * 魔术方法,在试图函数式使用对象是调用
      *
-     * @param type $value
-     * @param type $data
+     * @param mixed $value
+     * @param array $data
      *
      * @return bool
      */
-    public function __invoke($value, $data): bool
+    public function __invoke($value, array $data): bool
     {
-        return (bool)$this->validate($value, $data);
+        return $this->validate($value, $data);
     }
 }

src/Validator/UserValidators.php

@@ -18,7 +18,7 @@
 final class UserValidators
 {
     /**
-     * @var array user custom add's validators (global)
+     * @var array user custom added validators (global)
      */
     private static $validators = [];
 

src/Validator/ValidatorInterface.php

@@ -15,5 +15,5 @@ interface ValidatorInterface
      *
      * @return bool
      */
-    public function validate($value, $data): bool;
+    public function validate($value, array $data): bool;
 }