Jeckleee/Tools

一些常用工具:

• 數(shù)據(jù)驗(yàn)證 : 總是記不住驗(yàn)證器的規(guī)則,每次都得查詢文檔,所以本工具提供了一個(gè)符合直覺的驗(yàn)證器,使用鏈?zhǔn)秸{(diào)用添加規(guī)則,方便記憶和使用
• 常用Function :封裝了一些常用的方法

安裝

composer require jeckleee/tools

配置

//配置文件: config/plugin/jeckleee/tools/app.php

return [
    'enable' => true,

    // 定義驗(yàn)證失敗以后拋出的異常,webman框架建議使用 support\exception\BusinessException::class
    'exception' => Exception::class,

    // 定義驗(yàn)證失敗的錯(cuò)誤碼
    'exception_code' => 500,

    //驗(yàn)證失敗錯(cuò)誤如何返回(immediate,collective)
    //immediate:立即返回,只要驗(yàn)證出現(xiàn)錯(cuò)誤,立即拋出當(dāng)前錯(cuò)誤字段的異常信息,不再驗(yàn)證剩余的字段
    //collective:集中返回,驗(yàn)證全部字段,收集所有異常,驗(yàn)證結(jié)束后在異常$e->getMessage()中返回錯(cuò)誤字段的列表,json字符串形式
    'error_return_mode' => 'immediate',

];

查看所有支持的驗(yàn)證規(guī)則

use Jeckleee\Tools\Validator
echo json_encode(Validator::$showAllRules);
//此工具已經(jīng)收集了大多數(shù)的常用規(guī)則,歡迎大家提交pr補(bǔ)充新的規(guī)則

使用場(chǎng)景1:驗(yàn)證表單提交的數(shù)據(jù)

use Jeckleee\Tools\Validator

$post=['name'=>'jeckleee','password'=>'123456','email'=>'jeckleee@qq.com','age'=>18];

//驗(yàn)證一組數(shù)據(jù)
$data=Validator::array($post,[
     //只有寫在此數(shù)組中的字段才會(huì)驗(yàn)證并存儲(chǔ)到$data中
     Validator::field('name')->required()->strTrim()->strLength(3,32)->verify('請(qǐng)?zhí)顚懻_的用戶名'),

     //使用自定義正則表達(dá)式驗(yàn)證
     Validator::field('password')->required()->withRegex('/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,}$/')->verify('要求密碼必須包含大寫字母、小寫字母、數(shù)字和特殊字符'),
     Validator::field('email')->required()->isEmail()->verify('請(qǐng)?zhí)顚懻_的郵箱'),

     //不驗(yàn)證score字段,如果字段不存在則返回["score"=>null]
     Validator::field('score')->verify(),

     //存在則驗(yàn)證,如果字段不存在則不驗(yàn)證,也不會(huì)出現(xiàn)在最終的數(shù)據(jù)中
     Validator::field('score')->ifExisted()->isInt()->betweenNumber(0,100)->verify('請(qǐng)?zhí)顚懻_的分?jǐn)?shù)'),

]);
//$data=['name'=>'jeckleee','password'=>'123456','email'=>'jeckleee@qq.com','score'=>null]; //age字段不會(huì)出現(xiàn)在$data中

// 按需使用 extract 函數(shù)將關(guān)聯(lián)數(shù)組轉(zhuǎn)換為變量
extract($data);
// 現(xiàn)在可以使用這些變量了
echo $name; // 輸出: jeckleee
echo $password;  // 輸出: 123456
echo email; // 輸出: jeckleee@qq.com

驗(yàn)證一個(gè)字段

//驗(yàn)證一個(gè)字段
$data=Validator::one($post,[
     Validator::field('age')->required()->isInt()->betweenNumber(1,120)->verify('請(qǐng)?zhí)顚懻_的年齡'),
]);
echo $data; //$data=18

自定義驗(yàn)證規(guī)則

//自定義驗(yàn)證方法,只有回調(diào)方法返回(bool)true時(shí),才驗(yàn)證通過,否則驗(yàn)證失敗
$data=Validator::one($post,[
     Validator::field('age')->fun(function ($value){
         if ($value<18){
             return false;
         }
         return true;
     })->verify('年齡不能小于18歲'),
]);

自定義驗(yàn)異常和錯(cuò)誤碼

//自定義驗(yàn)證失敗的異常
$data=Validator::array($post,[
     //......省略
],MyException::class);
//如果不定義異常類，則使用配置文件中定義的異常

//三種異常定義的區(qū)別:
//1.使用配置文件中定義異常和錯(cuò)誤碼
$data=Validator::array($post,[
      Validator::field('name')->required()->verify('請(qǐng)?zhí)顚戀~號(hào)'),
      //......省略
]);

//2.在使用array()或者one()方法時(shí)定義異常和錯(cuò)誤碼,會(huì)覆蓋配置文件中定義的異常
$data=Validator::array($post,[
    Validator::field('name')->required()->verify('請(qǐng)?zhí)顚戀~號(hào)'),
    //......省略
],MyException::class);

//3.在規(guī)則中的->verify()方法中定義的錯(cuò)誤碼優(yōu)級(jí)最高,會(huì)覆蓋之前所有的定義
$data=Validator::array($post,[
      Validator::field('name')->required()->verify('請(qǐng)?zhí)顚戀~號(hào)',12001),
      Validator::field('age')->required()->isInt()->betweenNumber(1,120)->verify('請(qǐng)?zhí)顚懻_的年齡',12002),
      //......省略
]);

一個(gè)使用示例

use Jeckleee\Tools\Validator as V;
use support\Request;

class PostController extends BaseController

{
    /**
     * @Notes: 保存數(shù)據(jù)
     * @Name save
     * @return \support\Response
     * @author: -
     * @Time: 2024/2/5 15:06
     */
    public function save(Request $request): \support\Response
    {

        try {
            $input = V::array($request->all(), [
                V::field('title')->required()->verify('請(qǐng)?zhí)顚憳?biāo)題'),
                V::field('content')->required()->verify('請(qǐng)?zhí)顚憙?nèi)容'),
                V::field('category_id')->required(1)->isInt()->inArray([1,2,3,4])->verify('請(qǐng)選擇正確的分類'),
                V::field('status')->required(-1)->inArray([-1, 1, 2, 9])->verify('請(qǐng)選擇正確的狀態(tài)'),
            ]);
            $post = Post::create($input);
            $this->msg = '保存成功';
        } catch (BusinessException $exception) {
            $this->code = $exception->getCode() ?: 300;
            $this->msg = $exception->getMessage();
            $this->status = 'error';
        }

        return json($this->getFormatApiData());//getFormatApiData是一個(gè)我自己的自定義方法,返回格式化后的數(shù)據(jù)或者錯(cuò)誤
    }

使用場(chǎng)景2: 驗(yàn)證變量是否正確,返回(bool) TURE or FALSE

use Jeckleee\Tools\Validator as V;

$phone='123456789';

if (V::var($phone)->isMobile()->check()){
    echo '手機(jī)號(hào)碼正確';
}else{
    echo '手機(jī)號(hào)碼不正確'
}

注意事項(xiàng)

• 暫無