add scenarios() support. update readme and testing.

Author: inhere

README.md

@@ -87,41 +87,54 @@ class PageRequest extends Validation
     public function rules()
     {
         return [
+            // 字段必须存在且不能为空
             ['tagId,title,userId,freeTime', 'required'],
+            
             // 4<= tagId <=567
             ['tagId', 'size', 'min'=>4, 'max'=>567, 'filter' => 'int'], 
+            
             // title length >= 40. 注意只需一个参数的验证，无需加 key, 如这里的 40
             ['title', 'min', 40, 'filter' => 'trim'],
-            // 大于0
+ 
+            // 大于 0
             ['freeTime', 'number'],
+ 
             // 含有前置条件
             ['tagId', 'number', 'when' => function($data) {
                 return isset($data['status']) && $data['status'] > 2;
             }],
+            
             // 在验证前会先过滤转换为 int。并且仅会在指明场景名为 'scene1' 时规则有效
             ['userId', 'number', 'on' => 'scene1', 'filter' => 'int'],
             ['username', 'string', 'on' => 'scene2', 'filter' => 'trim'],
+            
             // 使用自定义正则表达式
             ['username', 'regexp' ,'/^[a-z]\w{2,12}$/'],
+            
             // 自定义验证器，并指定当前规则的消息
             ['title', 'custom', 'msg' => '{attr} error msg!' ], 
-            ['status', function($status) { // 直接使用闭包验证
+            
+            // 直接使用闭包验证
+            ['status', function($status) { 
                 if (is_int($status) && $status > 3) {
                     return true;
                 }
                 return false;
             }],
+            
             // 标记字段是安全可靠的 无需验证
             ['createdAt, updatedAt', 'safe'],
         ];
     }
 
-    // 添加一个验证器。必须返回一个布尔值标明验证失败或成功
-    protected function customValidator($title)
+    // 定义不同场景需要验证的字段。 
+    // 功能跟规则里的 'on' 类似，两者尽量不要同时使用，以免混淆。
+    public function scenarios(): array
     {
-        // some logic ...
-
-        return true; // Or false;
+        return [
+            'create' => ['user', 'pwd', 'code'],
+            'update' => ['user', 'pwd'],
+        ];
     }
 
     // 定义字段翻译
@@ -141,6 +154,14 @@ class PageRequest extends Validation
           'title.required' => 'O, 标题是必填项。are you known?',
         ];
     }
