基本 - リクエスト（Requests） - 《Laravel 11.x ドキュメント》日本語

はじめに
リクエストとの対話
入力
入力のトリミングと正規化
- 入力の正規化を無効にする
ファイル
- アップロードされたファイルの取得
信頼できるプロキシの構成
- すべてのプロキシを信頼する
信頼できるホストの構成

はじめに

LaravelのIlluminate\Http\Requestクラスは、アプリケーションによって処理されている現在のHTTPリクエストと対話するためのオブジェクト指向の方法を提供し、リクエストと共に送信された入力、クッキー、およびファイルを取得します。

リクエストとの対話

リクエストへのアクセス

依存性注入を介して現在のHTTPリクエストのインスタンスを取得するには、ルートクロージャまたはコントローラメソッドでIlluminate\Http\Requestクラスをタイプヒントする必要があります。受信リクエストのインスタンスは、Laravelのサービスコンテナによって自動的に注入されます：

<?php
namespace App\Http\Controllers;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
class UserController extends Controller
{
   /**
     * Store a new user.
   */
   public function store(Request $request): RedirectResponse
   {
   $name = $request->input('name');
   // Store the user...
   return redirect('/users');
   }
}

前述のように、ルートクロージャでIlluminate\Http\Requestクラスをタイプヒントすることもできます。サービスコンテナは、クロージャが実行されるときに受信リクエストを自動的に注入します：

use Illuminate\Http\Request;
Route::get('/', function (Request $request) {
   // ...
});

依存性注入とルートパラメータ

コントローラメソッドがルートパラメータからの入力も期待している場合は、他の依存関係の後にルートパラメータをリストする必要があります。たとえば、ルートが次のように定義されている場合：

use App\Http\Controllers\UserController;
Route::put('/user/{id}', [UserController::class, 'update']);


``````php
<?php
namespace App\Http\Controllers;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
class UserController extends Controller
{
   /**
     * Update the specified user.
   */
   public function update(Request $request, string $id): RedirectResponse
   {
   // Update the user...
   return redirect('/users');
   }
}
`

リクエストパス、ホスト、およびメソッド

 <a name="retrieving-the-request-path"></a>
#### リクエストパスの取得
`````path`````メソッドは、リクエストのパス情報を返します。したがって、受信リクエストが`````http://example.com/foo/bar`````をターゲットにしている場合、`````path`````メソッドは`````foo/bar`````を返します：  
``````php
$uri = $request->path();
`

リクエストパス / ルートの検査


``````php
if ($request->is('admin/*')) {
   // ...
}
`

routeIsメソッドを使用して、受信リクエストがnamed routeと一致しているかどうかを判断できます：

if ($request->routeIs('admin.*')) {
   // ...
}

リクエストURLの取得

受信リクエストの完全なURLを取得するには、urlまたはfullUrlメソッドを使用できます。urlメソッドは、クエリ文字列なしでURLを返し、fullUrlメソッドはクエリ文字列を含みます：

$url = $request->url();
$urlWithQueryString = $request->fullUrl();

現在のURLにクエリ文字列データを追加したい場合は、fullUrlWithQueryメソッドを呼び出すことができます。このメソッドは、指定されたクエリ文字列変数の配列を現在のクエリ文字列とマージします：

$request->fullUrlWithQuery(['type' => 'phone']);

指定されたクエリ文字列パラメータなしで現在のURLを取得したい場合は、fullUrlWithoutQueryメソッドを利用できます：

$request->fullUrlWithoutQuery(['type']);

リクエストホストの取得

受信リクエストの「ホスト」をhost、httpHost、およびschemeAndHttpHostメソッドを介して取得できます：

$request->host();
$request->httpHost();
$request->schemeAndHttpHost();

リクエストメソッドの取得


``````php
$method = $request->method();
if ($request->isMethod('post')) {
   // ...
}
`

リクエストヘッダー


``````php
$value = $request->header('X-Header-Name');
$value = $request->header('X-Header-Name', 'default');
`


``````php
if ($request->hasHeader('X-Header-Name')) {
   // ...
}
`

便利なことに、bearerTokenメソッドを使用してAuthorizationヘッダーからベアラートークンを取得できます。そのようなヘッダーが存在しない場合、空の文字列が返されます：

$token = $request->bearerToken();

リクエストIPアドレス


``````php
$ipAddress = $request->ip();
`

