EasySwoole 驗證器組件 1.3.x

EasySwoole 提供了獨立的 驗證器組件，幾行代碼即可實現對請求參數進行驗證。常用于對 HTTP 等請求中的請求參數的驗證。

另外框架還提供了在注解中對 HTTP 請求參數進行校驗的組件，可以很方便地對 HTTP 請求參數的合法性進行校驗。在注解中就可以設置請求參數的驗證規則，使得代碼更簡潔，詳細使用見參數注解校驗。

組件要求

php: >= 7.1.0
easyswoole/spl: ^1.0
psr/http-message: ^1.0

安裝方法

框架 3.4.x 及以上版本自帶 validate 組件，所以不需要單獨安裝。3.4.x 之前的版本請單獨安裝，安裝方法如下：

composer require easyswoole/validate=1.3.x

倉庫地址

easyswoole/validate

默認提供的驗證錯誤信息提示說明

validate 驗證器組件提供了默認驗證錯誤信息的規則，詳細如下：

private $defaultErrorMsg = [
    'activeUrl'     => ':fieldName必須是可訪問的網址',
    'alpha'         => ':fieldName只能是字母',
    'between'       => ':fieldName只能在 :arg0 - :arg1 之間',
    'bool'          => ':fieldName只能是布爾值',
    'dateBefore'    => ':fieldName必須在日期 :arg0 之前',
    'dateAfter'     => ':fieldName必須在日期 :arg0 之后',
    'equal'         => ':fieldName必須等于:arg0',
    'float'         => ':fieldName只能是浮點數',
    'func'          => ':fieldName自定義驗證失敗',
    'inArray'       => ':fieldName必須在 :arg0 范圍內',
    'integer'       => ':fieldName只能是整數',
    'isIp'          => ':fieldName不是有效的IP地址',
    'notEmpty'      => ':fieldName不能為空',
    'numeric'       => ':fieldName只能是數字類型',
    'notInArray'    => ':fieldName不能在 :arg0 范圍內',
    'length'        => ':fieldName的長度必須是:arg0',
    'lengthMax'     => ':fieldName長度不能超過:arg0',
    'lengthMin'     => ':fieldName長度不能小于:arg0',
    'max'           => ':fieldName的值不能大于:arg0',
    'min'           => ':fieldName的值不能小于:arg0',
    'regex'         => ':fieldName不符合指定規則',
    'required'      => ':fieldName必須填寫',
    'timestamp'     => ':fieldName必須是一個有效的時間戳',
    'url'           => ':fieldName必須是合法的網址',
    'allowFile'     => ':fieldName文件擴展名必須在:arg0內',
    'allowFileType' => ':fieldName文件類型必須在:arg0內',
    'isArray'       => ':fieldName類型必須為數組'
];

基本使用

使用組件提供的默認的驗證錯誤信息提示

使用示例如下：

<?php
require_once __DIR__ . "/vendor/autoload.php";

$data = [
    'name' => 'blank',
    'age' => 25
]; // 要驗證的數據
$validate = new \EasySwoole\Validate\Validate();
$validate->addColumn('name')->required(); // 給字段加上驗證規則(驗證數據中 name 字段不能沒有)
$validate->addColumn('age')->required()->max(18); // 給字段加上驗證規則(驗證數據中 age 字段不能沒有且值不能大于18)
$bool = $validate->validate($data); // 驗證結果：驗證通過返回true 反之返回false
if ($bool) {
    var_dump("驗證通過");
} else {
    // 輸出驗證錯誤信息：
    var_dump($validate->getError()->__toString());
}
/*
 * 輸出結果： string(23) "age的值不能大于18"
 */

使用自定義的驗證錯誤信息提示

使用示例如下：

<?php
require_once __DIR__ . "/vendor/autoload.php";

$data1 = [
    'name' => 'easyswoole',
    'age' => 25
]; // 要驗證的數據
$validate1 = new \EasySwoole\Validate\Validate();
$validate1->addColumn('name', '名字')->required('參數不能缺少!'); // 給字段加上驗證規則(驗證數據中 name 字段不能沒有)
$validate1->addColumn('age', '年齡')->required('參數不能缺少!')->max(18, '不能大于18周歲'); // 給字段加上驗證規則(驗證數據中 age 字段不能沒有且值不能大于18)
$bool = $validate1->validate($data1); // 驗證結果：驗證通過返回true 反之返回false
if ($bool) {
    var_dump("驗證通過");
} else {
    // 輸出驗證錯誤信息：
    $fieldName = $validate1->getError()->getFieldAlias(); // 獲取驗證規則中設置的字段別名 '年齡'
    $errorMsg = $validate1->getError()->__toString(); // 獲取驗證錯誤信息 '不能大于18周歲'
    var_dump($fieldName . $errorMsg);
}
/**
 * 輸出結果：string(26) "年齡不能大于18周歲"
 */

