程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> PHP綜合 >> Yii核心驗證器api詳解

Yii核心驗證器api詳解

編輯：PHP綜合

本文實例講述了Yii核心驗證器api。分享給大家供大家參考，具體如下：

核心驗證器 Core Validators

前言

Yii 提供了一系列常用的核心 validators, 你可在
yii\validators namespace 中找到. 不用使用長的驗證器類名, 你可以使用別名代替他們.

例如, 你可以使用別名 required 代替 yii\validators\RequiredValidator 類:

<?php
public function rules()
{
  return [
    [['email', 'password'], 'required'],
  ];
}
?>

這個 yii\validators\Validator::$builtInValidators 屬性生命所有支持的驗證器的別名.

接下來, 我們將講解每種核心驗證器的用法.

1. boolean 對錯值

<?php
[
  // 檢查是否 "selected" 是 0 或 1, 不管數據類型
  ['selected', 'boolean'],
  // 檢查是否 "deleted" 是一個 boolean 類型, 只能是 true 或則 false
  ['deleted', 'boolean', 'trueValue' => true, 'falseValue' => false, 'strict' => true],
]
?>

上面檢測是否是一個bool值.

trueValue: 代表true時的值. 默認為 '1'.
falseValue: 代表 false 時的值. 默認為 '0'.
strict: 是否輸入框中的值必須匹配設置的 trueValue 和 falseValue. 默認為 false.

注意: 因為數據提交通過HTML形式都是字符創, 一般你需要設置 strict 屬性為 false.

2. captcha 驗證碼

<?php
[
  ['verificationCode', 'captcha'],
]
?>

這個驗證器通常和
yii\captcha\CaptchaAction 以及
yii\captcha\Captcha 一起使用以確保輸入的是相同的驗證碼通過 CAPTCHA 組件.
caseSensitive: 是否驗證碼需要區分大小寫. 默認為 false.
captchaAction: 默認的驗證碼的 CAPTCHA action 生成 CAPTCHA image的路徑. 默認為 'site/captcha'.
skipOnEmpty: 輸入為空的時候是否跳過驗證. 默認false, 即 input 輸入是必須的.

3. compare 比較

<?php
[
  // 驗證是否 "password" 屬性和 "password_repeat"是否相等
  ['password', 'compare'],
  // 驗證 age >= 30
  ['age', 'compare', 'compareValue' => 30, 'operator' => '>='],
]
?>

這個驗證器比較指定的輸入值和另一個值確保他們之間使用指定的操作符.

compareAttribute: 屬性的名字即將會和誰比較.當驗證器被用來驗證一個屬性的時候, 他會和屬性名字相同但帶有後綴 _repeat的屬性相比較. 例如, 如果要驗證的屬性名是 password, 那麼默認對比的屬性名就是 password_repeat 你可以指定你想要的值.
compareValue: 一個和輸入值比較的常量值. 當 property 和 compareAttribute 屬性被同時指定的時候, 這個值將優先.
operator: 比較的操作符. 默認是 ==, 即輸入值和 compareAttribute 或 compareValue 值相等的時候才會成功.
支持下面這些操作符: ==、===、!=、!==、>、>=、<、<=。

4. date 日期

<?php
[
  [['from_date', 'to_date'], 'date'],
]
?>

這個驗證器檢查輸入的值是一個日期date, 時間time 或者datetime 以一個合適的形式. 可選的,他能轉換輸入值成為一個UNIX時間戳存儲在一個通過timestampAttribute 指定的屬性裡.

format: 這個 date/time 是 http://php.net/manual/en/datetime.createfromformat.php 中聲明的所有支持的格式

如果這個值沒有設置, 他會自動取值 Yii::$app->formatter->dateFormat.
timestampAttribute: 屬性名用來存儲轉換將輸入的日期或時間. 也可以是相同的屬性名作為被驗證過的. 如果是這種情況, 原始的值將會被時間戳重寫. 你可以看看 "如何處理日期選擇器 DatePicker" 用例子.
http://www.yiiframework.com/doc-2.0/widget-jui#datepicker-date-input

如果輸入的是可選的，你也可能要添加一個默認值濾波器除了日期驗證，以確保空輸入存儲為NULL。否則你可能最終得到的日期像日期選擇器的輸入字段在0000-00-00 或您的數據庫1970-01-01.

<?php
[
  [['from_date', 'to_date'], 'default', 'value' => null],
  [['from_date', 'to_date'], 'date'],
],
?>

5.default 默認值

