微擎表單驗(yàn)證

中文 | English

目錄

• 驗(yàn)證器
• 驗(yàn)證場(chǎng)景
• 場(chǎng)景事件
• 規(guī)則管理器
• 內(nèi)置規(guī)則
• 自定義驗(yàn)證規(guī)則
• 自定義消息
• 默認(rèn)值
• 過(guò)濾器
• 驗(yàn)證集合

安裝

使用composer命令

composer require w7/engine-validate

完整文檔查看完整文檔

簡(jiǎn)單驗(yàn)證

支持簡(jiǎn)單定義一個(gè)驗(yàn)證器并進(jìn)行驗(yàn)證：

try {
    $data = Validate::make([
        'user' => 'required|email',
        'pass' => 'required|lengthBetween:6,16',
    ], [
        'user.required'      => '請(qǐng)輸入用戶名',
        'user.email'         => '用戶名格式錯(cuò)誤',
        'pass.required'      => '請(qǐng)輸入密碼',
        'pass.lengthBetween' => '密碼長(zhǎng)度為6~16位',
    ])->check($data);
} catch (ValidateException $e) {
    echo $e->getMessage();
}

如果驗(yàn)證通過(guò)，則返回所有通過(guò)驗(yàn)證的值，如未通過(guò)，則拋出一個(gè)W7\\Validate\\Exception\\ValidateException異常

驗(yàn)證器定義

為具體的驗(yàn)證場(chǎng)景或者數(shù)據(jù)表單定義驗(yàn)證器類，我們需要繼承W7\\Validate\\Validate類，然后實(shí)例化后直接調(diào)用驗(yàn)證類的check方法即可完成驗(yàn)證，下面是一個(gè)例子：

我們定義一個(gè)LoginValidate驗(yàn)證器類用于登錄的驗(yàn)證。

class LoginValidate extends Validate
{
    protected $rule = [
        'user' => 'required|email',
        'pass' => 'required|digits_between:6,16',
    ];
    
    protected $message = [
        'user.required'       => '請(qǐng)輸入用戶名',
        'user.email'          => '用戶名格式錯(cuò)誤',
        'pass.required'       => '請(qǐng)輸入密碼',
        'pass.digits_between' => '密碼長(zhǎng)度為6~16位',
    ];
}

類屬性定義的錯(cuò)誤消息，優(yōu)先級(jí)要高于自定義規(guī)則中的默認(rèn)回復(fù)，高于自定義規(guī)則方法返回的錯(cuò)誤

數(shù)據(jù)驗(yàn)證

$data = [
    'user' => '123@qq.com',
    'pass' => ''
];
$validate = new LoginValidate();
$validate->check($data);

此時(shí)會(huì)拋出一個(gè)W7\\Validate\\Exception\\ValidateException異常，message為請(qǐng)輸入密碼

$data = [
    'user' => '123@qq.com',
    'pass' => '123456'
];
$validate = new LoginValidate();
$data = $validate->check($data);

驗(yàn)證成功，并返回通過(guò)驗(yàn)證的值，返回的值為數(shù)組類型

驗(yàn)證數(shù)組

驗(yàn)證表單的輸入為數(shù)組的字段也不難。你可以使用 「點(diǎn)」方法來(lái)驗(yàn)證數(shù)組中的屬性。例如，如果傳入的 HTTP 請(qǐng)求中包含search[keyword]字段， 可以如下驗(yàn)證：

protected $rule = [
    'search.order'   => 'numeric|between:1,2',
    'search.keyword' => 'chsAlphaNum',
    'search.recycle' => 'boolean',
];

你也可以驗(yàn)證數(shù)組中的每個(gè)元素。例如，要驗(yàn)證指定數(shù)組輸入字段中的每一個(gè) id 是唯一的，可以這么做：

protected $rule = [
    'search.*.id' => 'numeric|unique:account'
];

數(shù)組規(guī)則的錯(cuò)誤消息的定義也一樣

