イントロダクション
Laravelは、アプリケーションに対するURL生成の手助けする、数多くのヘルパを提供しています。これは主に、テンプレートやAPIレスポンスでリンクを構築したり、アプリケーションの他の部分へのリダイレクトレスポンスを生成したりするのに役立ちます。
基礎
URL生成の基礎
urlヘルパは、アプリケーションに対する任意のURLを生成するために使用されます。生成されるURLには自動的に、現在のリクエストのスキーム（HTTP／HTTPS）とホストが使用されます。
$post = App\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 () {
//
})->name('post.show');このルートへのURLを生成するには、次のようにrouteヘルパを使用します。
echo route('post.show', ['post' => 1]);
// http://example.com/post/1Eloquentモデルの主キーを使用するURLを生成することもよくあると思います。そのため、Eloquentモデルをパラメータ値として渡すことができます。routeヘルパは、そのモデルの主キーを自動的に取り出します。
echo route('post.show', ['post' => $post]);routeヘルパは、複数のパラメータを伴うルートのURLを生成するためにも使用できます。
Route::get('/post/{post}/comment/{comment}', function () {
//
})->name('comment.show');
echo route('comment.show', ['post' => 1, 'comment' => 3]);
// http://example.com/post/1/comment/3署名付きURL
Laravelでは名前付きルートに対し、簡単に「署名付きURL」を作成できます。このURLは「署名」ハッシュをクエリ文字列として付加し、作成されてからそのURLが変更されていないかをLaravelで確認できるようにします。署名付きURLは公にアクセスさせるルートではあるが、URL操作に対する保護レイヤが必要な場合に特に便利です。
たとえば、公の「購読終了」リンクを顧客へのメールに用意するために、署名付きURLが使用できます。名前付きルートに対し署名URLを作成するには、URLファサードのsignedRouteメソッドを使用します。
use Illuminate\Support\Facades\URL;
return URL::signedRoute('unsubscribe', ['user' => 1]);一定期間で無効になる署名URLを生成したい場合は、temporarySignedRouteメソッドを使用します。
use Illuminate\Support\Facades\URL;
return URL::temporarySignedRoute(
'unsubscribe', now()->addMinutes(30), ['user' => 1]
);署名付きルートリクエストの検査
送信されてきたリクエストが有効な著名を持っているかを検査するには、送信されたRequestに対して、hasValidSignatureメソッドを呼び出します。
use Illuminate\Http\Request;
Route::get('/unsubscribe/{user}', function (Request $request) {
if (! $request->hasValidSignature()) {
abort(401);
}
// ...
})->name('unsubscribe');もしくは、Illuminate\Routing\Middleware\ValidateSignatureミドルウェアをそのルートへ指定します。用意していない場合、このミドルウェアをHTTPカーネルのrouteMiddleware配列で指定してください。
/**
* アプリケーションルートのミドルウェア
*
* これらのミドルウェアはグループ、もしくは個別に指定される。
*
* @var array
*/
protected $routeMiddleware = [
'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
];このミドルウェアをカーネルへ登録できたら、ルートで指定できます。送信されたリクエストは有効な著名を持っていない場合、このミドルウェアは自動的に403エラーレスポンスを返します。
Route::post('/unsubscribe/{user}', function (Request $request) {
// ...
})->name('unsubscribe')->middleware('signed');コントローラアクションのURL
action関数は、指定するコントローラアクションに対するURLを生成します。コントローラの完全な名前空間を渡す必要はありません。代わりに、App\Http\Controllers名前空間からの相対的なコントローラクラス名を指定してください。
$url = action('HomeController@index');「呼び出し可能な」配列の記法により、アクションを参照することもできます。
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);コントローラメソッドが、ルートパラメータを受け取る場合、この関数の第２引数として渡すことができます。
$url = action('UserController@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\Support\Facades\URL;
class SetDefaultLocaleForUrls
{
public function handle($request, Closure $next)
{
URL::defaults(['locale' => $request->user()->locale]);
return $next($request);
}
}一度localeパラメータに対するデフォルト値をセットしたら、routeヘルパを使いURLを生成する時に、値を渡す必要はもうありません。