<?php
[
  // 設置 "age" 為 null 如果他是空的
  ['age', 'default', 'value' => null],
  // 設置 "country" 為 "USA" 如果他是空的
  ['country', 'default', 'value' => 'USA'],
  // 分配 "from" 和 "to" 分別加3天和6天, 如果他們是空的話
  [['from', 'to'], 'default', 'value' => function ($model, $attribute) {
    return date('Y-m-d', strtotime($attribute === 'to' ? '+3 days' : '+6 days'));
  }],
]
?>

這個驗證器不驗證數據. 當他們為空的時候.分配給屬性值。

value: 表單的默認值函數原型如下,

<?php
function foo($model, $attribute) {
  // ... 組裝 $value ...
  return $value;
}
?>

6. double 浮點值

<?php
[
  // 檢查 "salary" 是一個 double 數字
  ['salary', 'double'],
]
?>

相當於一個數字驗證器：

max: 數字上限，沒設置不檢查
min: 數字下線，沒設置不檢查

7. email 郵箱驗證

<?php
[
  // 檢查郵箱是一個有效的 "email"地址
  ['email', 'email'],
]
?>

allowName: 檢查名字是否允許在郵箱中出現 (e.g. John Smith <[email protected]>). 默認為 false.
checkDNS，是否檢查電子郵件的域名是否存在，是否有任何一個A或MX記錄。請注意，這可能檢查由於臨時DNS問題失敗，即使電子郵件地址實際上是有效的。默認為false。
enableIDN，驗證過程是否應考慮到IDN（國際化域名）。默認為false。需要注意的是，為了使用IDN驗證您必須安裝並啟用國際PHP擴展，或異常將被拋出。

8. exist 是否存在

<?php
[
  // a1 需要在 屬性列中存在 "a1" 這個好像默認就有啊
  ['a1', 'exist'],
  // a1 存在,但它的值將使用A2來檢查是否存在
  ['a1', 'exist', 'targetAttribute' => 'a2'],
  // a1 和 a2 需要同時存在, 他們都將接收錯誤信息
  [['a1', 'a2'], 'exist', 'targetAttribute' => ['a1', 'a2']],
  // a1 和 a2 需要同時存在, 只有 a1 將接收錯誤信息
  ['a1', 'exist', 'targetAttribute' => ['a1', 'a2']],
  // a1 需要存在 通過檢測a2 和 a3 (用 a1 的值)
  ['a1', 'exist', 'targetAttribute' => ['a2', 'a1' => 'a3']],
  // a1 需要存在. 如果 a1是一個數組, 那麼每個元素都必須存在.
  ['a1', 'exist', 'allowArray' => true],
]
?>

這個驗證器檢查輸入的值能否被找到在在對應的表的列值裡，他只會在 Active Record model 模型的屬性裡起作用.

他支持驗證單列或多列

targetClass: 用來尋找輸入值驗證的 Active Record 類名. 如果未設置, 默認使用當前設置的模型類.
targetAttribute: 應該用於驗證輸入值的存在在targetClass的屬性的名稱。如果沒有設置，將使用目前正在驗證的屬性的名稱。可以使用陣列來驗證多列的存在的同時。數組的值是將被用於驗證存在的屬性，而數組鍵是其值要驗證的屬性。如果鍵和值都是一樣的，你可以指定值.
filter: additional filter to be applied to the DB query used to check the existence of the input value. This can be a string or an array representing the additional query condition (refer to yii\db\Query::where() on the format of query condition), or an anonymous function with the signature function ($query), where $query is the Query object that you can modify in the function.
allowArray: 是否允許輸入的值是一個array.默認 false. 若果屬性是 true 而且輸入是一個 array, 那麼熟這裡的每一個元素都必須存在在指向的目標列裡. 注意這個屬性不能被設置成true 如果你設置驗證多列通過設置 targetAttribute 為一個 array.

9. file 文件驗證

<?php
[
  // 檢查 "primaryImage" 上傳的文件格式是 PNG, JPG 或者 GIF
  // the file size must be less than 1MB
  ['primaryImage', 'file', 'extensions' => ['png', 'jpg', 'gif'], 'maxSize' => 1024*1024],
]
?>

檢查是否是一個有效的上傳文件。

