為了方便說明,本篇內容使用Facade門臉類方式,因此首先需要引入
use think\facade\Request
[TOC]
## 檢測變量是否設置
```
Request::has('id','get')
Request::has('name','post')
變量檢測可以支持所有支持的系統變量,包括`get/post/put/request/cookie/server/session/env/file`
```
## 變量獲取
變量類型方法('變量名/變量修飾符','默認值','過濾方法')
變量類型方法有:
| 方法 | 描述 |
| --- | --- |
| param | 獲取當前請求的變量 |
| get | 獲取 $\_GET 變量 |
| post | 獲取 $\_POST 變量 |
| put | 獲取 PUT 變量 |
| delete | 獲取 DELETE 變量 |
| session | 獲取 $\_SESSION 變量 |
| cookie | 獲取 $\_COOKIE 變量 |
| request | 獲取 $\_REQUEST 變量 |
| server | 獲取 $\_SERVER 變量 |
| env | 獲取 $\_ENV 變量 |
| route | 獲取 路由(包括PATHINFO) 變量 |
| file | 獲取 $\_FILES 變量 |
推薦使用param方法,該方法可以自動識別當前請求的方式
~~~
// 獲取當前請求的name變量
Request::param('name');
// 獲取當前請求的所有變量(經過過濾)
Request::param();
// 獲取當前請求的所有變量(原始數據)
Request::param(false);
// 獲取當前請求的所有變量(包含上傳文件)
Request::param(true);
~~~
如果你使用了依賴注入的方式,可以更簡單的方式獲取請求變量。
~~~
namespace app\index\controller;
use think\Request;
class Index
{
public function index(Request $request)
{
// 獲取name請求變量
return $request->name;
}
}
~~~
其它的輸入變量獲取方法用法基本一致,以`post`方法為例主要有如下三種用法。
~~~
Request::post('name'); // 獲取某個post變量
Request::post(); // 獲取經過全局過濾的全部post變量
Request::post(false); // 獲取全部的post原始(未經全局過濾)變量
~~~
你無法使用**get方法獲取路由變量**,例如當訪問地址是
~~~
http://localhost/index.php/index/index/hello/name/thinkphp
~~~
下面的用法是錯誤的
~~~
echo Request::get('name'); // 輸出為空
~~~
正確的用法是
~~~
echo Request::param('name'); // 輸出thinkphp
echo Request::route('name'); // 輸出thinkphp
~~~
> 變量名區分大小寫,除了`server`和`env`方法的變量名不區分大小寫(會自動轉為大寫后獲取)。
## 默認值
獲取輸入變量的時候,可以支持默認值,例如當URL中不包含`$_GET['name']`的時候,使用下面的方式輸出的結果比較。
~~~
Request::get('name'); // 返回值為null
Request::get('name',''); // 返回值為空字符串
Request::get('name','default'); // 返回值為default
~~~
前面提到的方法都支持在第二個參數中傳入默認值的方式。
## 變量過濾
> 框架默認沒有設置任何全局過濾規則,你可以在應用配置文件中設置全局的過濾規則:
~~~
// 默認全局過濾方法 用逗號分隔多個
'default_filter' => 'htmlspecialchars',
~~~
也支持使用`Request`對象進行全局變量的獲取過濾,過濾方式包括函數、方法過濾,以及PHP內置的Types of filters,我們可以設置全局變量過濾方法,支持設置多個過濾方法,例如:
~~~
Request::filter(['strip_tags','htmlspecialchars']),
~~~
也可以在獲取變量的時候添加過濾方法,例如:
~~~
Request::get('name','','htmlspecialchars'); // 獲取get變量 并用htmlspecialchars函數過濾
Request::param('username','','strip_tags'); // 獲取param變量 并用strip_tags函數過濾
Request::post('name','','org\Filter::safeHtml'); // 獲取post變量 并用org\Filter類的safeHtml方法過濾
~~~
可以支持傳入多個過濾規則,例如:
~~~
Request::param('username','','strip_tags,strtolower'); // 獲取param變量 并依次調用strip_tags、strtolower函數過濾
~~~
Request對象還支持PHP內置提供的Filter ID過濾,例如:
~~~
Request::post('email','',FILTER_VALIDATE_EMAIL);
~~~
框架對FilterID做了轉換支持,因此也可以使用字符串的方式,例如:
~~~
Request::post('email','','email');
~~~
采用字符串方式定義`FilterID`的時候,系統會自動進行一次`filter_id`調用轉換成`Filter`常量。
具體的字符串根據`filter_list`函數的返回值來定義。
> 需要注意的是,采用Filter ID 進行過濾的話,如果不符合過濾要求的話 會返回false,因此你需要配合默認值來確保最終的值符合你的規范。
例如,
~~~
Request::post('email','',FILTER_VALIDATE_EMAIL);
~~~
就表示,如果不是規范的`email`地址的話 返回空字符串。
如果當前不需要進行任何過濾的話,可以使用
~~~
// 獲取get變量 并且不進行任何過濾 即使設置了全局過濾
Request::get('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`的默認值為空字符串。
默認獲取的是當前請求參數(`PARAM`類型變量),如果需要獲取其它類型的參數,可以在第二個參數傳入,例如:
~~~
// 只獲取GET請求的id和name變量
Request::only(['id','name'], 'get');
// 只獲取POST請求的id和name變量
Request::only(['id','name'], 'post');
~~~
也支持排除某些變量后獲取,例如
~~~
// 排除id和name變量
Request::except('id,name');
~~~
或者使用數組方式
~~~
// 排除id和name變量
Request::except(['id','name']);
~~~
同樣支持指定變量類型獲取:
~~~
// 排除GET請求的id和name變量
Request::except(['id','name'], 'get');
// 排除POST請求的id和name變量
Request::except(['id','name'], 'post');
~~~
## 變量修飾符
支持對變量使用修飾符功能,可以一定程度上簡單過濾變量,更為嚴格的過濾請使用前面提過的變量過濾功能。
用法如下:
> ### Request::變量類型('變量名/修飾符');
默認的變量修飾符是`/s`(`V5.1.16+`版本開始取消默認修飾符),因此默認的單個變量的取值返回的都是字符串,如果需要傳入字符串之外的變量可以使用下面的修飾符,包括:
| 修飾符 | 作用 |
| --- | --- |
| s | 強制轉換為字符串類型 |
| d | 強制轉換為整型類型 |
| b | 強制轉換為布爾類型 |
| a | 強制轉換為數組類型 |
| f | 強制轉換為浮點類型 |
下面是一些例子:
~~~
Request::get('id/d');
Request::post('name/s');
Request::post('ids/a');
~~~
> 如果你要獲取的數據為數組,請一定注意要加上`/a`修飾符才能正確獲取到。
## 修改變量
`V5.1.12+`版本開始,可以(通常是在中間件里面)設置請求變量的值。
~~~
<?php
namespace app\http\middleware;
class Check
{
public function handle($request, \Closure $next)
{
if ('think' == $request->name) {
$request->name = 'ThinkPHP';
}
return $next($request);
}
}
~~~
## 助手函數
為了簡化使用,還可以使用系統提供的`input`助手函數完成上述大部分功能。
判斷變量是否定義
~~~
input('?get.id');
input('?post.name');
~~~
獲取PARAM參數
~~~
input('param.name'); // 獲取單個參數
input('param.'); // 獲取全部參數
// 下面是等效的
input('name');
input('');
~~~
獲取GET參數
~~~
// 獲取單個變量
input('get.id');
// 使用過濾方法獲取 默認為空字符串
input('get.name');
// 獲取全部變量
input('get.');
~~~
使用過濾方法
~~~
input('get.name','','htmlspecialchars'); // 獲取get變量 并用htmlspecialchars函數過濾
input('username','','strip_tags'); // 獲取param變量 并用strip_tags函數過濾
input('post.name','','org\Filter::safeHtml'); // 獲取post變量 并用org\Filter類的safeHtml方法過濾
~~~
使用變量修飾符
~~~
input('get.id/d');
input('post.name/s');
input('post.ids/a');
~~~
點贊