注意：驗證器組件的驗證順序是按照添加驗證規則時的 添加字段的先后順序 和 驗證規則的先后順序 逐個進行驗證的，先添加的驗證規則不通過則直接返回驗證失敗，然后就可以獲取對應的驗證錯誤信息。例如上述示例中，會優先驗證 name 字段是否存在。

在控制器中封裝使用

先定義一個帶有 validateRule 方法的基礎控制器。示例代碼如下：

<?php
namespace App\HttpController\Api;

use EasySwoole\Http\AbstractInterface\Controller;
use EasySwoole\Http\Message\Status;
use EasySwoole\Validate\Validate;

class BaseController extends Controller
{
    protected function validate(Validate $validate)
    {
        return $validate->validate($this->request()->getRequestParam());
    }

    protected function onRequest(?string $action): ?bool
    {
        $ret = parent::onRequest($action);
        if ($ret === false) {
            return false;
        }
        $v = $this->validateRule($action);
        if ($v) {
            $ret = $this->validate($v);
            if ($ret == false) {
                $this->writeJson(Status::CODE_BAD_REQUEST, null, "{$v->getError()->getField()}@{$v->getError()->getFieldAlias()}:{$v->getError()->getErrorRuleMsg()}");
                return false;
            }
        }
        return true;
    }

    protected function validateRule(?string $action): ?Validate
    {

    }
}

然后在需要驗證的控制器方法中，我們給對應的 action 添加對應的校驗規則，即可實現自動校驗，這樣控制器方法就只需要關注實現邏輯。示例代碼如下：

<?php
namespace App\HttpController;

use App\HttpController\Api\BaseController;
use EasySwoole\Validate\Validate;

class Common extends BaseController
{

    function sms()
    {
        $phone = $this->request()->getRequestParam('phone');
    }

    protected function validateRule(?string $action): ?Validate
    {
        $v = new Validate();
        switch ($action) {
            case 'sms':
                {
                    $v->addColumn('phone', '手機號')->required('不能為空')->length(11, '長度錯誤');
                    $v->addColumn('verifyCode', '驗證碼')->required('不能為空')->length(4, '長度錯誤');
                    break;
                }
        }
        return $v;
    }
}

然后訪問 http://ip:9501/common/sms(示例請求地址) 就可以得到參數校驗的結果：{"code":400,"result":null,"msg":"phone@手機號:不能為空"}

方法列表

獲取驗證錯誤相關信息(`getError()`)

用于獲取驗證錯誤(Error)的相關信息（驗證字段名稱、驗證字段別名、驗證錯誤信息）。

函數原型

function getError(): ?\EasySwoole\Validate\Error

具體使用示例：

<?php
require_once __DIR__ . "/vendor/autoload.php";
$data1 = [
    'age' => 18,
]; // 要驗證的數據
$validate1 = new \EasySwoole\Validate\Validate();
$validate1->addColumn('name', '名字')->required('參數不能缺少!'); // 給字段加上驗證規則(驗證數據中 name 字段不能沒有)
$bool = $validate1->validate($data1);
if ($bool) {
    var_dump("驗證通過");
} else {
    // 獲取驗證錯誤字段的別名
    $fieldAliasName = $validate1->getError()->getFieldAlias(); // 獲取驗證規則中設置的字段別名 '名字'

    // 獲取驗證錯誤字段的名稱
    $fieldName = $validate1->getError()->getField(); // 獲取驗證規則中設置的字段名稱 'name'

    // 獲取驗證錯誤信息
    $errorMsg = $validate1->getError()->__toString(); // 獲取驗證錯誤信息 '參數不能缺少!'

    var_dump($fieldName . '@' . $fieldAliasName . $errorMsg);
}
/**
 * 輸出結果：
 * string(30) "name@名字參數不能缺少!"
 */

