#はじめに
Laravelは、アプリケーションのURL生成を支援するいくつかのヘルパーを提供します。これらのヘルパーは主に、テンプレートやAPIレスポンス内でリンクを作成したり、アプリケーションの別の部分へのリダイレクトレスポンスを生成したりする際に役立ちます。
#基本
#URLの生成
urlヘルパーは、アプリケーションの任意のURLを生成するために使えます。生成されるURLは、現在処理中のリクエストのスキーム（HTTPまたはHTTPS）とホストを自動的に使用します：
$post = App\Models\Post::find(1);
echo url("/posts/{$post->id}");
// http://example.com/posts/1
#現在のURLへのアクセス
urlヘルパーにパスを渡さない場合、Illuminate\Routing\UrlGeneratorのインスタンスが返され、現在のURLに関する情報にアクセスできます：
// クエリ文字列なしの現在のURLを取得...
echo url()->current();
// クエリ文字列を含む現在のURLを取得...
echo url()->full();
// 前回のリクエストの完全なURLを取得...
echo url()->previous();
これらのメソッドは、URLのファサード経由でも利用できます：
use Illuminate\Support\Facades\URL;
echo URL::current();
#名前付きルートのURL
routeヘルパーは、名前付きルートへのURLを生成するために使えます。名前付きルートを使うと、ルートで定義された実際のURLに依存せずにURLを生成できます。したがって、ルートのURLが変更されても、route関数の呼び出しを変更する必要はありません。例えば、次のようなルートがあるとします：
Route::get('/post/{post}', function (Post $post) {
// ...
})->name('post.show');
このルートへのURLを生成するには、次のようにrouteヘルパーを使います：
echo route('post.show', ['post' => 1]);
// http://example.com/post/1
もちろん、routeヘルパーは複数のパラメータを持つルートのURL生成にも使えます：
Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
// ...
})->name('comment.show');
echo route('comment.show', ['post' => 1, 'comment' => 3]);
// http://example.com/post/1/comment/3
ルート定義のパラメータに対応しない追加の配列要素は、URLのクエリ文字列に追加されます：
echo route('post.show', ['post' => 1, 'search' => 'rocket']);
// http://example.com/post/1?search=rocket
#Eloquentモデル
多くの場合、Eloquentモデルのルートキー（通常は主キー）を使ってURLを生成します。そのため、パラメータ値としてEloquentモデルを渡せます。routeヘルパーはモデルのルートキーを自動的に抽出します：
echo route('post.show', ['post' => $post]);
#署名付きURL
Laravelは、名前付きルートへの「署名付き」URLを簡単に作成できます。これらのURLにはクエリ文字列に「署名」ハッシュが付加されており、URLが生成後に改ざんされていないことをLaravelが検証できます。署名付きURLは、公開されているがURLの改ざん防止が必要なルートに特に有効です。
例えば、顧客にメールで送る公開の「購読解除」リンクを署名付きURLで実装できます。名前付きルートへの署名付きURLを作成するには、URLファサードのsignedRouteメソッドを使います：
use Illuminate\Support\Facades\URL;
return URL::signedRoute('unsubscribe', ['user' => 1]);
signedRouteメソッドにabsolute引数を渡すと、署名URLのハッシュにドメインを含めないようにできます：
return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);
指定した時間で期限切れになる一時的な署名付きルートURLを生成したい場合は、temporarySignedRouteメソッドを使います。Laravelは署名URLに埋め込まれた有効期限タイムスタンプが過ぎていないか検証します：
use Illuminate\Support\Facades\URL;
return URL::temporarySignedRoute(
'unsubscribe', now()->addMinutes(30), ['user' => 1]
);
#署名付きルートリクエストの検証
受信リクエストの署名が有効か検証するには、Illuminate\Http\RequestインスタンスのhasValidSignatureメソッドを呼び出します：
use Illuminate\Http\Request;
Route::get('/unsubscribe/{user}', function (Request $request) {
if (! $request->hasValidSignature()) {
abort(401);
}
// ...
})->name('unsubscribe');
クライアント側のページネーションなどで、署名付きURLにフロントエンドからデータを追加したい場合があります。その場合、hasValidSignatureWhileIgnoringメソッドで検証時に無視するクエリパラメータを指定できます。ただし、無視するパラメータは誰でも変更可能になることに注意してください：
if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
abort(401);
}
署名付きURLの検証をリクエストインスタンスで行う代わりに、Illuminate\Routing\Middleware\ValidateSignatureのミドルウェアをルートに割り当てられます。まだ登録していなければ、HTTPカーネルの$middlewareAliases配列にエイリアスを追加してください：
/**
* アプリケーションのミドルウェアエイリアス。
*
* エイリアスはルートやグループにミドルウェアを簡単に割り当てるために使います。
*
* @var array<string, class-string|string>
*/
protected $middlewareAliases = [
'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
];
カーネルにミドルウェアを登録したら、ルートに割り当てられます。リクエストの署名が無効な場合、ミドルウェアは自動的に403 HTTPレスポンスを返します：
Route::post('/unsubscribe/{user}', function (Request $request) {
// ...
})->name('unsubscribe')->middleware('signed');
署名付きURLのハッシュにドメインを含めない場合は、ミドルウェアにrelative引数を渡してください：
Route::post('/unsubscribe/{user}', function (Request $request) {
// ...
})->name('unsubscribe')->middleware('signed:relative');
#無効な署名付きルートへの応答
署名付きURLの有効期限が切れた場合、403 HTTPステータスの一般的なエラーページが表示されます。ただし、例外ハンドラーでInvalidSignatureException例外に対するカスタムの「renderable」クロージャを定義して、この動作をカスタマイズできます。このクロージャはHTTPレスポンスを返す必要があります：
use Illuminate\Routing\Exceptions\InvalidSignatureException;
/**
* アプリケーションの例外処理コールバックを登録します。
*/
public function register(): void
{
$this->renderable(function (InvalidSignatureException $e) {
return response()->view('error.link-expired', [], 403);
});
}
#コントローラーアクションのURL
action関数は指定したコントローラーアクションのURLを生成します：
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
コントローラーメソッドがルートパラメータを受け取る場合、連想配列でパラメータを第2引数に渡せます：
$url = action([UserController::class, 'profile'], ['id' => 1]);
#デフォルト値
一部のアプリケーションでは、特定のURLパラメータに対してリクエスト全体のデフォルト値を指定したい場合があります。例えば、多くのルートが{locale}パラメータを定義しているとします：
Route::get('/{locale}/posts', function () {
// ...
})->name('post.index');
routeヘルパーを呼び出すたびにlocaleを渡すのは面倒です。そこで、URL::defaultsメソッドを使って、現在のリクエスト中に常に適用されるこのパラメータのデフォルト値を定義できます。このメソッドは、現在のリクエストにアクセスできるようにルートミドルウェアから呼び出すのが望ましいです：
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;
class SetDefaultLocaleForUrls
{
/**
* 受信リクエストを処理します。
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
*/
public function handle(Request $request, Closure $next): Response
{
URL::defaults(['locale' => $request->user()->locale]);
return $next($request);
}
}
localeパラメータのデフォルト値を設定すると、routeヘルパーでURLを生成する際に値を渡す必要がなくなります。
#URLデフォルト値とミドルウェアの優先度
URLのデフォルト値を設定すると、Laravelの暗黙的モデルバインディングの処理に影響を与える可能性があります。したがって、URLデフォルト値を設定するミドルウェアは、LaravelのSubstituteBindingsミドルウェアよりも先に実行されるようにミドルウェアの優先度を設定してください。これは、アプリケーションのHTTPカーネルの$middlewarePriorityプロパティで、SubstituteBindingsより前に自分のミドルウェアを配置することで実現できます。
$middlewarePriorityプロパティは、ベースのIlluminate\Foundation\Http\Kernelクラスで定義されています。この定義をコピーして、アプリケーションのHTTPカーネルで上書きすることで変更できます：
/**
* 優先度順に並べたミドルウェアのリスト。
*
* これにより、グローバルでないミドルウェアも常に指定した順序で実行されます。
*
* @var array
*/
protected $middlewarePriority = [
// ...
\App\Http\Middleware\SetDefaultLocaleForUrls::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
// ...
];