URL生成

イントロダクション
基本
- URLの生成
- 現在のURLへのアクセス
名前付きルートのURL
- 署名付きURL
コントローラアクションのURL
デフォルト値

イントロダクション

Laravelは、アプリケーションのURLを生成するのに役立つヘルパをいくつか提供しています。これらのヘルパは主に、テンプレートやAPIレスポンスでリンクを構築するときや、アプリケーションの別の部分へのリダイレクトレスポンスを生成するときに役立ちます。

基本

URLの生成

urlヘルパは、アプリケーションの任意のURLを生成するために使用します。生成されるURLは、アプリケーションによって処理されている現在のリクエストから、スキーム（HTTPまたはHTTPS）とホストを自動的に使用します。

1$post = App\Models\Post::find(1);
2 
3echo url("/posts/{$post->id}");
4 
5// http://example.com/posts/1

$post = App\Models\Post::find(1);

echo url("/posts/{$post->id}");

// http://example.com/posts/1

クエリ文字列パラメータ付きのURLを生成するには、queryメソッドを使用します。

1echo url()->query('/posts', ['search' => 'Laravel']);
2 
3// https://example.com/posts?search=Laravel
4 
5echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);
6 
7// http://example.com/posts?sort=latest&search=Laravel

echo url()->query('/posts', ['search' => 'Laravel']);

// https://example.com/posts?search=Laravel

echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);

// http://example.com/posts?sort=latest&search=Laravel

パス内にすでに存在するクエリ文字列パラメータを指定すると、既存の値が上書きされます。

1echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);
2 
3// http://example.com/posts?sort=oldest

echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);

// http://example.com/posts?sort=oldest

値の配列をクエリパラメータとして渡すこともできます。これらの値は、生成されたURLで適切にキー付けされ、エンコードされます。

1echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);
2 
3// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body
4 
5echo urldecode($url);
6 
7// http://example.com/posts?columns[0]=title&columns[1]=body

echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);

// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body

echo urldecode($url);

// http://example.com/posts?columns[0]=title&columns[1]=body

現在のURLへのアクセス

urlヘルパにパスが指定されない場合は、Illuminate\Routing\UrlGeneratorインスタンスが返され、現在のURLに関する情報にアクセスできるようになります。

 1// Get the current URL without the query string...
 2echo url()->current();
 3 
 4// Get the current URL including the query string...
 5echo url()->full();
 6 
 7// Get the full URL for the previous request...
 8echo url()->previous();
 9 
10// Get the path for the previous request...
11echo url()->previousPath();

// Get the current URL without the query string...
echo url()->current();

// Get the current URL including the query string...
echo url()->full();

// Get the full URL for the previous request...
echo url()->previous();

// Get the path for the previous request...
echo url()->previousPath();

これらの各メソッドは、URL ファサードを介してアクセスすることもできます。

1use Illuminate\Support\Facades\URL;
2 
3echo URL::current();

use Illuminate\Support\Facades\URL;

echo URL::current();

名前付きルートのURL

routeヘルパは、名前付きルートへのURLを生成するために使用します。名前付きルートを使用すると、ルートで定義されている実際のURLに結合することなく、URLを生成できます。したがって、ルートのURLが変更されても、route関数の呼び出しを変更する必要はありません。たとえば、アプリケーションに次のように定義されたルートが含まれているとします。

1Route::get('/post/{post}', function (Post $post) {
2    // ...
3})->name('post.show');

Route::get('/post/{post}', function (Post $post) {
    // ...
})->name('post.show');

このルートへのURLを生成するには、routeヘルパを次のように使用します。

1echo route('post.show', ['post' => 1]);
2 
3// http://example.com/post/1

echo route('post.show', ['post' => 1]);

// http://example.com/post/1

もちろん、routeヘルパは、複数のパラメータを持つルートのURLを生成するためにも使用できます。

1Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
2    // ...
3})->name('comment.show');
4 
5echo route('comment.show', ['post' => 1, 'comment' => 3]);
6 
7// http://example.com/post/1/comment/3

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のクエリ文字列に追加されます。

1echo route('post.show', ['post' => 1, 'search' => 'rocket']);
2 
3// http://example.com/post/1?search=rocket

echo route('post.show', ['post' => 1, 'search' => 'rocket']);

// http://example.com/post/1?search=rocket

Eloquentモデル

多くの場合、Eloquentモデルのルートキー（通常は主キー）を使用してURLを生成します。このため、Eloquentモデルをパラメータ値として渡せます。routeヘルパは、モデルのルートキーを自動的に抽出します。

1echo route('post.show', ['post' => $post]);

echo route('post.show', ['post' => $post]);

署名付きURL

Laravelでは、名前付きルートへの「署名付き」URLを簡単に作成できます。これらのURLには、クエリ文字列に「署名」ハッシュが追加されており、これによりLaravelはURLが作成されてから変更されていないことを確認できます。署名付きURLは、一般に公開されているが、URL操作に対する保護層が必要なルートに特に役立ちます。

たとえば、署名付きURLを使用して、顧客に電子メールで送信する公開の「購読解除」リンクを実装できます。名前付きルートへの署名付きURLを作成するには、URLファサードのsignedRouteメソッドを使用します。

1use Illuminate\Support\Facades\URL;
2 
3return URL::signedRoute('unsubscribe', ['user' => 1]);

use Illuminate\Support\Facades\URL;

return URL::signedRoute('unsubscribe', ['user' => 1]);

signedRouteメソッドにabsolute引数を指定することで、署名付きURLのハッシュからドメインを除外できます。

1return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

指定した時間が経過すると期限切れになる一時的な署名付きルートURLを生成したい場合は、temporarySignedRouteメソッドを使用できます。Laravelが一時的な署名付きルートURLを検証するとき、署名付きURLにエンコードされている有効期限のタイムスタンプが経過していないことを確認します。