給字段添加驗證規則(`addColumn()`)

用于給字段添加驗證規則。

函數原型

組件 1.1.9 版本到目前：

public function addColumn(string $name, ?string $alias = null, bool $reset = false): \EasySwoole\Validate\Rule

string $name 字段 key
string $alias 字段別名
bool $reset 重置規則

針對 1.1.8 之前版本的函數參數說明如下：

1.1.0 版本到 1.1.8 版本

public function addColumn(string $name, ?string $alias = null): \EasySwoole\Validate\Rule

string $name 字段 key
string $alias 字段別名

1.0.1 版本

public function addColumn(string $name,?string $errorMsg = null,?string $alias = null): \EasySwoole\Validate\Rule

string $name 字段 key
string $errorMsg 驗證錯誤提示信息
string $alias 別名

1.0.0 版本

public function addColumn(string $name,?string $alias = null,?string $errorMsg = null):EasySwoole\Validate\Rule

string $name 字段 key
string $alias 別名
string $errorMsg 錯誤信息

返回一個 Rule 對象可以添加自定義規則。

驗證數據是否合法(`validate()`)

用于驗證數據是否合法。

函數原型：

function validate(array $data)

驗證規則用法說明

以下驗證規則中，不設置驗證錯誤時提示消息時，則默認使用組件提供的默認的錯誤提示信息。

activeUrl

驗證 url 是否可以通訊

函數原型

function activeUrl($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'url' => 'http://www.b3f21.cn/'
];
$validate->addColumn('url')->activeUrl();
$bool = $validate->validate($data);

alpha

驗證給定的參數值是否是字母即 [a-zA-Z]

函數原型

function alpha($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 'easyswoole'
];
$validate->addColumn('param')->alpha();
$bool = $validate->validate($data);

allDigital

驗證給定的參數中字符串是否由數字構成

函數原型

function allDigital($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2022
];
$validate->addColumn('param')->allDigital();
$bool = $validate->validate($data);

allowFile

驗證給定參數中的文件的 文件擴展名 是否是在允許的文件擴展名范圍數組內

函數原型

function allowFile(array $type, $isStrict = false, $msg = null)

array $type 允許的文件擴展名范圍數組
bool $isStrict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'file' => $this->request()->getUploadedFile('file')
];
$validate->addColumn('file')->allowFile(['png','jpg']);
$bool = $validate->validate($data);

allowFileType

驗證給定的參數中的文件的 文件類型 是否是在允許的文件類型范圍數組

函數原型

function allowFileType(array $type, $isStrict = false, $msg = null)

array $type 允許的文件類型范圍數組
bool $isStrict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'file' => $this->request()->getUploadedFile('file')
];
$validate->addColumn('param')->allowFileType(['image/png','image/jpeg']);
$bool = $validate->validate($data);

alphaNum

驗證給定的參數值是否是由字母或數字組成即 [a-zA-Z0-9]

函數原型

function alphaNum($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 'easyswoole2020'
];
$validate->addColumn('param')->alphaNum();
$bool = $validate->validate($data);

alphaDash

驗證給定的參數值是否是由字母、數字、下劃線或破折號組成即[a-zA-Z0-9-_]

函數原型

function alphaDash($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 'easyswoole_2020'
];
$validate->addColumn('param')->alphaDash();
$bool = $validate->validate($data);

between

驗證給定的參數值是否在 $min - $max 之間

函數原型

function between($min, $max, $msg = null)

integer $min 最小值包含該值
integer $max 最小值包含該值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => '2020'
];
$validate->addColumn('param')->between(2016, 2020);
$bool = $validate->validate($data);

bool

驗證給定的參數值是否為布爾值(1/0/true/false)

函數原型

function bool($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1
];
$validate->addColumn('param')->bool();
$bool = $validate->validate($data);

callUserRule

調用自定義驗證規則驗證數據

函數原型

function callUserRule(\EasySwoole\Validate\Functions\AbstractValidateFunction $rule, $msg = null, ...$args)

\EasySwoole\Validate\Functions\AbstractValidateFunction $rule 為繼承了 \EasySwoole\Validate\Functions\AbstractValidateFunction 類的自定義驗證規則類
string $msg 驗證錯誤時提示消息
mixed $args 可選參數

使用示例