プロキシによって転送されたすべてのクライアントIPアドレスを含むIPアドレスの配列を取得したい場合は、ipsメソッドを使用できます。「元の」クライアントIPアドレスは配列の最後にあります：

$ipAddresses = $request->ips();

一般的に、IPアドレスは信頼できないユーザー制御の入力と見なされ、情報目的のみに使用されるべきです。

コンテンツネゴシエーション

Laravelは、Acceptヘッダーを介して受信リクエストの要求されたコンテンツタイプを検査するためのいくつかのメソッドを提供します。まず、getAcceptableContentTypesメソッドは、リクエストによって受け入れられたすべてのコンテンツタイプを含む配列を返します：

$contentTypes = $request->getAcceptableContentTypes();


``````php
if ($request->accepts(['text/html', 'application/json'])) {
   // ...
}
`


``````php
$preferred = $request->prefers(['text/html', 'application/json']);
`

多くのアプリケーションがHTMLまたはJSONのみを提供するため、expectsJsonメソッドを使用して、受信リクエストがJSONレスポンスを期待しているかどうかを迅速に判断できます：

if ($request->expectsJson()) {
   // ...
}

PSR-7リクエスト

PSR-7標準は、リクエストやレスポンスを含むHTTPメッセージのインターフェースを指定します。Laravelリクエストの代わりにPSR-7リクエストのインスタンスを取得したい場合は、最初にいくつかのライブラリをインストールする必要があります。Laravelは、通常のLaravelリクエストとレスポンスをPSR-7互換の実装に変換するためにSymfony HTTP Message Bridgeコンポーネントを使用します：

composer require symfony/psr-http-message-bridge
composer require nyholm/psr7

これらのライブラリをインストールしたら、ルートクロージャまたはコントローラメソッドでリクエストインターフェースをタイプヒントすることでPSR-7リクエストを取得できます：

use Psr\Http\Message\ServerRequestInterface;
Route::get('/', function (ServerRequestInterface $request) {
   // ...
});

ルートまたはコントローラからPSR-7レスポンスインスタンスを返すと、自動的にLaravelレスポンスインスタンスに変換され、フレームワークによって表示されます。

入力

入力の取得

すべての入力データの取得

受信リクエストのすべての入力データをarrayとしてallメソッドを使用して取得できます。このメソッドは、受信リクエストがHTMLフォームからのものであるか、XHRリクエストであるかに関係なく使用できます：

$input = $request->all();


``````php
$input = $request->collect();
`


``````php
$request->collect('users')->each(function (string $user) {
   // ...
});
`

入力値の取得

いくつかの簡単なメソッドを使用して、リクエストに使用されたHTTP動詞を気にせずにIlluminate\Http\Requestインスタンスからすべてのユーザー入力にアクセスできます。HTTP動詞に関係なく、inputメソッドを使用してユーザー入力を取得できます：

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


``````php
$name = $request->input('name', 'Sally');
`

配列入力を含むフォームで作業する場合は、「ドット」表記を使用して配列にアクセスします：

$name = $request->input('products.0.name');
$names = $request->input('products.*.name');


``````php
$input = $request->input();
`

クエリ文字列からの入力の取得


``````php
$name = $request->query('name');
`

要求されたクエリ文字列値データが存在しない場合、このメソッドの第2引数が返されます：

$name = $request->query('name', 'Helen');


``````php
$query = $request->query();
`

JSON入力値の取得

アプリケーションにJSONリクエストを送信する際、リクエストのContent-Typeヘッダーがapplication/jsonに正しく設定されている限り、inputメソッドを介してJSONデータにアクセスできます。JSON配列/オブジェクト内にネストされた値を取得するために「ドット」構文を使用することもできます：

$name = $request->input('user.name');

文字列可能な入力値の取得

リクエストの入力データをプリミティブなstringとして取得する代わりに、stringメソッドを使用してリクエストデータをIlluminate\Support\Stringableのインスタンスとして取得できます：

$name = $request->string('name')->trim();

整数入力値の取得


``````php
$perPage = $request->integer('per_page');
`

ブール入力値の取得

チェックボックスのようなHTML要素を扱うとき、アプリケーションは実際には文字列である「真」とされる値を受け取ることがあります。たとえば、「true」や「on」。便利なことに、booleanメソッドを使用してこれらの値をブール値として取得できます。booleanメソッドは、1、「1」、true、「true」、「on」、および「yes」に対してtrueを返します。他のすべての値はfalseを返します：

$archived = $request->boolean('archived');

日付入力値の取得

便利なことに、日付/時刻を含む入力値は、dateメソッドを使用してCarbonインスタンスとして取得できます。リクエストに指定された名前の入力値が存在しない場合、nullが返されます：

$birthday = $request->date('birthday');


``````php
$elapsed = $request->date('elapsed', '!H:i', 'Europe/Madrid');
`

