# 請求
一個應用的請求是用 yii\web\Request 對象來表示的,該對象提供了諸如 請求參數(譯者注:通常是GET參數或者POST參數)、HTTP頭、cookies等信息。 默認情況下,對于一個給定的請求,你可以通過?`request`?[application component](http://www.yiichina.com/doc/guide/2.0/structure-application-components)?應用組件(yii\web\Request 類的實例) 獲得訪問相應的請求對象。在本章節,我們將介紹怎樣在你的應用中使用這個組件。
## 請求參數
要獲取請求參數,你可以調用?`request`?組件的 yii\web\Request::get() 方法和 yii\web\Request::post() 方法。 他們分別返回?`$_GET`?和`$_POST`?的值。例如,
~~~
$request = Yii::$app->request;
$get = $request->get();
// 等價于: $get = $_GET;
$id = $request->get('id');
// 等價于: $id = isset($_GET['id']) ? $_GET['id'] : null;
$id = $request->get('id', 1);
// 等價于: $id = isset($_GET['id']) ? $_GET['id'] : 1;
$post = $request->post();
// 等價于: $post = $_POST;
$name = $request->post('name');
// 等價于: $name = isset($_POST['name']) ? $_POST['name'] : null;
$name = $request->post('name', '');
// 等價于: $name = isset($_POST['name']) ? $_POST['name'] : '';
~~~
> 信息:建議你像上面那樣通過?`request`?組件來獲取請求參數,而不是 直接訪問?`$_GET`?和?`$_POST`。 這使你更容易編寫測試用例,因為你可以偽造數據來創建一個模擬請求組件。
當實現?[RESTful APIs](http://www.yiichina.com/doc/guide/2.0/rest-quick-start)?接口的時候,你經常需要獲取通過PUT, PATCH或者其他的?[request methods](http://www.yiichina.com/doc/guide/2.0/runtime-requests#request-methods)?請求方法提交上來的參數。你可以通過調用 yii\web\Request::getBodyParam() 方法來獲取這些參數。例如,
~~~
$request = Yii::$app->request;
// 返回所有參數
$params = $request->bodyParams;
// 返回參數 "id"
$param = $request->getBodyParam('id');
~~~
> 信息:不同于?`GET`?參數,`POST`,`PUT`,`PATCH`?等等這些提交上來的參數是在請求體中被發送的。 當你通過上面介紹的方法訪問這些參數的時候,`request`?組件會解析這些參數。 你可以通過配置 yii\web\Request::parsers 屬性來自定義怎樣解析這些參數。
## 請求方法
你可以通過?`Yii::$app->request->method`?表達式來獲取當前請求使用的HTTP方法。 這里還提供了一整套布爾屬性用于檢測當前請求是某種類型。 例如,
~~~
$request = Yii::$app->request;
if ($request->isAjax) { /* 該請求是一個 AJAX 請求 */ }
if ($request->isGet) { /* 請求方法是 GET */ }
if ($request->isPost) { /* 請求方法是 POST */ }
if ($request->isPut) { /* 請求方法是 PUT */ }
~~~
## 請求URLs
`request`?組件提供了許多方式來檢測當前請求的URL。
假設被請求的URL是?`http://example.com/admin/index.php/product?id=100`, 你可以像下面描述的那樣獲取URL的各個部分:
* yii\web\Request::url:返回?`/admin/index.php/product?id=100`, 此URL不包括host info部分。
* yii\web\Request::absoluteUrl:返回?`http://example.com/admin/index.php/product?id=100`, 包含host infode的整個URL。
* yii\web\Request::hostInfo:返回?`http://example.com`, 只有host info部分。
* yii\web\Request::pathInfo:返回?`/product`, 這個是入口腳本之后,問號之前(查詢字符串)的部分。
* yii\web\Request::queryString:返回?`id=100`,問號之后的部分。
* yii\web\Request::baseUrl:返回?`/admin`, host info之后, 入口腳本之前的部分。
* yii\web\Request::scriptUrl:返回?`/admin/index.php`, 沒有path info和查詢字符串部分。
* yii\web\Request::serverName:返回?`example.com`, URL中的host name。
* yii\web\Request::serverPort:返回 80, 這是web服務中使用的端口。
## HTTP頭
你可以通過 yii\web\Request::headers 屬性返回的 yii\web\HeaderCollection 獲取HTTP頭信息。 例如,
~~~
// $headers 是一個 yii\web\HeaderCollection 對象
$headers = Yii::$app->request->headers;
// 返回 Accept header 值
$accept = $headers->get('Accept');
if ($headers->has('User-Agent')) { /* 這是一個 User-Agent 頭 */ }
~~~
請求組件也提供了支持快速訪問常用頭的方法,包括:
* yii\web\Request::userAgent:返回?`User-Agent`?頭。
* yii\web\Request::contentType:返回?`Content-Type`?頭的值,?`Content-Type`?是請求體中MIME類型數據。
* yii\web\Request::acceptableContentTypes:返回用戶可接受的內容MIME類型。 返回的類型是按照他們的質量得分來排序的。得分最高的類型將被最先返回。
* yii\web\Request::acceptableLanguages:返回用戶可接受的語言。 返回的語言是按照他們的偏好層次來排序的。第一個參數代表最優先的語言。
假如你的應用支持多語言,并且你想在終端用戶最喜歡的語言中顯示頁面,那么你可以使用語言協商方法 yii\web\Request::getPreferredLanguage()。 這個方法通過 yii\web\Request::acceptableLanguages 在你的應用中所支持的語言列表里進行比較篩選,返回最適合的語言。
> 提示:你也可以使用 yii\filters\ContentNegotiator 過濾器進行動態確定哪些內容類型和語言應該在響應中使用。 這個過濾器實現了上面介紹的內容協商的屬性和方法。
## 客戶端信息
你可以通過 yii\web\Request::userHost 和 yii\web\Request::userIP 分別獲取host name和客戶機的IP地址, 例如,
~~~
$userHost = Yii::$app->request->userHost;
$userIP = Yii::$app->request->userIP;
~~~
- 介紹(Introduction)
- 關于 Yii(About Yii)
- 從 Yii 1.1 升級(Upgrading from Version 1.1)
- 入門(Getting Started)
- 安裝 Yii(Installing Yii)
- 運行應用(Running Applications)
- 第一次問候(Saying Hello)
- 使用 Forms(Working with Forms)
- 玩轉 Databases(Working with Databases)
- 用 Gii 生成代碼(Generating Code with Gii)
- 更上一層樓(Looking Ahead)
- 應用結構(Application Structure)
- 結構概述(Overview)
- 入口腳本(Entry Scripts)
- 應用(Applications)
- 應用組件(Application Components)
- 控制器(Controllers)
- 模型(Models)
- 視圖(Views)
- 模塊(Modules)
- 過濾器(Filters)
- 小部件(Widgets)
- 前端資源(Assets)
- 擴展(Extensions)
- 請求處理(Handling Requests)
- 運行概述(Overview)
- 引導(Bootstrapping)
- 路由引導與創建 URL(Routing and URL Creation)
- 請求(Requests)
- 響應(Responses)
- Sessions and Cookies
- 錯誤處理(Handling Errors)
- 日志(Logging)
- 關鍵概念(Key Concepts)
- 組件(Components)
- 屬性(Properties)
- 事件(Events)
- 行為(Behaviors)
- 配置(Configurations)
- 別名(Aliases)
- 類自動加載(Class Autoloading)
- 服務定位器(Service Locator)
- 依賴注入容器(Dependency Injection Container)
- 配合數據庫工作(Working with Databases)
- 數據庫訪問(Data Access Objects): 數據庫連接、基本查詢、事務和模式操作
- 查詢生成器(Query Builder): 使用簡單抽象層查詢數據庫
- 活動記錄(Active Record): 活動記錄對象關系映射(ORM),檢索和操作記錄、定義關聯關系
- 數據庫遷移(Migrations): 在團體開發中對你的數據庫使用版本控制
- Sphinx
- Redis
- MongoDB
- ElasticSearch
- 接收用戶數據(Getting Data from Users)
- 創建表單(Creating Forms)
- 輸入驗證(Validating Input)
- 文件上傳(Uploading Files)
- 收集列表輸入(Collecting Tabular Input)
- 多模型同時輸入(Getting Data for Multiple Models)
- 顯示數據(Displaying Data)
- 格式化輸出數據(Data Formatting)
- 分頁(Pagination)
- 排序(Sorting)
- 數據提供器(Data Providers)
- 數據小部件(Data Widgets)
- 操作客戶端腳本(Working with Client Scripts)
- 主題(Theming)
- 安全(Security)
- 認證(Authentication)
- 授權(Authorization)
- 處理密碼(Working with Passwords)
- 客戶端認證(Auth Clients)
- 安全領域的最佳實踐(Best Practices)
- 緩存(Caching)
- 概述(Overview)
- 數據緩存(Data Caching)
- 片段緩存(Fragment Caching)
- 分頁緩存(Page Caching)
- HTTP 緩存(HTTP Caching)
- RESTful Web 服務
- 快速入門(Quick Start)
- 資源(Resources)
- 控制器(Controllers)
- 路由(Routing)
- 格式化響應(Response Formatting)
- 授權驗證(Authentication)
- 速率限制(Rate Limiting)
- 版本化(Versioning)
- 錯誤處理(Error Handling)
- 開發工具(Development Tools)
- 調試工具欄和調試器(Debug Toolbar and Debugger)
- 使用 Gii 生成代碼(Generating Code using Gii)
- TBD 生成 API 文檔(Generating API Documentation)
- 測試(Testing)
- 概述(Overview)
- 搭建測試環境(Testing environment setup)
- 單元測試(Unit Tests)
- 功能測試(Functional Tests)
- 驗收測試(Acceptance Tests)
- 測試夾具(Fixtures)
- 高級專題(Special Topics)
- 高級應用模版(Advanced Project Template)
- 從頭構建自定義模版(Building Application from Scratch)
- 控制臺命令(Console Commands)
- 核心驗證器(Core Validators)
- 國際化(Internationalization)
- 收發郵件(Mailing)
- 性能優化(Performance Tuning)
- 共享主機環境(Shared Hosting Environment)
- 模板引擎(Template Engines)
- 集成第三方代碼(Working with Third-Party Code)
- 小部件(Widgets)
- Bootstrap 小部件(Bootstrap Widgets)
- jQuery UI 小部件(jQuery UI Widgets)
- 助手類(Helpers)
- 助手一覽(Overview)
- Array 助手(ArrayHelper)
- Html 助手(Html)
- Url 助手(Url)