先定義一個自定義驗證規則類 CustomValidator 并且繼承了 \EasySwoole\Validate\ValidateInterface 接口，具體實現代碼如下：

<?php
/**
 * Created by PhpStorm.
 * User: XueSi
 * Email: <1592328848@qq.com>
 * Date: 2021/4/15
 * Time: 22:43
 */

namespace App\Utility;

use EasySwoole\Validate\Functions\AbstractValidateFunction;
use EasySwoole\Validate\Validate;

class CustomValidator extends AbstractValidateFunction
{
    /**
     * 返回當前校驗規則的名字
     */
    public function name(): string
    {
        return 'mobile';
    }

    /**
     * 校驗失敗返回false，或者拋出異常，否則返回true
     * @param $itemData
     * @param $arg
     * @param $column
     * @param Validate $validate
     * @return bool
     */
    public function validate($itemData, $arg, $column, Validate $validate): bool
    {
        $regular = '/^((13[0-9])|(14[5,7,9])|(15[^4])|(18[0-9])|(17[0,1,3,5,6,7,8]))\\d{8}$/';
        if (!preg_match($regular, $itemData)) {
            return false;
        }

        return true;
    }
}

調用自定義驗證規則類驗證數據，具體實現如下：

<?php
require_once __DIR__ . "/vendor/autoload.php";

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'mobile' => '13312345678_',
];
$validate->addFunction(new \App\Utility\CustomValidator());
$validate->addColumn('mobile')->callUserRule(new \App\Utility\CustomValidator(), '手機號未通過驗證');
$bool = $validate->validate($data);
if ($bool) {
    var_dump("驗證通過");
} else {
    // 獲取驗證錯誤信息
    $errorMsg = $validate->getError()->__toString();
    var_dump($errorMsg);
}
/**
 * 輸出結果：
 * string(24) "手機號未通過驗證"
 */

該方法在 Validate 2.0.0 版本之前的組件函數原型為：

function callUserRule(\EasySwoole\Validate\ValidateInterface $rule, $msg = null, ...$args)

\EasySwoole\Validate\ValidateInterface $rule 為實現了 \EasySwoole\Validate\ValidateInterface 接口的自定義驗證規則類
string $msg 驗證錯誤時提示消息
mixed $args 可選參數

使用示例如下：

先定義一個自定義驗證規則類 CustomValidator 并且實現 \EasySwoole\Validate\ValidateInterface 接口，具體實現代碼如下：

<?php
namespace App\Utility;
use EasySwoole\Spl\SplArray;
use EasySwoole\Validate\ValidateInterface;

class CustomValidator implements ValidateInterface
{
    /**
     * 返回當前校驗規則的名字
     * @return string
     */
    public function name(): string
    {
        return 'mobile';
    }

    /**
     * 檢驗失敗返回錯誤信息即可
     * @param SplArray $spl
     * @param $column
     * @param mixed ...$args
     * @return string|null
     */
    public function validate(SplArray $spl, $column, ...$args): ?string
    {
        $regular = '/^((13[0-9])|(14[5,7,9])|(15[^4])|(18[0-9])|(17[0,1,3,5,6,7,8]))\\d{8}$/';
        if (!preg_match($regular, $spl->get($column))) {
            return '手機號驗證未通過';
        }
        return null;
    }
}

調用自定義驗證規則類驗證數據，具體實現如下：

<?php
require_once __DIR__ . "/vendor/autoload.php";

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'mobile' => '13312345678_',
];
$validate->addColumn('mobile')->callUserRule(new \App\Utility\CustomValidator());
$bool = $validate->validate($data);
if ($bool) {
    var_dump("驗證通過");
} else {
    // 獲取驗證錯誤信息
    $errorMsg = $validate->getError()->__toString();
    var_dump($errorMsg);
}
/**
 * 輸出結果：
 * string(24) "手機號驗證未通過"
 */

decimal

驗證給定的參數值是否合格的小數

函數原型

function decimal(?int $precision = null, $msg = null)

integer $precision 規定小數點后位數。默認參數為null，表示不規定小數點后位數
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1.1
];
$validate->addColumn('param')->decimal();
$bool = $validate->validate($data);

dateBefore

驗證給定參數的日期是否在某日期之前

函數原型

function dateBefore(?string $date = null, $msg = null)

string $date 需要對比的日期，默認驗證日期是否在當天之前
string $msg 驗證錯誤時提示消息

