自動驗證是ThinkPHP模型層提供的一種數據驗證方法,可以在使用create創建數據對象的時候自動進行數據驗證。
## 驗證規則
數據驗證可以進行數據類型、業務規則、安全判斷等方面的驗證操作。
數據驗證有兩種方式:
1. 靜態方式:在模型類里面通過$_validate屬性定義驗證規則。
1. 動態方式:使用模型類的validate方法動態創建自動驗證規則。
無論是什么方式,驗證規則的定義是統一的規則,定義格式為:
~~~
array(
array(驗證字段1,驗證規則,錯誤提示,[驗證條件,附加規則,驗證時間]),
array(驗證字段2,驗證規則,錯誤提示,[驗證條件,附加規則,驗證時間]),
......
);
~~~
說明
驗證字段 (必須)
需要驗證的表單字段名稱,這個字段不一定是數據庫字段,也可以是表單的一些輔助字段,例如確認密碼和驗證碼等等。有個別驗證規則和字段無關的情況下,驗證字段是可以隨意設置的,例如expire有效期規則是和表單字段無關的。如果定義了字段映射的話,這里的驗證字段名稱應該是實際的數據表字段而不是表單字段。
驗證規則 (必須)
要進行驗證的規則,需要結合附加規則,如果在使用正則驗證的附加規則情況下,系統還內置了一些常用正則驗證的規則,可以直接作為驗證規則使用,包括:require 字段必須、email 郵箱、url URL地址、currency 貨幣、number 數字。
提示信息 (必須)
用于驗證失敗后的提示信息定義
驗證條件 (可選)
包含下面幾種情況:
- self::EXISTS_VALIDATE 或者0 存在字段就驗證(默認)
- self::MUST_VALIDATE 或者1 必須驗證
- self::VALUE_VALIDATE或者2 值不為空的時候驗證
##### 附加規則 (可選)
配合驗證規則使用,包括下面一些規則:
| 規則 | 說明 |
|-----|-----|
| regex | 正則驗證,定義的驗證規則是一個正則表達式(默認) |
| function | 函數驗證,定義的驗證規則是一個函數名 |
| callback | 方法驗證,定義的驗證規則是當前模型類的一個方法 |
| confirm | 驗證表單中的兩個字段是否相同,定義的驗證規則是一個字段名 |
| equal | 驗證是否等于某個值,該值由前面的驗證規則定義 |
| notequal | 驗證是否不等于某個值,該值由前面的驗證規則定義(3.1.2版本新增) |
| in | 驗證是否在某個范圍內,定義的驗證規則可以是一個數組或者逗號分割的字符串 |
| notin | 驗證是否不在某個范圍內,定義的驗證規則可以是一個數組或者逗號分割的字符串(3.1.2版本新增) |
| length | 驗證長度,定義的驗證規則可以是一個數字(表示固定長度)或者數字范圍(例如3,12 表示長度從3到12的范圍) |
| between | 驗證范圍,定義的驗證規則表示范圍,可以使用字符串或者數組,例如1,31或者array(1,31) |
| notbetween | 驗證不在某個范圍,定義的驗證規則表示范圍,可以使用字符串或者數組(3.1.2版本新增) |
| expire | 驗證是否在有效期,定義的驗證規則表示時間范圍,可以到時間,例如可以使用 2012-1-15,2013-1-15 表示當前提交有效期在2012-1-15到2013-1-15之間,也可以使用時間戳定義 |
| ip_allow | 驗證IP是否允許,定義的驗證規則表示允許的IP地址列表,用逗號分隔,例如201.12.2.5,201.12.2.6 |
| ip_deny | 驗證IP是否禁止,定義的驗證規則表示禁止的ip地址列表,用逗號分隔,例如201.12.2.5,201.12.2.6 |
| unique | 驗證是否唯一,系統會根據字段目前的值查詢數據庫來判斷是否存在相同的值,當表單數據中包含主鍵字段時unique不可用于判斷主鍵字段本身 |
##### 驗證時間(可選)
- self::MODEL_INSERT或者1新增數據時候驗證
- self::MODEL_UPDATE或者2編輯數據時候驗證
- self::MODEL_BOTH或者3全部情況下驗證(默認)
這里的驗證時間需要注意,并非只有這三種情況,你可以根據業務需要增加其他的驗證時間。
### 靜態定義
在模型類里面預先定義好該模型的自動驗證規則,我們稱為靜態定義。
舉例說明,我們在模型類里面定義了`$_validate`屬性如下:
~~~
namespace Home\Model;
use Think\Model;
class UserModel extends Model{
protected $_validate = array(
array('verify','require','驗證碼必須!'), //默認情況下用正則進行驗證
array('name','','帳號名稱已經存在!',0,'unique',1), // 在新增的時候驗證name字段是否唯一
array('value',array(1,2,3),'值的范圍不正確!',2,'in'), // 當值不為空的時候判斷是否在一個范圍內
array('repassword','password','確認密碼不正確',0,'confirm'), // 驗證確認密碼是否和密碼一致
array('password','checkPwd','密碼格式不正確',0,'function'), // 自定義函數驗證密碼格式
);
}
~~~
定義好驗證規則后,就可以在使用create方法創建數據對象的時候自動調用:
~~~
$User = D("User"); // 實例化User對象
if (!$User->create()){
// 如果創建失敗 表示驗證沒有通過 輸出錯誤提示信息
exit($User->getError());
}else{
// 驗證通過 可以進行其他數據操作
}
~~~
在進行自動驗證的時候,系統會對定義好的驗證規則進行依次驗證。如果某一條驗證規則沒有通過,則會報錯,getError方法返回的錯誤信息(字符串)就是對應字段的驗證規則里面的錯誤提示信息。
> 靜態定義方式因為必須定義模型類,所以只能用D函數實例化模型
默認情況下,create方法是對表單提交的POST數據進行自動驗證,如果你的數據來源不是表單post,仍然也可以進行自動驗證,方法改進如下:
~~~
$User = D("User"); // 實例化User對象
$data = getData(); // 通過getData方法獲取數據源的(數組)數據
if (!$User->create($data)){
// 對data數據進行驗證
exit($User->getError());
}else{
// 驗證通過 可以進行其他數據操作
}
~~~
一般情況下,create方法會自動判斷當前是新增數據還是編輯數據(主要是通過表單的隱藏數據添加主鍵信息),你也可以明確指定當前創建的數據對象是新增還是編輯,例如:
~~~
$User = D("User"); // 實例化User對象
if (!$User->create($_POST,1)){ // 指定新增數據
// 如果創建失敗 表示驗證沒有通過 輸出錯誤提示信息
exit($User->getError());
}else{
// 驗證通過 可以進行其他數據操作
}
~~~
create方法的第二個參數就用于指定自動驗證規則中的驗證時間,也就是說create方法的自動驗證只會驗證符合驗證時間的驗證規則。
我們在上面提到這里的驗證時間并非只有這幾種情況,你可以根據業務需要增加其他的驗證時間,例如,你可以給登錄操作專門指定驗證時間為4。我們定義驗證規則如下:
~~~
namespace Home\Model;
use Think\Model;
class UserModel extends Model{
protected $_validate = array(
array('verify','require','驗證碼必須!'), // 都有時間都驗證
array('name','checkName','帳號錯誤!',1,'function',4), // 只在登錄時候驗證
array('password','checkPwd','密碼錯誤!',1,'function',4), // 只在登錄時候驗證
);
}
~~~
那么,我們就可以在登錄的時候使用
~~~
$User = D("User"); // 實例化User對象
if (!$User->create($_POST,4)){ // 登錄驗證數據
// 驗證沒有通過 輸出錯誤提示信息
exit($User->getError());
}else{
// 驗證通過 執行登錄操作
}
~~~
### 動態驗證
如果采用動態驗證的方式,就比較靈活,可以根據不同的需要,在操作同一個模型的時候使用不同的驗證規則,例如上面的靜態驗證方式可以改為:
~~~
$rules = array(
array('verify','require','驗證碼必須!'), //默認情況下用正則進行驗證
array('name','','帳號名稱已經存在!',0,'unique',1), // 在新增的時候驗證name字段是否唯一
array('value',array(1,2,3),'值的范圍不正確!',2,'in'), // 當值不為空的時候判斷是否在一個范圍內
array('repassword','password','確認密碼不正確',0,'confirm'), // 驗證確認密碼是否和密碼一致
array('password','checkPwd','密碼格式不正確',0,'function'), // 自定義函數驗證密碼格式
);
$User = M("User"); // 實例化User對象
if (!$User->validate($rules)->create()){
// 如果創建失敗 表示驗證沒有通過 輸出錯誤提示信息
exit($User->getError());
}else{
// 驗證通過 可以進行其他數據操作
}
~~~
> 動態驗證不依賴模型類的定義,所以通常用M函數實例化模型就可以
### 錯誤信息多語言支持
如果你希望支持多語言的錯誤信息提示,那么可以在驗證規則里面如下定義:
~~~
protected $_validate = array(
array('verify','require','{%VERIFY_CODE_MUST}'),
array('name','','{%ACCOUNT_EXISTS}',0,'unique',1),
);
~~~
其中`VERIFY_CODE_MUST`和`ACCOUNT_EXISTS`是我們在語言包里面定義的多語言變量。
如果是采用動態驗證方式,則比較簡單,直接在定義驗證規則的時候使用L方法即可,例如:
~~~
$rules = array(
array('verify','require',L('VERIFY_CODE_MUST')),
array('name','',L('ACCOUNT_EXISTS'),0,'unique',1),
);
~~~
### 批量驗證
系統支持數據的批量驗證功能,只需要在模型類里面設置patchValidate屬性為true( 默認為false),
~~~
protected $patchValidate = true;
~~~
設置批處理驗證后,`getError()` 方法返回的錯誤信息是一個數組,返回格式是:
~~~
array("字段名1"=>"錯誤提示1","字段名2"=>"錯誤提示2"... )
~~~
前端可以根據需要需要自行處理,例如轉換成json格式返回:
~~~
$User = D("User"); // 實例化User對象
if (!$User->create()){
// 如果創建失敗 表示驗證沒有通過 輸出錯誤提示信息
$this->ajaxReturn($User->getError());
}else{
// 驗證通過 可以進行其他數據操作
}
~~~