Error202
/
yii2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Yii2 framework backup
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12234 Commits
8 Branches
66 Tags
82 MiB
 
 
 
 
 
Tree: e3cd974725
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e3cd974725'
${ noResults }
yii2/docs/guide-ja/runtime-requests.md

8.3 KiB
Raw Blame History

リクエスト

アプリケーションに対するリクエストは、リクエストのパラメータ、HTTP ヘッダ、クッキーなどの情報を提供する yii\web\Request オブジェクトの形で表されます。 与えられたリクエストに対応するリクエストオブジェクトには、デフォルトでは yii\web\Request のインスタンスである 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'] : ''; と同等

Info|情報: 直接に $_GET と $_POST にアクセスしてリクエストのパラメータを読み出す代りに、上記に示されているように、request コンポーネントを通じてそれらを取得することが推奨されます。 このようにすると、ダミーのリクエストデータを持った模擬リクエストコンポーネントを作ることが出来るため、テストを書くことがより容易になります。

RESTful API を実装するときは、PUT、PATCH またはその他の リクエストメソッド によって送信されたパラメータを読み出さなければならないことがよくあります。 そういうパラメータは yii\web\Request::getBodyParam() メソッドを呼ぶことで取得することが出来ます。 例えば、

$request = Yii::$app->request;

// 全てのパラメータを返す
$params = $request->bodyParams;

// パラメータ "id" を返す
$param = $request->getBodyParam('id');

Info|情報: GET パラメータとは異なって、POST、PUT、PATCH などで送信されたパラメータは、リクエストのボディの中で送られます。 上述のメソッドによってこれらのパラメータにアクセスすると、request コンポーネントがパラメータを解析します。 yii\web\Request::parsers プロパティを構成することによって、これらのパラメータが解析される方法をカスタマイズすることが出来ます。

リクエストメソッド

現在のリクエストに使用された HTTP メソッドは、Yii::$app->request->method という式によって取得することが出来ます。 現在のメソッドが特定のタイプであるかどうかをチェックするための、一揃いの真偽値のプロパティも提供されています。 例えば、

$request = Yii::$app->request;

if ($request->isAjax) { // リクエストは AJAX リクエスト }
if ($request->isGet)  { // リクエストメソッドは GET }
if ($request->isPost) { // リクエストメソッドは POST }
if ($request->isPut)  { // リクエストメソッドは PUT }

リクエストの URL

request コンポーネントは現在リクエストされている URL を調べるための方法を数多く提供しています。

リクエストされた URL が http://example.com/admin/index.php/product?id=100 であると仮定したとき、次にまとめたように、この URL のさまざまな部分を取得することが出来ます。

HTTP ヘッダ

yii\web\Request::headers プロパティによって返される yii\web\HeaderCollection を通じて、HTTP ヘッダ情報を取得することが出来ます。例えば、

// $headers は yii\web\HeaderCollection のオブジェクト
$headers = Yii::$app->request->headers;

// Accept ヘッダの値を返す
$accept = $headers->get('Accept');

if ($headers->has('User-Agent')) { // User-Agent ヘッダが在る }

request コンポーネントは、よく使用されるいくつかのヘッダにすばやくアクセスする方法を提供しています。 その中には下記のものが含まれます。

  • yii\web\Request::userAgent: User-Agent ヘッダの値を返します。
  • yii\web\Request::contentType: リクエストボディのデータの MIME タイプを示す Content-Type ヘッダの値を返します。
  • yii\web\Request::acceptableContentTypes: ユーザが受け入れ可能なコンテントの MIME タイプを返します。 返されるタイプは品質スコアによって順序付けられます。最もスコアの高いタイプが最初に返されます。
  • yii\web\Request::acceptableLanguages: ユーザが受け入れ可能な言語を返します。 返される言語は優先レベルによって順序付けられます。最初の要素が最も優先度の高い言語を表します。

あなたのアプリケーションが複数の言語をサポートしており、エンドユーザが最も優先する言語でページを表示したいと思う場合は、言語ネゴシエーションメソッド yii\web\Request::getPreferredLanguage() を使うことが出来ます。 このメソッドはアプリケーションによってサポートされている言語のリストを引数として取り、 yii\web\Request::acceptableLanguages と比較して、最も適切な言語を返します。

Tip|ヒント: yii\filters\ContentNegotiator フィルタを使用して、レスポンスにおいてどのコンテントタイプと言語を使うべきかを動的に決定することも出来ます。 このフィルタは、上記で説明したプロパティとメソッドの上に、コンテントネゴシエーションを実装しています。

クライアント情報

クライアントマシンのホスト名と IP アドレスを、それぞれ、yii\web\Request::userHost と yii\web\Request::userIP によって取得することが出来ます。例えば、

$userHost = Yii::$app->request->userHost;
$userIP = Yii::$app->request->userIP;