使用示例

// 驗證 param 參數日期是否在當天日期之前
$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => '2020-06-28'
];
$validate->addColumn('param')->dateBefore('2021-01-14');
$bool = $validate->validate($data);

// 驗證 param 參數日期是否在 2021-01-14 之前
$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => '2020-06-28'
];
$validate->addColumn('param')->dateBefore('2021-01-14');
$bool = $validate->validate($data);

dateAfter

驗證給定參數的日期是否在某日期之后

函數原型

function dateAfter(?string $date = null, $msg = null)

string $date 需要對比的日期，默認驗證日期是否在當天之后
string $msg 驗證錯誤時提示消息

使用示例

// 驗證 param 參數日期是否在當天日期之后
$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => '2020-06-28'
];
$validate->addColumn('param')->dateAfter('2021-01-14');
$bool = $validate->validate($data);

// 驗證 param 參數日期是否在 2021-01-14 之后
$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => '2021-06-28'
];
$validate->addColumn('param')->dateAfter('2021-01-14');
$bool = $validate->validate($data);

equal

驗證給定參數的值與某個值是否相等

函數原型

function equal($compare, bool $strict = false, $msg = null)

mixed $compare 要判斷的某個值
bool $strict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020
];
$validate->addColumn('param')->equal(2020);
$bool = $validate->validate($data);

different

驗證給定參數的值與某個值是否不相等

函數原型

function different($compare, bool $strict = false, $msg = null)

mixed $compare 要判斷的某個值
bool $strict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020
];
$validate->addColumn('param')->different(2021);
$bool = $validate->validate($data);

equalWithColumn

驗證給定參數中的值與給定參數中的某列值是否相等

函數原型

function equalWithColumn($fieldName, bool $strict = false, $msg = null)

string $fieldName 給定參數中的某列的字段名
bool $strict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020,
    'test'  => 2020
];
$validate->addColumn('param')->equalWithColumn('test');
$bool = $validate->validate($data);

differentWithColumn

驗證給定參數中的值與給定參數中的某列值是否不相等

函數原型

function differentWithColumn($fieldName, bool $strict = false, $msg = null)

string $fieldName 給定參數中的某列的字段名
bool $strict 是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020,
    'test'  => 2021
];
$validate->addColumn('param')->differentWithColumn('test');
$bool = $validate->validate($data);

float

驗證給定參數中的值是否是一個浮點數

函數原型

function float($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020.1
];
$validate->addColumn('param')->float();
$bool = $validate->validate($data);

func

調用自定義的閉包驗證數據，閉包中返回 false 視為驗證失敗，返回 true 視為驗證通過。

函數原型

function func(callable $func, $msg = null)

callable $func 自定義閉包類型
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$validate->addColumn('username')->func(function ($data, $name) {
    var_dump($data); // 待驗證的數據 ['username' => 'admin']
    var_dump($name); // 驗證規則中設置的字段名稱 'username'
    return false; // 視為驗證失敗
}, '用戶不存在');

$bool = $validate->validate(['username' => 'admin']);

isArray

驗證給定參數中的值是否是一個數組

函數原型

function isArray($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => ['hi', 'easyswoole']    
];
$validate->addColumn('param')->isArray();
$bool = $validate->validate($data);

inArray

驗證給定參數中的值是否在數組中

函數原型

function inArray(array $array, $isStrict = false, $msg = null)

array $array 允許的范圍數組
bool $strict 值是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020
];
$validate->addColumn('param')->inArray([2020, 2021]);
$bool = $validate->validate($data);

integer

驗證給定參數中的值是否是一個整數值

函數原型

function integer($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020
];
$validate->addColumn('param')->integer();
$bool = $validate->validate($data);

isIp

驗證給定參數中的值是否一個有效的IP

函數原型

function isIp($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'ip' => '127.0.0.1'
];
$validate->addColumn('ip')->isIp();
$bool = $validate->validate($data);

notEmpty

驗證給定參數中的值是否不為空(注意和 require() 規則區分開，require() 規則要求是必須存在于給定參數中，詳細看下面 require() 規則的介紹)。除了 0/'0'/empty($value)為假 這些值被驗證為不為空(驗證通過)，其他都被驗證為空(驗證錯誤)。

函數原型

function notEmpty($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => ''
];
$validate->addColumn('param')->notEmpty();
$bool = $validate->validate($data);