extensions: 允許上傳的文件類型列表.他可以是一個數組或者是一個以逗號分割的字符串(如. "gif, jpg"). 擴展名不區分大小寫，默認為 null, 意味著所有的文件擴展名是允許的.
mimeTypes: 允許上傳的文件資源的媒體類型。他可以是一個數組或者是一個以逗號或空格分割的字符串 (如. "image/jpeg, image/png"). 不區分大小寫，默認為 null, 意味著所有的文件擴展名是允許的.
minSize: 上傳文件的最小字節數未設不做判斷.
maxSize: 上傳文件的最大字節數未設不做判斷.
maxFiles: 最大的上傳文件數默認為 1, 意味著只能上傳單個文件對於單個文件上傳框. 如果大於 1, 那麼 input必須是一個 array 包含至多 maxFiles 數量的上傳文件.
checkExtensionByMimeType: 是否檢查文件的擴展名. 如果由MIME類型檢查所產生的擴展不同於上傳的文件擴展名，該文件將被認為是無效的。默認值為true，意思進行這樣的檢查。
FileValidator 和 yii\web\UploadedFile 一起使用. .

文件上傳請參考：http://www.yiiframework.com/doc-2.0/guide-input-file-upload.html

10. filter 過濾

<?php
[
  // 去掉 "username" 和 "email" 輸入空格 跳過數組驗證
  [['username', 'email'], 'filter', 'filter' => 'trim', 'skipOnArray' => true],
  // 驗證正常 "phone" 輸入
  ['phone', 'filter', 'filter' => function ($value) {
    // 驗證正確性手機代碼
    return $value;
  }],
]
?>

這個驗證器驗證不了數據. 相反的, it applies a filter on the input value and assigns it back to the attribute being validated.

filter: 一個php回調函數定義一個filter. 他可能是一個全局函數的名字, 一個匿名函數等等. 函數的原型一定是<?php function ($value) { return $newValue; } ?>這個屬性必須設置.

skipOnArray: 當輸入只是一個數組的時候是否跳過.默認是 false. 請注意，如果過濾器無法處理數組輸入，您應該將此屬性設置為true。否則，可能會發生一些PHP錯誤.

小提示: 去空格直接用trim驗證.

小提示: 部分封裝可以直接使用系統函數如intval:

<?php
['property', 'filter', 'filter' => 'boolval'],
['property', 'filter', 'filter' => 'intval'],
?>

11. image 圖片

<?php
[
  // 檢查 "primaryImage" 是否是一個有效的圖片 且大小合適
  ['primaryImage', 'image', 'extensions' => 'png, jpg',
    'minWidth' => 100, 'maxWidth' => 1000,
    'minHeight' => 100, 'maxHeight' => 1000,
  ],
]
?>

文件驗證器的擴展:

minWidth: 最小的寬度不設無限制.
maxWidth: 最大的寬度不設無限制.
minHeight: 最小的高度不設無限制.
maxHeight: 最大的高度不設無限制.

12. in 在那一個數組裡面的值

<?php
[
  // 檢查 "level" 是 1, 2 或 3
  ['level', 'in', 'range' => [1, 2, 3]],
]
?>

檢查輸入的值是否存在於給定的系列值的列表中.

range: 給定范圍值的列表.
strict: 輸入值和給定值之間的比較結果是否應嚴格（的類型和值必須相同）。默認為false。
not: 驗證結果是否應該被反轉。默認為false。當此屬性設置為true，驗證檢查，輸入的值不能是給定列表的值中.
allowArray: 是否允許輸入值是一個數組。如果這是真的，並輸入值是一個數組，數組中的每個元素必須值的給定列表中找到，或驗證會失敗。

13. integer 整型驗證

<?php
[
  // 檢查 "age" 是一個整型值
  ['age', 'integer'],
]
?>

max: 上限不設不檢查.
min: 下限不設不檢查..

14. match 正則匹配檢查

<?php
[
  // 檢查 "username" 以字母開頭，並且只包含文字字符
  ['username', 'match', 'pattern' => '/^[a-z]\w*$/i']
]
?>

輸入值指定的正則表達式匹配驗證檢查.

pattern: 輸入值必須匹配的規則. 屬性必須設置,否則將會拋出異常.
not: 是否反轉驗證結果. 默認 false.

15. number 數字檢查

<?php
[
  // 檢查 "salary" 是一個數字
  ['salary', 'number'],
]
?>

相當於double驗證器.

max: 上限不設不檢查.
min: 下限不設不檢查.

16. required 是否為空檢查

<?php
[
  // 檢查 "username" 和 "password" 不是空的
  [['username', 'password'], 'required'],
]
?>

該驗證器阻止用戶提交空的表單數據.