入力値が存在するが無効な形式の場合、InvalidArgumentExceptionがスローされるため、dateメソッドを呼び出す前に入力を検証することをお勧めします。

列挙型入力値の取得

PHP列挙型に対応する入力値もリクエストから取得できます。リクエストに指定された名前の入力値が存在しない場合、または列挙型に入力値と一致するバックアップ値がない場合、nullが返されます。enumメソッドは、入力値の名前と列挙型クラスを最初と第二の引数として受け入れます：

use App\Enums\Status;
$status = $request->enum('status', Status::class);

動的プロパティを介した入力の取得


``````php
$name = $request->name;
`

動的プロパティを使用する場合、Laravelは最初にリクエストペイロード内のパラメータの値を探します。存在しない場合、Laravelは一致したルートのパラメータ内でフィールドを検索します。

入力データの一部を取得

入力データのサブセットを取得する必要がある場合、onlyおよびexceptメソッドを使用できます。これらのメソッドは、単一のarrayまたは動的な引数のリストを受け入れます：

$input = $request->only(['username', 'password']);
$input = $request->only('username', 'password');
$input = $request->except(['credit_card']);
$input = $request->except('credit_card');


 <a name="input-presence"></a>
### 入力の存在
`````has`````メソッドを使用して、リクエストに値が存在するかどうかを判断できます。`````has`````メソッドは、リクエストに値が存在する場合`````true`````を返します：  
``````php
if ($request->has('name')) {
   // ...
}
`

配列が与えられた場合、hasメソッドは指定されたすべての値が存在するかどうかを判断します：

if ($request->has(['name', 'email'])) {
   // ...
}


``````php
if ($request->hasAny(['name', 'email'])) {
   // ...
}
`


``````php
$request->whenHas('name', function (string $input) {
   // ...
});
`

指定された値がリクエストに存在しない場合に実行される第2のクロージャをwhenHasメソッドに渡すことができます：

$request->whenHas('name', function (string $input) {
   // The "name" value is present...
}, function () {
   // The "name" value is not present...
});

リクエストに値が存在し、空の文字列でないかどうかを判断したい場合は、filledメソッドを使用できます：

if ($request->filled('name')) {
   // ...
}

リクエストから値が欠落しているか、空の文字列であるかどうかを判断したい場合は、isNotFilledメソッドを使用できます：

if ($request->isNotFilled('name')) {
   // ...
}

配列が与えられた場合、isNotFilledメソッドは指定されたすべての値が欠落しているか空であるかどうかを判断します：

if ($request->isNotFilled(['name', 'email'])) {
   // ...
}


``````php
if ($request->anyFilled(['name', 'email'])) {
   // ...
}
`


``````php
$request->whenFilled('name', function (string $input) {
   // ...
});
`

指定された値が「埋められていない」場合に実行される第2のクロージャをwhenFilledメソッドに渡すことができます：

$request->whenFilled('name', function (string $input) {
   // The "name" value is filled...
}, function () {
   // The "name" value is not filled...
});

指定されたキーがリクエストから欠落しているかどうかを判断するには、missingおよびwhenMissingメソッドを使用できます：

if ($request->missing('name')) {
   // ...
}
$request->whenMissing('name', function () {
   // The "name" value is missing...
}, function () {
   // The "name" value is present...
});

追加入力のマージ

時には、リクエストの既存の入力データに追加の入力を手動でマージする必要があります。これを実現するには、mergeメソッドを使用できます。指定された入力キーがリクエストにすでに存在する場合、mergeメソッドに提供されたデータで上書きされます：

$request->merge(['votes' => 0]);


``````php
$request->mergeIfMissing(['votes' => 0]);
`

古い入力

Laravelは、次のリクエスト中に1つのリクエストからの入力を保持することを許可します。この機能は、検証エラーを検出した後にフォームを再ポピュレートするのに特に便利です。ただし、Laravelの含まれている検証機能を使用している場合、Laravelの組み込み検証機能のいくつかが自動的にこれらのセッション入力フラッシングメソッドを呼び出すため、これらを手動で直接使用する必要がない場合があります。

セッションへの入力のフラッシング


``````php
$request->flash();
`