numeric

驗證給定參數中的值是否是一個數字值

函數原型

function numeric($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2020
];
$validate->addColumn('param')->numeric();
$bool = $validate->validate($data);

notInArray

驗證給定參數中的值是否不在數組中

函數原型

function notInArray(array $array, $isStrict = false, $msg = null)

array $array 值不允許出現的范圍數組
bool $strict 值是否使用嚴格等于，默認不使用
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2022
];
$validate->addColumn('param')->notInArray([2020, 2021]);
$bool = $validate->validate($data);

length

驗證給定參數中的 數組 或 字符串 或者 文件 的大小是否與規定的大小值一致

函數原型

function length(int $len, $msg = null)

int $len 規定的長度大小值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'string' => 2022,
    'array'  => [0, 1, 2],
    'file'   => $this->request()->getUploadedFile('file')
];
$validate->addColumn('string')->length(4);
$validate->addColumn('array')->length(3);
$validate->addColumn('file')->length(4); // 此處 length 為文件的 size
$bool = $validate->validate($data);

lengthMax

驗證給定參數中的 數組 或 字符串 或者 文件 的大小是否 超出 規定的大小值，最大不能超過這個值。

函數原型

function lengthMax(int $lengthMax, $msg = null)

int $lengthMax 規定的最大長度大小值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'string' => 2022,
    'array'  => [0, 1, 2],
    'file'   => $this->request()->getUploadedFile('file')
];
$validate->addColumn('string')->lengthMax(4);
$validate->addColumn('array')->lengthMax(3);
$validate->addColumn('file')->lengthMax(4); // 此處 length 為文件的 size
$bool = $validate->validate($data);

lengthMin

驗證給定參數中的 數組 或 字符串 或者 文件 的大小是否 達到 規定的最小長度大小值，最小也不能低于這個值。

函數原型

function lengthMin(int $lengthMin, $msg = null)

int $lengthMax 規定的最小長度大小值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'string' => 2022,
    'array'  => [0, 1, 2],
    'file'   => $this->request()->getUploadedFile('file')
];
$validate->addColumn('string')->lengthMin(4);
$validate->addColumn('array')->lengthMin(3);
$validate->addColumn('file')->lengthMin(4); // 此處 length 為文件的 size
$bool = $validate->validate($data);

betweenLen

驗證給定參數中的 數組 或 字符串 或者 文件 的大小是否在一個區間內

函數原型

function betweenLen(int $min, int $max, $msg = null)

int $min 最小值包含該值
int $max 最大值包含該值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'string' => 2022,
    'array'  => [0, 1, 2],
    'file'   => $this->request()->getUploadedFile('file')
];
$validate->addColumn('string')->betweenLen(1, 4);
$validate->addColumn('array')->betweenLen(1, 4);
$validate->addColumn('file')->betweenLen(1, 4); // 此處length為文件的size
$bool = $validate->validate($data);

max

驗證給定參數中的值 不大于 某個值(相等視為通過)

函數原型

max(int $max, ?string $msg = null): Rule

int $max 需要對比的某個值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2022
];
$validate->addColumn('param')->max(2022);
$bool = $validate->validate($data);

min

驗證給定參數中的值 不小于 某個值(相等視為通過)

函數原型

function min(int $min, ?string $msg = null): Rule

int $min 需要對比的某個值
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2022
];
$validate->addColumn('param')->min(2022);
$bool = $validate->validate($data);

money

驗證給定參數中的值是否一個合法的金額

函數原型

function money(?int $precision = null, string $msg = null): Rule

int $precision 規定小數點后的位數，默認不規定
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 2022.22
];
$validate->addColumn('param')->money();
$bool = $validate->validate($data);

regex

驗證給定參數中的值是否匹配某個正則表達式

函數原型

function regex($reg, $msg = null)

string $reg 需要匹配的正則表達式
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 'easyswoole'
];
$validate->addColumn('param')->regex('/^[a-zA-Z]+$/');
$bool = $validate->validate($data);

required

驗證給定參數中的某字段必須存在，不存在則視為不通過。可用于檢測請求參數中是否存在某個字段。與 PHP 中的 isset 判斷規則一致。(注意和上面的 notEmpty() 規則區分開)

函數原型

function required($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
];
$validate->addColumn('param')->required();
$bool = $validate->validate($data);