+    
+    // 添加一个验证器。必须返回一个布尔值标明验证失败或成功
+    protected function customValidator($title)
+    {
+        // some logic ...
+
+        return true; // Or false;
+    }
 }
 ```
 

src/AbstractValidation.php

@@ -59,6 +59,17 @@ public function __construct(
         }
     }
 
+    /**
+     * @param array $data
+     * @param string $scene
+     * @param bool $startValidate
+     * @return AbstractValidation
+     */
+    public static function quick(array $data, string $scene = '', $startValidate = false)
+    {
+        return new static($data, [], [], $scene, $startValidate);
+    }
+
     /**
      * @param array $data
      * @param array $rules

src/Utils/ErrorMessageTrait.php

@@ -309,13 +309,13 @@ public function lastError($onlyMsg = true)
     }
 
     /**
-     * @param bool|null $stopOnError
+     * @param bool|null $_stopOnError
      * @return $this
      */
-    public function setStopOnError($stopOnError = null): self
+    public function setStopOnError($_stopOnError = null): self
     {
-        if (null !== $stopOnError) {
-            $this->_stopOnError = (bool)$stopOnError;
+        if (null !== $_stopOnError) {
+            $this->_stopOnError = (bool)$_stopOnError;
         }
 
         return $this;

src/ValidationTrait.php

@@ -37,8 +37,11 @@ trait ValidationTrait
     /** @var \Closure after validate handler */
     private $_afterHandler;
 
+    /** @var array Used rules at current scene */
+    protected $_usedRules = [];
+
     /**
-     * current scenario name
+     * setting current scenario name
      * 当前验证的场景 -- 如果需要让规则列表在多个类似情形下使用
      * (
      * e.g: 在MVC框架中，
@@ -49,8 +52,12 @@ trait ValidationTrait
      */
     protected $scene = '';
 
-    /** @var array Used rules at current scene */
-    protected $_usedRules = [];
+    /**
+     * Whether to skip when empty(When not required)
+     * default is TRUE, need you manual add 'required'.
+     * @var bool
+     */
+    private $_skipOnEmpty = true;
 
     /**
      * @return array
@@ -87,8 +94,8 @@ public function messages()
     }
 
     /**
-     * 当前场景需要收集的字段
-     * @todo un-complete
+     * The field that the current scene needs to collect
+     * @return array
      */
     public function scenarios(): array
     {
@@ -163,6 +170,10 @@ public function validate(array $onlyChecked = [], bool $stopOnError = null)
             $cb($this);
         }
 
+        if (!$onlyChecked) {
+            $onlyChecked = $this->getSceneFields();
+        }
+
         foreach ($this->collectRules() as $fields => $rule) {
             $fields = \is_string($fields) ? Helper::explode($fields) : (array)$fields;
             $validator = \array_shift($rule);
@@ -180,7 +191,7 @@ public function validate(array $onlyChecked = [], bool $stopOnError = null)
             }
 
             // Whether to skip when empty(When not required). ref yii2
-            $skipOnEmpty = $rule['skipOnEmpty'] ?? true;
+            $skipOnEmpty = $rule['skipOnEmpty'] ?? $this->_skipOnEmpty;
             $filters = $rule['filter'] ?? null;  // filter
             $defMsg = $rule['msg'] ?? null; // Custom error message
             $defValue = $rule['default'] ?? null;// Allow default
@@ -474,6 +485,19 @@ protected function prepareRule(array &$rule)
      * getter/setter/helper
      ******************************************************************************/
 
+    /**
+     * get fields for the scene.
+     * @return array
+     */
+    public function getSceneFields(): array
+    {
+        if ($this->scene && $conf = $this->scenarios()) {
+            return $conf[$this->scene] ?? [];
+        }
+
+        return [];
+    }
+
     /**
      * @param string $path 'users.*.id' 'goods.*' 'foo.bar.*.id'
      * @param null|mixed $default
@@ -570,7 +594,6 @@ public function getScene(): string
     public function atScene(string $scene): self
     {
         $this->scene = \trim($scene);
-
         return $this;
     }
 
@@ -594,6 +617,16 @@ public function onScene(string $scene)
         return $this->atScene($scene);
     }
 
+    /**
+     * @param bool $_skipOnEmpty
+     * @return static
+     */
+    public function setSkipOnEmpty(bool $_skipOnEmpty)
+    {
+        $this->_skipOnEmpty = $_skipOnEmpty;
+        return $this;
+    }
+
     /**
      * Get all items in collection
      * @return array The collection's source data

test/FieldValidationTest.php

@@ -59,4 +59,31 @@ public function testValidate()
         $this->assertNotEmpty($errors);
         $this->assertCount(1, $errors);
     }
+
+    public function testScenarios()
+    {
+        $data = [
+            'user' => 'inhere',
+            'pwd' => '123456',
+            'code' => '1234',
+        ];
+
+        $v = FieldSample::quick($data,'create')->validate();
+        $this->assertTrue($v->isOk());
+        $this->assertEmpty($v->getErrors());
+
+        $data = [
+            'user' => 'inhere',
+            'pwd' => '123456',
+            'code' => '12345',
+        ];
+
+        $v = FieldSample::quick($data,'create')->validate();
+        $this->assertFalse($v->isOk());
+        $this->assertEquals('code length must is 4', $v->firstError());
+
+        $v = FieldSample::quick($data,'update')->validate();
+        $this->assertTrue($v->isOk());
+        $this->assertEmpty($v->getErrors());
+    }
 }

test/boot.php

@@ -4,3 +4,28 @@
  */
 
 require dirname(__DIR__) . '/example/simple-loader.php';
+
+class FieldSample extends \Inhere\Validate\FieldValidation
+{
+    public function rules(): array
+    {
+        return [
+            ['user', 'required|string:1,12'],
+            ['pwd', 'required|string:6,16'],
+            ['code', 'lengthEq:4'],
+        ];
+    }
+
+    public function scenarios(): array
+    {
+        return [
+            'create' => ['user', 'pwd', 'code'],
+            'update' => ['user', 'pwd'],
+        ];
+    }
+}
+
+class RuleSample extends \Inhere\Validate\Validation
+{
+
+}