``````php
$request->flashOnly(['username', 'email']);
$request->flashExcept('password');
`

入力をフラッシュしてリダイレクト

入力をセッションにフラッシュし、その後前のページにリダイレクトしたい場合、withInputメソッドを使用してリダイレクトに入力フラッシングを簡単にチェーンできます：

return redirect('/form')->withInput();
return redirect()->route('user.create')->withInput();
return redirect('/form')->withInput(
   $request->except('password')
);

古い入力の取得

前のリクエストからフラッシュされた入力を取得するには、oldメソッドをIlluminate\Http\Requestのインスタンスで呼び出します。oldメソッドは、セッションから以前にフラッシュされた入力データを取得します：

$username = $request->old('username');

Laravelは、グローバルなoldヘルパーも提供します。古い入力をBladeテンプレート内で表示する場合、oldヘルパーを使用してフォームを再ポピュレートする方が便利です。指定されたフィールドに古い入力が存在しない場合、nullが返されます：

<input type="text" name="username" value="{{ old('username') }}">

クッキー

リクエストからのクッキーの取得

Laravelフレームワークによって作成されたすべてのクッキーは暗号化され、認証コードで署名されているため、クライアントによって変更された場合は無効と見なされます。リクエストからクッキー値を取得するには、cookieメソッドをIlluminate\Http\Requestインスタンスで使用します：

$value = $request->cookie('name');

入力のトリミングと正規化

デフォルトで、LaravelはIlluminate\Foundation\Http\Middleware\TrimStringsおよびIlluminate\Foundation\Http\Middleware\ConvertEmptyStringsToNullミドルウェアをアプリケーションのグローバルミドルウェアスタックに含めています。これらのミドルウェアは、リクエストのすべての受信文字列フィールドを自動的にトリミングし、空の文字列フィールドをnullに変換します。これにより、ルートやコントローラでこれらの正規化の懸念を心配する必要がなくなります。

入力の正規化を無効にする

すべてのリクエストに対してこの動作を無効にしたい場合は、アプリケーションのbootstrap/app.phpファイルで$middleware->removeメソッドを呼び出すことで、2つのミドルウェアをアプリケーションのミドルウェアスタックから削除できます：

use Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull;
use Illuminate\Foundation\Http\Middleware\TrimStrings;
->withMiddleware(function (Middleware $middleware) {
   $middleware->remove([
   ConvertEmptyStringsToNull::class,
   TrimStrings::class,
   ]);
})

アプリケーションへのリクエストのサブセットに対して文字列のトリミングと空の文字列の変換を無効にしたい場合は、アプリケーションのbootstrap/app.phpファイル内でtrimStringsおよびconvertEmptyStringsToNullミドルウェアメソッドを使用できます。両方のメソッドは、入力の正規化をスキップするかどうかを示すtrueまたはfalseを返すクロージャの配列を受け入れます：

->withMiddleware(function (Middleware $middleware) {
   $middleware->convertEmptyStringsToNull(except: [
   fn (Request $request) => $request->is('admin/*'),
   ]);
   $middleware->trimStrings(except: [
   fn (Request $request) => $request->is('admin/*'),
   ]);
})

ファイル

アップロードされたファイルの取得


``````php
$file = $request->file('photo');
$file = $request->photo;
`

リクエストにファイルが存在するかどうかをhasFileメソッドを使用して判断できます：

if ($request->hasFile('photo')) {
   // ...
}

成功したアップロードの検証

ファイルが存在するかどうかを確認するだけでなく、isValidメソッドを介してファイルのアップロードに問題がなかったかどうかを確認できます：

if ($request->file('photo')->isValid()) {
   // ...
}

ファイルパスと拡張子


``````php
$path = $request->photo->path();
$extension = $request->photo->extension();
`

その他のファイルメソッド

 <a name="storing-uploaded-files"></a>
### アップロードされたファイルの保存
アップロードされたファイルを保存するには、通常、構成された[ファイルシステム](/read/laravel-11-x/4a09c198479c00a5.md)の1つを使用します。`````UploadedFile`````クラスには、アップロードされたファイルをローカルファイルシステム上の場所やAmazon S3のようなクラウドストレージ場所の1つに移動する`````store`````メソッドがあります。  
`````store`````メソッドは、ファイルを保存するパスをファイルシステムの構成されたルートディレクトリに対して相対的に受け入れます。このパスにはファイル名を含めるべきではありません。ファイル名として使用される一意のIDが自動的に生成されます。  
`````store`````メソッドは、ファイルを保存するために使用されるディスクの名前のオプションの第2引数も受け入れます。このメソッドは、ディスクのルートに対して相対的なファイルのパスを返します：  
``````php
$path = $request->photo->store('images');
$path = $request->photo->store('images', 's3');
`