requiredValue: 應該輸入的值. 如果未設意味著輸入值不應該為空.
strict: 驗證一個值時是否應該檢查數據類型. 默認false.當 requiredValue未設置時,如果這個屬性是 true, 驗證器會檢查輸入值不嚴格null;如果改屬性false,驗證器將使用一個松散的規則來確定一個值是空的或不. 當 requiredValue設置了,輸入和requiredValue之間的比較也將檢查數據類型，如果此屬性為true。

17. safe 標記輸入是安全屬性

<?php
[
  // 標記 "description" 是一個 safe 的屬性
  ['description', 'safe'],
]
?>

這個驗證器不會執行數據驗證.相反, 它是用來標記的屬性是一個安全屬性(我猜作用是不會進行字符轉義吧)。

18. string 字符串驗證

<?php
[
  // 檢查 "username"是一個 string 而且長度在 4 和 24 之間
  ['username', 'string', 'length' => [4, 24]],
]
?>

這個驗證器檢查輸入的值是一個字符串且長度在確定的值的范圍裡。

length: 指定待驗證的字符串的長度. 可以指定以下形式:
   一個整數: 字符串的精確長度;
   單個數組元素: 輸入的最小長度 (e.g. [8]). 必須超過或等於這個數
   兩個數組元素: 輸入的最小長度和最大長度 (e.g. [8, 128]).
min: 輸入字符串的最小長度未設不限制.
max: 輸入字符串的最大長度未設不限制..
encoding: 輸入字符串的編碼未設默認 UTF-8.

19. trim 去空格

<?php
[
  // 去掉 "username" 和 "email" 兩邊的空格
  [['username', 'email'], 'trim'],
]
?>

不進行數據驗證只進行去空格如果屬性是一個數組將會自動忽略此過濾.

20. unique 唯一性驗證

<?php
[
  // a1 需要是在由“a1”屬性表示的列中的唯一
  ['a1', 'unique'],
  // a1 必須是唯一的，但列a2將用於檢查的a1值的唯一性
  ['a1', 'unique', 'targetAttribute' => 'a2'],
  // a1和a2的需要是唯一的，並且它們都將收到錯誤消息
  [['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']],
  // a1和a2的需要是唯一的，只有a1將收到錯誤消息
  ['a1', 'unique', 'targetAttribute' => ['a1', 'a2']],
  // a1需要通過檢查的兩個a2和a3的唯一性（使用a1的值）是唯一的
  ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']],
]
?>

這驗證檢查，如果輸入的值是表列中的唯一。它僅適用於活動記錄模型的屬性。它支持驗證對任何單個列或多個列。

targetClass: 應該是被用於驗證查找輸入值的活動記錄類的名字。如果沒有設置，將要使用的類目前正在驗證該模型的.
targetAttribute: 應該用來驗證輸入值的唯一性在targetClass的屬性的名稱。如果沒有設置，將使用目前正在驗證的屬性的名稱。可以使用陣列來驗證多列的唯一性的同時。數組的值是將被用於驗證唯一性的屬性，而數組鍵是其值要驗證的屬性。如果鍵和值都是一樣的，你可以指定的值。
filter: a額外的過濾器被應用到用於檢查輸入值的唯一性的數據庫查詢。這可以是一個字符串或代表附加查詢條件的數組(參考 yii\db\Query::where() 查詢條件的格式), 或者是一個匿名函數像： function ($query), 其中$query是你可以在函數修改查詢對象。
http://www.yiiframework.com/doc-2.0/yii-db-query.html#where()-detail

21. url 地址驗證

<?php
[
  // 檢查 "website" 是一個有效的 URL. 前置 "http://" 到 "website" 屬性
  // 如果它不具有一個URI模式
  ['website', 'url', 'defaultScheme' => 'http'],
]
?>

validSchemes: 一個數組指定URI方案應被認為有效。默認為['HTTP'，'HTTPS']，意思是HTTP和HTTPS URL被認為是有效的。
defaultScheme: 默認URI方案要預先考慮到輸入，如果它不具有方案的一部分。默認為null，意味著不修改輸入值。
enableIDN：驗證是否應考慮到IDN（國際化域名）。默認為false。需要注意的是，為了使用IDN驗證您必須安裝並啟用國際PHP擴展，否則異常將會被拋出。

更多關於Yii相關內容感興趣的讀者可查看本站專題：《Yii框架入門及常用技巧總結》、《php優秀開發框架總結》、《smarty模板入門基礎教程》、《php面向對象程序設計入門教程》、《php字符串(string)用法總結》、《php+mysql數據庫操作入門教程》及《php常見數據庫操作技巧匯總》

希望本文所述對大家基於Yii框架的PHP程序設計有所幫助。

PHP綜合