$request->input('key')は何をやっているの

Posted at 2024-10-25

Laravelでのapi実行が知りたく、api.phpから処理を追っているときに、controllerで$request->input('hogehoge')みたいなことを良くしていたためどういうメソッドかまとめる。

inputメソッド

$request->input('key')はどうやらリクエストに含まれる入力パラメータの値を取得しているようだ。
以下の場合、limitというパラメータを探してきて、その値を$limitに入れている。

$limit = $request->input('limit');

例えば以下のようなリクエストのURLがあった場合

http://XXXXXX.com/api/test-api/XXXXXX?limit=10

limit=10が設定されているため$limitには10が返される。

ちなみに、inputメソッドには第二引数としてデフォルト値を指定できる。

$limit = $request->input('limit', 0); // limitがない場合は0を返す

$request->input('offset')は、HTTPリクエストからパラメータの値を取得するためのメソッドだな