optional

驗證給定參數中的某字段是可選字段，不用必須存在，和上面的 required() 驗證規則剛好相反。

函數原型

function optional()

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
];
$validate->addColumn('param')->optional();
$bool = $validate->validate($data);

timestamp

驗證給定參數中的時間戳是否是一個合法的時間戳

函數原型

function timestamp($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1593315393
];
$validate->addColumn('param')->timestamp();
$bool = $validate->validate($data);

timestampBeforeDate

驗證給定參數中的時間戳是否是在某個指定日期之前

函數原型

function timestampBeforeDate($date, $msg = null)

string $date 需要對比的日期
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1593315393
];
$validate->addColumn('param')->timestampBeforeDate('2020-06-29');
$bool = $validate->validate($data);

timestampBeforeDate

驗證給定參數中的時間戳是否是在某個指定日期之后

函數原型

function timestampAfterDate($date, $msg = null)

string $date 需要對比的日期
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1593315393
];
$validate->addColumn('param')->timestampAfterDate('2020-06-27');
$bool = $validate->validate($data);

timestampBefore

驗證給定參數中的時間戳是否是在某個時間戳之前

函數原型

function timestampBefore($beforeTimestamp, $msg = null)

string|integer $beforeTimestamp 需要對比的時間戳
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1593315393
];
$validate->addColumn('param')->timestampBefore(1593315394);
$bool = $validate->validate($data);

timestampAfter

驗證給定參數中的時間戳是否是在某個時間戳之后

函數原型

function timestampAfter($afterTimestamp, $msg = null)

string|integer $afterTimestamp 需要對比的時間戳
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'param' => 1593315393
];
$validate->addColumn('param')->timestampAfter(1593315392);
$bool = $validate->validate($data);

url

驗證給定參數中的值是一個合法的鏈接

函數原型

function url($msg = null)

string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'url' => 'http://www.b3f21.cn/'
];
$validate->addColumn('param')->url();
$bool = $validate->validate($data);

lessThanWithColumn

驗證字段的值必須小于with的字段(僅限int)

函數原型

function lessThanWithColumn($fieldName, $msg = null)

string $filedName 需要比較的字段
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'foo' => 10,
    'bar' => 9
];
$validate->addColumn('bar')->lessThanWithColumn('foo');
$bool = $validate->validate($data);

greaterThanWithColumn

驗證字段的值必須大于with的字段(僅限int)

函數原型

function greaterThanWithColumn($fieldName, $msg = null)

string $filedName 需要比較的字段
string $msg 驗證錯誤時提示消息

使用示例

$validate = new \EasySwoole\Validate\Validate();
$data = [
    'foo' => 10,
    'bar' => 9
];
$validate->addColumn('foo')->greaterThanWithColumn('bar');
$bool = $validate->validate($data);

亚洲精品成人_精品成人一区_999视频在线播放_免费黄色在线_亚洲成人久久久_久久www免费视频

EasySwoole 驗證器組件 1.3.x

組件要求

安裝方法

倉庫地址

默認提供的驗證錯誤信息提示說明

基本使用

使用組件提供的默認的驗證錯誤信息提示

使用自定義的驗證錯誤信息提示

在控制器中封裝使用

方法列表

獲取驗證錯誤相關信息(getError())

函數原型

具體使用示例：

給字段添加驗證規則(addColumn())

函數原型

驗證數據是否合法(validate())

函數原型：

驗證規則用法說明

activeUrl

函數原型

使用示例

alpha

函數原型

使用示例

allDigital

函數原型

使用示例

allowFile

函數原型

使用示例

allowFileType

函數原型

使用示例

alphaNum

函數原型

使用示例

alphaDash

函數原型

使用示例

between

函數原型

使用示例

bool

函數原型

使用示例

callUserRule

函數原型

使用示例

decimal

函數原型

使用示例

dateBefore

函數原型

使用示例

dateAfter

函數原型

使用示例

equal

函數原型

使用示例

different

函數原型

使用示例

equalWithColumn

函數原型

使用示例

differentWithColumn

函數原型

使用示例

float

函數原型

使用示例

func

函數原型

使用示例

isArray

函數原型

使用示例

inArray

獲取驗證錯誤相關信息(`getError()`)

給字段添加驗證規則(`addColumn()`)

驗證數據是否合法(`validate()`)