add some new method. bug fixed for required check. add more unit test

Author: inhere

README.md

@@ -677,14 +677,15 @@ public function addValidator(string $name, \Closure $callback, string $msg = '')
 
 ```
 // 验证失败
-public function hasError()
-public function isFail() // hasError() 的别名方法
-public function fail() // hasError() 的别名方法
+public function isFail()
+public function fail() // isFail() 的别名方法
+public function failed() // isFail() 的别名方法
+public function hasError() // isFail() 的别名方法
 
 // 成功通过验证
 public function ok() 
-public function passed() 
-public function isPassed() // passed() 的别名方法
+public function isOk() 
+public function isPassed()
 ```
 
 获取验证是否通过(是否有验证失败)。
@@ -713,20 +714,20 @@ public function getErrors(): array
 public function firstError($onlyMsg = true)
 ```
 
-- `$onlyMsg` 是否只返回消息字符串。当为 false，返回的则是数组 eg: `[ attr => 'error message']`
+- `$onlyMsg` 是否只返回消息字符串。当为 false，返回的则是数组 eg: `['name' => 'field', 'msg' => 'error message']`
 
 ### 得到最后一个错误信息
 
 ```php
 public function lastError($onlyMsg = true)
 ```
 
-- `$onlyMsg` 是否只返回消息字符串。当为 false，返回的则是数组 eg: `[ attr => 'error message']`
+- `$onlyMsg` 是否只返回消息字符串。当为 false，返回的则是数组 eg: `['name' => 'field', 'msg' => 'error message']`
 
 ### 获取所有验证通过的数据
 
 ```php
-public function getSafeData(): array
+public function getSafeData(): array|\stdClass
 ```
 
 获取所有 **验证通过** 的安全数据. 
@@ -739,8 +740,9 @@ public function getSafeData(): array
 ### 根据字段名获取安全值
 
 ```php
-public function getSafe(string $key, $default = null)
+public function val(string $key, $default = null) // getSafe() 的别名方法
 public function getValid(string $key, $default = null) // getSafe() 的别名方法
+public function getSafe(string $key, $default = null) 
 ```
 
 从 **验证通过** 的数据中取出对应 key 的值
@@ -756,7 +758,7 @@ public function all(): array
 ### 根据字段名获取原始数据的值
 
 ```php
