Laravel 5でのリクエストの扱い方は頻繁に忘れてしまうことがあるため、覚書としてまとめておきます。ここでは、Requestクラスを用いたリクエストの取り扱い方法を整理し、それぞれのメソッドがどのようなデータを返すのかを詳しく解説します。
1. リクエストクラスの基本操作
まず、Requestクラスをコントローラ内で使用するために、通常は以下のように変数に格納します。
$request = app('request');
この変数$requestを使って、様々なリクエストデータを取得できます。
2. リクエストデータの取得
a. リクエストの全入力データを取得する
リクエストのすべての入力データを取得したい場合は、all()メソッドを使用します。このメソッドは、送信された全てのフォームデータやクエリパラメータなどを配列形式で返します。
$allInputs = $request->all();
b. 現在のURLを取得する
現在のリクエストのURLを取得する場合は、url()メソッドを使用します。このメソッドは、スキームやクエリストリングを含まないURLを文字列として返します。
$currentUrl = $request->url();
c. リクエストボディの内容をそのまま取得する
リクエストボディの生データを取得するには、getContent()メソッドを使用します。これは、特にJSONやXMLなどの非フォームデータを扱う場合に便利です。
$bodyContent = $request->getContent();
3. JSONリクエストの扱い
a. JSONデータの取得
リクエストボディがJSON形式の場合、json()メソッドを使ってパースされたデータを取得できます。このメソッドは、ParameterBagクラスのインスタンスを返します。
$parameterBag = $request->json();
b. JSONデータから全てのパラメータを取得する
ParameterBagクラスのインスタンスである$parameterBagから、すべてのパラメータを取得するには、all()メソッドを使用します。
$allJsonParams = $parameterBag->all();
c. JSONデータから特定のパラメータを取得する
特定のキーに対応する値だけを取得したい場合は、get()メソッドを使用します。例えば、idというキーに対応する値を取得するには、以下のようにします。
$id = $parameterBag->get('id');
まとめ
以上が、Laravel 5におけるリクエストの扱い方の基本的な操作です。これらのメソッドを覚えておくことで、リクエストデータを効率よく処理できるようになります。特にJSONデータの取り扱いは、API開発において非常に重要ですので、しっかりと理解しておきましょう。