在Web開發過程中,我們經常需要獲取系統變量或者用戶提交的數據,這些變量數據錯綜復雜,而且一不小心就容易引起安全隱患,但是如果利用好ThinkPHP提供的變量獲取功能,就可以輕松的獲取和駕馭變量了。
獲取變量
雖然你仍然可以在開發過程中使用傳統方式獲取各種系統變量,例如:
$id = $_GET['id']; // 獲取get變量
$name = $_POST['name']; // 獲取post變量
$value = $_SESSION['var']; // 獲取session變量
$name = $_COOKIE['name']; // 獲取cookie變量
$file = $_SERVER['PHP_SELF']; // 獲取server變量
但是我們不建議直接使用傳統方式獲取,因為沒有統一的安全處理機制,后期如果調整的話,改起來會比較麻煩。所以,更好的方式是在框架中統一使用I函數進行變量獲取和過濾。
I方法是ThinkPHP用於更加方便和安全的獲取系統輸入變量,可以用於任何地方,用法格式如下:
I('變量類型.變量名/修飾符',['默認值'],['過濾方法'],['額外數據源'])
變量類型是指請求方式或者輸入類型,包括:
變量類型 | 含義 |
---|---|
get | 獲取GET參數 |
post | 獲取POST參數 |
param | 自動判斷請求類型獲取GET、POST或者PUT參數 |
request | 獲取REQUEST 參數 |
put | 獲取PUT 參數 |
session | 獲取 $_SESSION 參數 |
cookie | 獲取 $_COOKIE 參數 |
server | 獲取 $_SERVER 參數 |
globals | 獲取 $GLOBALS參數 |
path | 獲取 PATHINFO模式的URL參數(3.2.2新增) |
data | 獲取 其他類型的參數,需要配合額外數據源參數(3.2.2新增) |
注意:變量類型不區分大小寫。
變量名則嚴格區分大小寫。
默認值和過濾方法均屬於可選參數。變量修飾符是3.2.3版本新增
我們以GET變量類型為例,說明下I方法的使用:
echo I('get.id'); // 相當於 $_GET['id']
echo I('get.name'); // 相當於 $_GET['name']
支持默認值:
echo I('get.id',0); // 如果不存在$_GET['id'] 則返回0
echo I('get.name',''); // 如果不存在$_GET['name'] 則返回空字符串
采用方法過濾:
// 采用htmlspecialchars方法對$_GET['name'] 進行過濾,如果不存在則返回空字符串
echo I('get.name','','htmlspecialchars');
支持直接獲取整個變量類型,例如:
// 獲取整個$_GET 數組
I('get.');
用同樣的方式,我們可以獲取post或者其他輸入類型的變量,例如:
I('post.name','','htmlspecialchars'); // 采用htmlspecialchars方法對$_POST['name'] 進行過濾,如果不存在則返回空字符串
I('session.user_id',0); // 獲取$_SESSION['user_id'] 如果不存在則默認為0
I('cookie.'); // 獲取整個 $_COOKIE 數組
I('server.REQUEST_METHOD'); // 獲取 $_SERVER['REQUEST_METHOD']
param變量類型是框架特有的支持自動判斷當前請求類型的變量獲取方式,例如:
echo I('param.id');
如果當前請求類型是GET,那么等效於 $_GET['id'],如果當前請求類型是POST或者PUT,那么相當於獲取 $_POST['id'] 或者 PUT參數id。
由於param類型是I函數默認獲取的變量類型,因此事實上param變量類型的寫法可以簡化為:
I('id'); // 等同於 I('param.id')
I('name'); // 等同於 I('param.name')
3.2.2新增了path和data兩個變量類型
,用法如下:
path類型變量可以用於獲取URL參數(必須是PATHINFO模式參數有效,無論是GET還是POST方式都有效),例如: 當前訪問URL地址是 http://serverName/index.php/New/2013/06/01
那么我們可以通過
echo I('path.1'); // 輸出2013
echo I('path.2'); // 輸出06
echo I('path.3'); // 輸出01
data類型變量可以用於獲取不支持的變量類型的讀取,例如:
I('data.file1','','',$_FILES);
變量過濾
如果你沒有在調用I函數的時候指定過濾方法的話,系統會采用默認的過濾機制(由DEFAULT_FILTER配置),事實上,該參數的默認設置是:
// 系統默認的變量過濾機制
'DEFAULT_FILTER' => 'htmlspecialchars'
也就說,I方法的所有獲取變量如果沒有設置過濾方法的話都會進行htmlspecialchars過濾,那么:
// 等同於 htmlspecialchars($_GET['name'])
I('get.name');
同樣,該參數也可以設置支持多個過濾,例如:
'DEFAULT_FILTER' => 'strip_tags,htmlspecialchars'
設置后,我們在使用:
// 等同於 htmlspecialchars(strip_tags($_GET['name']))
I('get.name');
如果我們在使用I方法的時候 指定了過濾方法,那么就會忽略DEFAULT_FILTER的設置,例如:
// 等同於 strip_tags($_GET['name'])
echo I('get.name','','strip_tags');
I方法的第三個參數如果傳入函數名,則表示調用該函數對變量進行過濾並返回(在變量是數組的情況下自動使用array_map
進行過濾處理),否則會調用PHP內置的filter_var
方法進行過濾處理,例如:
I('post.email','',FILTER_VALIDATE_EMAIL);
表示 會對$_POST['email']
進行 格式驗證,如果不符合要求的話,返回空字符串。 (關於更多的驗證格式,可以參考 官方手冊的filter_var
用法。) 或者可以用下面的字符標識方式:
I('post.email','','email');
可以支持的過濾名稱必須是filter_list
方法中的有效值(不同的服務器環境可能有所不同),可能支持的包括:
int
boolean
float
validate_regexp
validate_url
validate_email
validate_ip
string
stripped
encoded
special_chars
unsafe_raw
email
url
number_int
number_float
magic_quotes
callback
3.2.3版本開始支持進行正則匹配過濾,例如:
// 采用正則表達式進行變量過濾
I('get.name','','/^[A-Za-z]+$/');
I('get.id',0,'/^\d+$/');
如果正則匹配不通過的話,則返回默認值。
在有些特殊的情況下,我們不希望進行任何過濾,即使DEFAULT_FILTER已經有所設置,可以使用:
// 下面兩種方式都不采用任何過濾方法
I('get.name','','');
I('get.id','',false);
一旦過濾參數設置為空字符串或者false,即表示不再進行任何的過濾。
變量修飾符
3.2.3版本開始,I函數支持對變量使用修飾符功能,可以更好的過濾變量。
用法如下: I('變量類型.變量名/修飾符');
例如:
I('get.id/d');
I('post.name/s');
I('post.ids/a');
可以使用的修飾符包括:
修飾符 | 作用 |
---|---|
s | 強制轉換為字符串類型 |
d | 強制轉換為整形類型 |
b | 強制轉換為布爾類型 |
a | 強制轉換為數組類型 |
f | 強制轉換為浮點類型 |