-public function get(string $key, $default = null)
+public function getRaw(string $key, $default = null)
 ```
 
 从验证时传入的数据中取出对应 key 的值

src/Utils/ErrorMessageTrait.php

@@ -183,6 +183,15 @@ public function ok(): bool
     /**
      * @return bool
      */
+    public function isOk(): bool
+    {
+        return !$this->isFail();
+    }
+
+    /**
+     * @deprecated will delete
+     * @return bool
+     */
     public function passed(): bool
     {
         return !$this->isFail();

src/Utils/UserAndContextValidatorsTrait.php

@@ -139,7 +139,7 @@ public function required($field, $value = null)
     {
         if (null !== $value) {
             $val = $value;
-        } elseif (null !== ($val = $this->getValue($field))) {
+        } elseif (null === ($val = $this->getByPath($field))) {
             // check uploaded files
             if (!isset($this->uploadedFiles[$field])) {
                 return false;
@@ -198,7 +198,7 @@ public function requiredUnless($field, $fieldVal, $anotherField, $values)
     }
 
     /**
-     * 如果指定的字段中的 任意一个 有值且不为空，则此字段为必填
+     * 如果指定的其他字段中的 任意一个 有值且不为空，则此字段为 必填
      * @from laravel
      * @param string $field
      * @param mixed $fieldVal
@@ -411,7 +411,7 @@ public function mimesValidator($field, $types = null)
      */
     public function compareValidator($val, $compareField)
     {
-        return $compareField && ($val === $this->get($compareField));
+        return $compareField && ($val === $this->getByPath($compareField));
     }
 
     public function sameValidator($val, $compareField)
@@ -432,7 +432,7 @@ public function equalValidator($val, $compareField)
      */
     public function notEqualValidator($val, $compareField)
     {
-        return $compareField && ($val !== $this->get($compareField));
+        return $compareField && ($val !== $this->getByPath($compareField));
     }
 
     /**
@@ -443,7 +443,7 @@ public function notEqualValidator($val, $compareField)
      */
     public function differentValidator($val, $compareField)
     {
-        return $compareField && ($val !== $this->get($compareField));
+        return $compareField && ($val !== $this->getByPath($compareField));
     }
 
     /**
@@ -454,7 +454,7 @@ public function differentValidator($val, $compareField)
      */
     public function inFieldValidator($val, $anotherField)
     {
-        if ($anotherField && $dict = $this->get($anotherField)) {
+        if ($anotherField && $dict = $this->getByPath($anotherField)) {
             return ValidatorList::in($val, $dict);
         }
 

src/ValidationInterface.php

@@ -57,7 +57,12 @@ public function isFail(): bool;
     /**
      * @return bool
      */
-    public function passed(): bool;
+    public function ok(): bool;
+
+    /**
+     * @return bool
+     */
+    public function isPassed(): bool;
 
     /**
      * @return array
@@ -86,7 +91,7 @@ public function lastError($onlyMsg = true);
     public function getMessages(): array;
 
     /**
-     * @return array
+     * @return array|\stdClass
      */
-    public function getSafeData(): array;
+    public function getSafeData();
 }

src/ValidationTrait.php

@@ -22,21 +22,6 @@ trait ValidationTrait
 {
     use DataFiltersTrait, ErrorMessageTrait, UserAndContextValidatorsTrait;
 
-    /**
-     * current scenario name
-     * 当前验证的场景 -- 如果需要让规则列表在多个类似情形下使用
-     * (
-     * e.g: 在MVC框架中，
-     * - 通常可以根据控制器的 action name(add, edit, register) 来区分。
-     * - 或者根据模型的场景(create, update, delete) 来区分。
-     * )
-     * @var string
-     */
-    protected $scene = '';
-
-    /** @var array used rules at current scene */
-    protected $_usedRules = [];
-
     /**
      * the rules is by setRules()
      * @var array
@@ -58,6 +43,21 @@ trait ValidationTrait
     /** @var \Closure after validate handler */
     private $_afterHandler;
 
+    /**
+     * current scenario name
+     * 当前验证的场景 -- 如果需要让规则列表在多个类似情形下使用
+     * (
+     * e.g: 在MVC框架中，
+     * - 通常可以根据控制器的 action name(add, edit, register) 来区分。
+     * - 或者根据模型的场景(create, update, delete) 来区分。
+     * )
+     * @var string
+     */
+    protected $scene = '';
+
+    /** @var array used rules at current scene */
+    protected $_usedRules = [];
+
     /**
      * @return array
      */
@@ -92,6 +92,18 @@ public function messages()
         ];
     }
 
+    /**
+     * 当前场景需要收集的字段
+     */
+    // public function scenarios()
+    // {
+    //     return [
+    //         // scene name => needed fields ...
+    //         // 'scene' => ['filed1', 'field2'],
+    //         // 'create' => ['filed1', 'field2'],
+    //     ];
+    // }
+
     /**
      * before validate handler
      * @param  \Closure $cb
@@ -193,12 +205,12 @@ public function validate(array $onlyChecked = null, $stopOnError = null)
                     continue;
                 }
 
-                $value = $this->getValue($field, $defValue);
+                $value = $this->getByPath($field, $defValue);
                 // $hasWildcard = (bool)strpos($field, '*');
 
                 // mark field is safe. not need validate. like. 'created_at'
                 if ($validator === 'safe') {
-                    $this->_safeData[$field] = $value;
+                    $this->setSafe($field, $value);
                     continue;
                 }
 
@@ -360,11 +372,12 @@ protected function collectSafeValue($field, $value)
     {
         // 进行的是子级属性检查 eg: 'goods.apple'
         if ($pos = strpos($field, '.')) {
-            $firstLevelKey = substr($field, 0, $pos);
-            $this->_safeData[$firstLevelKey] = $this->data[$firstLevelKey];
-        } else {
-            $this->_safeData[$field] = $value;
+            $field = (string)substr($field, 0, $pos);
+            $value = $this->data[$field];
         }
+
+        // set
+        $this->_safeData[$field] = $value;
     }
 
     /**
@@ -608,31 +621,42 @@ public function getRaw(string $key, $default = null)
      * @param mixed $default The default value
      * @return mixed The key's value, or the default value
      */
-    public function getValue(string $key, $default = null)
+    public function getByPath(string $key, $default = null)
     {
         return Helper::getValueOfArray($this->data, $key, $default);
     }
 
     /**
-     * get safe field value
+     * alias of the 'getSafe()'
      * @param string $key
      * @param mixed $default
      * @return mixed
      */
-    public function getSafe(string $key, $default = null)
+    public function val(string $key, $default = null)
     {
-        return $this->getValid($key, $default);
+        return $this->getSafe($key, $default);
     }
 
     /**
-     * get safe field value
+     * alias of the 'getSafe()'
      * @param string $key
      * @param mixed $default
      * @return mixed
      */
     public function getValid(string $key, $default = null)
     {
-        return array_key_exists($key, $this->_safeData) ? $this->_safeData[$key] : $default;
+        return $this->getSafe($key, $default);
+    }
+
+    /**
+     * get safe field value
+     * @param string $key
+     * @param mixed $default
+     * @return mixed
+     */
+    public function getSafe(string $key, $default = null)
+    {
+        return $this->_safeData[$key] ?? $default;
     }
 
     /**
@@ -645,11 +669,21 @@ public function setSafe(string $key, $value)
     }
 
     /**
-     * @return array
+     * @param bool $asObject
+     * @return array|\stdClass
+     */
+    public function safeData($asObject = false)
+    {
+        return $this->getSafeData($asObject);
+    }
+
+    /**
+     * @param bool $asObject
+     * @return array|\stdClass
      */
-    public function getSafeData(): array
+    public function getSafeData($asObject = false)
     {
-        return $this->_safeData;
+        return $asObject ? (object)$this->_safeData : $this->_safeData;
     }
 
     /**
@@ -666,9 +700,10 @@ public function setSafeData(array $safeData, $clearOld = false)
     }
 
     /**
+     * Through the validation of the data keys
      * @return array
      */
-    public function getSafeFields(): array
+    public function getSafeKeys(): array
     {
         return array_keys($this->_safeData);
     }

tests/FieldValidationTest.php

@@ -42,7 +42,7 @@ public function testValidate()
             ])
            ->validate([], false);
 
-        $this->assertFalse($v->passed());
+        $this->assertFalse($v->isOk());
         $this->assertTrue($v->failed());
 
         $errors = $v->getErrors();