protected $message = [
    'search.order.numeric'       => '排序參數(shù)錯(cuò)誤',
    'search.order.between'       => '排序參數(shù)錯(cuò)誤',
    'search.keyword.chsAlphaNum' => '關(guān)鍵詞只能包含中文，字母，數(shù)字',
    'search.recycle.boolean'     => '參數(shù)錯(cuò)誤：recycle',
];

驗(yàn)證器類屬性

$rule

用戶定義驗(yàn)證器的驗(yàn)證規(guī)則，也可以通過(guò)setRules方法來(lái)進(jìn)行設(shè)置，此方法為疊加，如果參數(shù)為null則為清空全部規(guī)則

// 類中定義
protected $rule = [
    'user' => 'required'
];

// 使用方法定義
$v->setRules([
    'user' => 'required'
]);

$message

用戶定義驗(yàn)證器的錯(cuò)誤信息，也可以通過(guò)setMessages方法來(lái)進(jìn)行設(shè)置，此方法為疊加，如果參數(shù)為null則為清空全部錯(cuò)誤消息

// 類中定義
protected $message = [
    'user.required' => '賬號(hào)必須填寫'
];

// 使用方法定義
$v->setMessages([
    'user.required' => '賬號(hào)必須填寫'
]);

$scene

定義驗(yàn)證場(chǎng)景的數(shù)據(jù)，用于指定驗(yàn)證場(chǎng)景對(duì)應(yīng)的驗(yàn)證字段等，詳細(xì)用法查看驗(yàn)證場(chǎng)景一節(jié),同樣也可以通過(guò)setScene方法來(lái)進(jìn)行設(shè)置，此方法為疊加，如果參數(shù)為null則為清空全部驗(yàn)證場(chǎng)景

// 類中定義
protected $scene = [
    'login' => ['user', 'pass']
];

// 使用方法定義
$v->setScene([
    'login' => ['user', 'pass']
]);

$event

定義此驗(yàn)證器下的全局事件，詳細(xì)用法查看事件一節(jié)

protected $event = [
    CheckSiteStatus::class
];

$customAttributes

定義驗(yàn)證字段的名稱,也可以通過(guò)setCustomAttributes方法來(lái)進(jìn)行設(shè)置，此方法為疊加，如果參數(shù)為null則為清空全部字段名稱， 錯(cuò)誤消息中的:attribute會(huì)使用下面的值對(duì)應(yīng)的替換

protected $customAttributes = [
    'user' => '賬號(hào)',
    'pass' => '密碼'
];

$default

定義字段的默認(rèn)值

protected $default = [
    'name' => '張三'
];

關(guān)于默認(rèn)值的詳情請(qǐng)查看默認(rèn)值一節(jié)

$filter

用于數(shù)據(jù)驗(yàn)證后處理數(shù)據(jù)

protected $filter = [
    'name' => 'trim'
];

關(guān)于過(guò)濾器的詳情請(qǐng)查看過(guò)濾器一節(jié)

$ruleMessage

類方法規(guī)則的錯(cuò)誤信息

 protected $ruleMessage = [
    ':attribute的值只能具有中文'
];

點(diǎn)擊查看示例

$filled

所有驗(yàn)證的字段在存在時(shí)不能為空，如果此屬性值為true,所有規(guī)則會(huì)自動(dòng)增加filled規(guī)則，默認(rèn)為true

當(dāng)出現(xiàn)以下情況時(shí)，不會(huì)自動(dòng)添加filled規(guī)則

• 驗(yàn)證規(guī)則中存在filled, nullable, accepted, present,required, required_if, required_unless, required_with,required_with_all, required_without, required_without_all規(guī)則
• 驗(yàn)證規(guī)則存在extendImplicit定義的規(guī)則
• 驗(yàn)證規(guī)則存在extendImplicitRule定義的規(guī)則
• 驗(yàn)證規(guī)則實(shí)現(xiàn)了Itwmw\\Validation\\Support\\Interfaces\\ImplicitRule標(biāo)記接口

protected bool $filled = true;

$regex

預(yù)定義正則表達(dá)式驗(yàn)證規(guī)則,詳情查看正則表達(dá)式規(guī)則

protected $regex = [
    'number' => '/^\\d+$/'
];