1use Illuminate\Support\Facades\URL;
2 
3return URL::temporarySignedRoute(
4    'unsubscribe', now()->addMinutes(30), ['user' => 1]
5);

use Illuminate\Support\Facades\URL;

return URL::temporarySignedRoute(
    'unsubscribe', now()->addMinutes(30), ['user' => 1]
);

署名付きルートリクエストの検証

受信リクエストに有効な署名があることを確認するには、受信したIlluminate\Http\RequestインスタンスでhasValidSignatureメソッドを呼び出す必要があります。

1use Illuminate\Http\Request;
2 
3Route::get('/unsubscribe/{user}', function (Request $request) {
4    if (! $request->hasValidSignature()) {
5        abort(401);
6    }
7 
8    // ...
9})->name('unsubscribe');

use Illuminate\Http\Request;

Route::get('/unsubscribe/{user}', function (Request $request) {
    if (! $request->hasValidSignature()) {
        abort(401);
    }

    // ...
})->name('unsubscribe');

クライアントサイドのページネーションを実行するときなど、アプリケーションのフロントエンドが署名付きURLにデータを追加できるようにする必要がある場合があります。したがって、hasValidSignatureWhileIgnoringメソッドを使用して、署名付きURLを検証する際に無視すべきリクエストクエリパラメータを指定できます。パラメータを無視すると、誰でもリクエスト上のそれらのパラメータを変更できるようになることに注意してください。

1if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
2    abort(401);
3}

if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
    abort(401);
}

受信リクエストインスタンスを使用して署名付きURLを検証する代わりに、signed（Illuminate\Routing\Middleware\ValidateSignature）ミドルウェアをルートに割り当てることができます。受信リクエストに有効な署名がない場合、ミドルウェアは自動的に403 HTTPレスポンスを返します。

1Route::post('/unsubscribe/{user}', function (Request $request) {
2    // ...
3})->name('unsubscribe')->middleware('signed');

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed');

署名付きURLのURLハッシュにドメインが含まれていない場合は、ミドルウェアにrelative引数を指定する必要があります。

1Route::post('/unsubscribe/{user}', function (Request $request) {
2    // ...
3})->name('unsubscribe')->middleware('signed:relative');

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed:relative');

無効な署名付きルートへの応答

誰かが期限切れの署名付きURLにアクセスすると、403 HTTPステータスコードの一般的なエラーページが表示されます。ただし、アプリケーションのbootstrap/app.phpファイルでInvalidSignatureException例外のカスタム「render」クロージャを定義することで、この動作をカスタマイズできます。

1use Illuminate\Routing\Exceptions\InvalidSignatureException;
2 
3->withExceptions(function (Exceptions $exceptions) {
4    $exceptions->render(function (InvalidSignatureException $e) {
5        return response()->view('errors.link-expired', status: 403);
6    });
7})

use Illuminate\Routing\Exceptions\InvalidSignatureException;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->render(function (InvalidSignatureException $e) {
        return response()->view('errors.link-expired', status: 403);
    });
})

コントローラアクションのURL

action関数は、指定されたコントローラアクションのURLを生成します。

1use App\Http\Controllers\HomeController;
2 
3$url = action([HomeController::class, 'index']);

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

コントローラメソッドがルートパラメータを受け入れる場合は、ルートパラメータの連想配列を関数の2番目の引数として渡すことができます。

1$url = action([UserController::class, 'profile'], ['id' => 1]);

$url = action([UserController::class, 'profile'], ['id' => 1]);

デフォルト値

一部のアプリケーションでは、特定のURLパラメータに対してリクエスト全体のデフォルト値を指定したい場合があります。たとえば、多くのルートで{locale}パラメータが定義されているとします。

1Route::get('/{locale}/posts', function () {
2    // ...
3})->name('post.index');

Route::get('/{locale}/posts', function () {
    // ...
})->name('post.index');

routeヘルパを呼び出すたびに常にlocaleを渡すのは面倒です。そこで、URL::defaultsメソッドを使用して、現在のリクエスト中に常に適用されるこのパラメータのデフォルト値を定義できます。現在のリクエストにアクセスできるように、このメソッドをルートミドルウェアから呼び出すとよいでしょう。

 1<?php
 2 
 3namespace App\Http\Middleware;
 4 
 5use Closure;
 6use Illuminate\Http\Request;
 7use Illuminate\Support\Facades\URL;
 8use Symfony\Component\HttpFoundation\Response;
 9 
10class SetDefaultLocaleForUrls
11{
12    /**
13     * Handle an incoming request.
14     *
15     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
16     */
17    public function handle(Request $request, Closure $next): Response
18    {
19        URL::defaults(['locale' => $request->user()->locale]);
20 
21        return $next($request);
22    }
23}

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;

class SetDefaultLocaleForUrls
{
    /**
     * Handle an incoming request.
     *
     * @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ミドルウェアの前に実行されるように優先順位を付ける必要があります。これは、アプリケーションのbootstrap/app.phpファイルでpriorityミドルウェアメソッドを使用して実現できます。

1->withMiddleware(function (Middleware $middleware) {
2    $middleware->prependToPriorityList(
3        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
4        prepend: \App\Http\Middleware\SetDefaultLocaleForUrls::class,
5    );
6})

->withMiddleware(function (Middleware $middleware) {
    $middleware->prependToPriorityList(
        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        prepend: \App\Http\Middleware\SetDefaultLocaleForUrls::class,
    );
})

序文

はじめに

アーキテクチャのコンセプト

基本

より深く知る

セキュリティ

データベース

Eloquent ORM

テスト

パッケージ