ファイル名を自動的に生成したくない場合は、storeAsメソッドを使用できます。このメソッドは、パス、ファイル名、およびディスク名を引数として受け入れます：

$path = $request->photo->storeAs('images', 'filename.jpg');
$path = $request->photo->storeAs('images', 'filename.jpg', 's3');

Laravelでのファイルストレージに関する詳細は、完全なファイルストレージドキュメントを参照してください。

信頼できるプロキシの構成

TLS / SSL証明書を終了させるロードバランサーの背後でアプリケーションを実行している場合、urlヘルパーを使用してHTTPSリンクが生成されないことがあります。通常、これはアプリケーションがポート80でロードバランサーからトラフィックを転送されており、安全なリンクを生成する必要があることを知らないためです。

この問題を解決するには、Laravelアプリケーションに含まれているIlluminate\Http\Middleware\TrustProxiesミドルウェアを有効にして、アプリケーションが信頼すべきロードバランサーやプロキシを迅速にカスタマイズできるようにします。信頼できるプロキシは、アプリケーションのbootstrap/app.phpファイル内のtrustProxiesミドルウェアメソッドを使用して指定する必要があります：

->withMiddleware(function (Middleware $middleware) {
   $middleware->trustProxies(at: [
   '192.168.1.1',
   '10.0.0.0/8',
   ]);
})

信頼できるプロキシを構成することに加えて、信頼すべきプロキシヘッダーも構成できます：

->withMiddleware(function (Middleware $middleware) {
   $middleware->trustProxies(headers: Request::HEADER_X_FORWARDED_FOR |
   Request::HEADER_X_FORWARDED_HOST |
   Request::HEADER_X_FORWARDED_PORT |
   Request::HEADER_X_FORWARDED_PROTO |
   Request::HEADER_X_FORWARDED_AWS_ELB
   );
})

AWS Elastic Load Balancingを使用している場合、headers値はRequest::HEADER_X_FORWARDED_AWS_ELBである必要があります。ロードバランサーがRFC 7239からの標準Forwardedヘッダーを使用している場合、headers値はRequest::HEADER_FORWARDEDである必要があります。headers値で使用できる定数に関する詳細は、Symfonyのプロキシを信頼するドキュメントを参照してください。

すべてのプロキシを信頼する

Amazon AWSや他の「クラウド」ロードバランサープロバイダーを使用している場合、実際のバランサーのIPアドレスを知らないかもしれません。この場合、*を使用してすべてのプロキシを信頼できます：

->withMiddleware(function (Middleware $middleware) {
   $middleware->trustProxies(at: '*');
})

信頼できるホストの構成

デフォルトでは、LaravelはHTTPリクエストのHostヘッダーの内容に関係なく、受信したすべてのリクエストに応答します。さらに、Hostヘッダーの値は、Webリクエスト中にアプリケーションへの絶対URLを生成する際に使用されます。

通常、NginxやApacheなどのWebサーバーを構成して、指定されたホスト名に一致するリクエストのみをアプリケーションに送信する必要があります。ただし、Webサーバーを直接カスタマイズする能力がない場合や、Laravelに特定のホスト名にのみ応答するよう指示する必要がある場合は、アプリケーションのIlluminate\Http\Middleware\TrustHostsミドルウェアを有効にすることで実現できます。


``````php
->withMiddleware(function (Middleware $middleware) {
   $middleware->trustHosts(at: ['laravel.test']);
})
`

デフォルトでは、アプリケーションのURLのサブドメインからのリクエストも自動的に信頼されます。この動作を無効にしたい場合は、subdomains引数を使用できます：

->withMiddleware(function (Middleware $middleware) {
   $middleware->trustHosts(at: ['laravel.test'], subdomains: false);
})

アプリケーションの構成ファイルやデータベースにアクセスして信頼できるホストを判断する必要がある場合は、at引数にクロージャを提供できます：

->withMiddleware(function (Middleware $middleware) {
   $middleware->trustHosts(at: fn () => config('app.trusted_hosts'));
})