# 輸入變量
可以通過`Request`對象完成全局輸入變量的檢測、獲取和安全過濾,
為了方便說明,本篇內容的所有示例代碼均使用`Facade`方式,因此需要首先引入
~~~
use think\facade\Request;
~~~
如果你使用的是依賴注入,請自行調整代碼為動態調用即可。
### 獲取變量
長連接中沒有http方式下的GET,POST等方式,獲取變量使用統一的param方法
~~~
// 獲取當前請求的name變量
Request::param('name');
// 獲取當前請求的所有變量
Request::param();
~~~
## 默認值
獲取輸入變量的時候,可以支持默認值,例如當data中不包含`name`的時候,使用下面的方式輸出的結果比較。
~~~
Request::param('name'); // 返回值為null
Request::param('name',''); // 返回值為空字符串
Request::param('name','default'); // 返回值為default
~~~
前面提到的方法都支持在第二個參數中傳入默認值的方式。
## 變量過濾
> 框架默認沒有設置任何全局過濾規則,你可以在應用配置文件中設置全局的過濾規則:
~~~
// 默認全局過濾方法 用逗號分隔多個
'default_filter' => 'htmlspecialchars',
~~~
也支持使用`Request`對象進行全局變量的獲取過濾,過濾方式包括函數、方法過濾,以及PHP內置的Types of filters,我們可以設置全局變量過濾方法,支持設置多個過濾方法,例如:
~~~
Request::filter(['strip_tags','htmlspecialchars']),
~~~
也可以在獲取變量的時候添加過濾方法,例如:
~~~
Request::param('name','','htmlspecialchars'); // 獲取get變量 并用htmlspecialchars函數過濾
Request::param('username','','strip_tags'); // 獲取param變量 并用strip_tags函數過濾
Request::param('name','','org\Filter::safeHtml'); // 獲取post變量 并用org\Filter類的safeHtml方法過濾
~~~
可以支持傳入多個過濾規則,例如:
~~~
Request::param('username','','strip_tags,strtolower'); // 獲取param變量 并依次調用strip_tags、strtolower函數過濾
~~~
Request對象還支持PHP內置提供的Filter ID過濾,例如:
~~~
Request::param('email','',FILTER_VALIDATE_EMAIL);
~~~
框架對FilterID做了轉換支持,因此也可以使用字符串的方式,例如:
~~~
Request::param('email','','email');
~~~
采用字符串方式定義`FilterID`的時候,系統會自動進行一次`filter_id`調用轉換成`Filter`常量。
具體的字符串根據`filter_list`函數的返回值來定義。
> 需要注意的是,采用Filter ID 進行過濾的話,如果不符合過濾要求的話 會返回false,因此你需要配合默認值來確保最終的值符合你的規范。
例如,
~~~
Request::param('email','',FILTER_VALIDATE_EMAIL);
~~~
就表示,如果不是規范的`email`地址的話 返回空字符串。
如果當前不需要進行任何過濾的話,可以使用
~~~
// 獲取get變量 并且不進行任何過濾 即使設置了全局過濾
Request::param('name', '', null);
~~~
## 獲取部分變量
如果你只需要獲取當前請求的部分參數,可以使用:
~~~
// 只獲取當前請求的id和name變量
Request::only('id,name');
~~~
或者使用數組方式
~~~
// 只獲取當前請求的id和name變量
Request::only(['id','name']);
~~~
> 采用`only`方法能夠安全的獲取你需要的變量,避免額外變量影響數據處理和寫入。
`V5.1.3+`版本開始,only方法可以支持批量設置默認值,如下:
~~~
// 設置默認值
Request::only(['id'=>0,'name'=>'']);
~~~
表示`id`的默認值為0,`name`的默認值為空字符串。
也支持排除某些變量后獲取,例如
~~~
// 排除id和name變量
Request::except('id,name');
~~~
或者使用數組方式
~~~
// 排除id和name變量
Request::except(['id','name']);
~~~
## 變量修飾符
支持對變量使用修飾符功能,可以一定程度上簡單過濾變量,更為嚴格的過濾請使用前面提過的變量過濾功能。
用法如下:
> ### Request::變量類型('變量名/修飾符');
| 修飾符 | 作用 |
| --- | --- |
| s | 強制轉換為字符串類型 |
| d | 強制轉換為整型類型 |
| b | 強制轉換為布爾類型 |
| a | 強制轉換為數組類型 |
| f | 強制轉換為浮點類型 |
下面是一些例子:
~~~
Request::param('id/d');
Request::param('name/s');
Request::param('ids/a');
~~~
> 如果你要獲取的數據為數組,請一定注意要加上`/a`修飾符才能正確獲取到。