バージョン: 9.x

認可 (Authorization)

Introduction
Gates
ポリシーの作成
- ポリシーの生成
- ポリシーの登録
ポリシーの作成
ポリシーを使用したアクションの承認

導入 (Introduction)

Laravel は、組み込みの authentication サービスを提供するだけでなく、特定のリソースに対するユーザーのアクションを承認する簡単な方法も提供します。たとえば、ユーザーが認証されていても、アプリケーションによって管理されている特定の Eloquent モデルやデータベースレコードを更新または削除する権限が与えられていない場合があります。 Laravel の認可機能は、この種の認可チェックを管理する簡単で体系的な方法を提供します。

Laravel は、アクションを承認する 2 つの主な方法、gates と policies を提供します。ゲートとポリシーをルートやコントローラのように考えてください。ゲートはシンプルなクロージャベースの認可アプローチを提供し、コントローラなどのポリシーは特定のモデルまたはリソースのロジックをグループ化します。このドキュメントでは、最初にゲートを調べてから、ポリシーを調べます。

アプリケーションを構築するときに、ゲートのみを使用するかポリシーのみを使用するかを選択する必要はありません。ほとんどのアプリケーションにはゲートとポリシーが混在している可能性が高く、それはまったく問題ありません。ゲートは、管理者ダッシュボードの表示など、モデルやリソースに関連しないアクションに最も適しています。対照的に、ポリシーは、特定のモデルまたはリソースに対するアクションを承認する場合に使用する必要があります。

ゲイツ (Gates)

ゲートの書き込み

警告 Gates は、Laravel の認証機能の基本を学ぶのに最適な方法です。ただし、堅牢な Laravel アプリケーションを構築する場合は、policies を使用して承認ルールを整理することを検討する必要があります。

ゲートは、ユーザーが特定のアクションを実行する権限を持っているかどうかを決定する単なるクロージャです。通常、ゲートは、Gate ファサードを使用して、App\Providers\AuthServiceProvider クラスの boot メソッド内で定義されます。ゲートは常に最初の引数としてユーザーインスタンスを受け取り、オプションで関連する Eloquent モデルなどの追加の引数を受け取ることもあります。

この例では、ユーザーが特定の App\Models\Post モデルを更新できるかどうかを判断するゲートを定義します。ゲートは、ユーザーの id を投稿を作成したユーザーの user_id と比較することでこれを実現します。

use App\Models\Post;
use App\Models\User;
use Illuminate\Support\Facades\Gate;

/**
 * Register any authentication / authorization services.
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', function (User $user, Post $post) {
        return $user->id === $post->user_id;
    });
}

コントローラと同様に、ゲートもクラスコールバック配列を使用して定義できます。

use App\Policies\PostPolicy;
use Illuminate\Support\Facades\Gate;

/**
 * Register any authentication / authorization services.
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', [PostPolicy::class, 'update']);
}

アクションの承認

ゲートを使用してアクションを承認するには、Gate ファサードによって提供される allows メソッドまたは denies メソッドを使用する必要があります。現在認証されているユーザーをこれらのメソッドに渡す必要はないことに注意してください。 Laravel は、ユーザーをゲートクロージャーに渡す処理を自動的に処理します。認可が必要なアクションを実行する前に、アプリケーションのコントローラ内でゲート認可メソッドを呼び出すのが一般的です。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Gate;

class PostController extends Controller
{
    /**
     * Update the given post.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Post $post)
    {
        if (! Gate::allows('update-post', $post)) {
            abort(403);
        }

        // Update the post...
    }
}

現在認証されているユーザー以外のユーザーにアクションの実行が許可されているかどうかを確認したい場合は、Gate ファサードで forUser メソッドを使用できます。

if (Gate::forUser($user)->allows('update-post', $post)) {
    // The user can update the post...
}

if (Gate::forUser($user)->denies('update-post', $post)) {
    // The user can't update the post...
}

any メソッドまたは none メソッドを使用して、一度に複数のアクションを承認できます。

if (Gate::any(['update-post', 'delete-post'], $post)) {
    // The user can update or delete the post...
}

if (Gate::none(['update-post', 'delete-post'], $post)) {
    // The user can't update or delete the post...
}

例外の許可またはスロー

アクションを承認しようとして、ユーザーが指定されたアクションの実行を許可されていない場合に Illuminate\Auth\Access\AuthorizationException を自動的にスローしたい場合は、Gate ファサードの authorize メソッドを使用できます。 AuthorizationException のインスタンスは、Laravel の例外ハンドラーによって 403 HTTP 応答に自動的に変換されます。

Gate::authorize('update-post', $post);

// The action is authorized...

追加のコンテキストの提供

アビリティを認証するためのゲートメソッド (allows、denies、check、any、none、authorize、can、cannot) と認証 Blade ディレクティブ (@can、@cannot、@canany) は、第 2 引数として配列を受け取ることができます。これらの配列要素はパラメータとしてゲートクロージャに渡され、認可の決定を行う際の追加のコンテキストとして使用できます。

use App\Models\Category;
use App\Models\User;
use Illuminate\Support\Facades\Gate;

Gate::define('create-post', function (User $user, Category $category, $pinned) {
    if (! $user->canPublishToGroup($category->group)) {
        return false;
    } elseif ($pinned && ! $user->canPinPosts()) {
        return false;
    }

    return true;
});

if (Gate::check('create-post', [$category, $pinned])) {
    // The user can create the post...
}

ゲート応答

これまでは、単純なブール値を返すゲートのみを調べてきました。ただし、エラーメッセージを含む、より詳細な応答を返したい場合もあります。そのためには、ゲートから Illuminate\Auth\Access\Response を返すことができます。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;

Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::deny('You must be an administrator.');
});

ゲートから認証応答を返した場合でも、Gate::allows メソッドは単純なブール値を返します。ただし、Gate::inspect メソッドを使用して、ゲートから返される完全な承認応答を取得することもできます。

$response = Gate::inspect('edit-settings');

if ($response->allowed()) {
    // The action is authorized...
} else {
    echo $response->message();
}

アクションが承認されていない場合に AuthorizationException をスローする Gate::authorize メソッドを使用すると、承認応答によって提供されるエラーメッセージが HTTP 応答に伝播されます。

Gate::authorize('edit-settings');

// The action is authorized...

HTTP 応答ステータスのカスタマイズ

アクションがゲート経由で拒否されると、403 HTTP 応答が返されます。ただし、代替の HTTP ステータスコードを返すと便利な場合もあります。 Illuminate\Auth\Access\Response クラスの denyWithStatus 静的コンストラクターを使用して、失敗した認証チェックに対して返される HTTP ステータスコードをカスタマイズできます。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;

Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::denyWithStatus(404);
});

404 応答によるリソースの非表示は Web アプリケーションでは一般的なパターンであるため、利便性を考慮して denyAsNotFound メソッドが提供されています。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;

Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::denyAsNotFound();
});

ゲートチェックの傍受

場合によっては、特定のユーザーにすべての権限を付与したい場合があります。 before メソッドを使用して、他のすべての承認チェックの前に実行されるクロージャーを定義できます。

use Illuminate\Support\Facades\Gate;

Gate::before(function ($user, $ability) {
    if ($user->isAdministrator()) {
        return true;
    }
});

before クロージャが null 以外の結果を返した場合、その結果は承認チェックの結果とみなされます。

after メソッドを使用して、他のすべての承認チェックの後に実行されるクロージャを定義できます。

Gate::after(function ($user, $ability, $result, $arguments) {
    if ($user->isAdministrator()) {
        return true;
    }
});

before メソッドと同様に、after クロージャが null 以外の結果を返した場合、その結果は承認チェックの結果とみなされます。

インライン認証

場合によっては、アクションに対応する専用ゲートを作成せずに、現在認証されているユーザーが特定のアクションを実行する権限を持っているかどうかを判断したい場合があります。 Laravel では、Gate::allowIf および Gate::denyIf メソッドを介して、次のタイプの「インライン」承認チェックを実行できます。

use Illuminate\Support\Facades\Gate;

Gate::allowIf(fn ($user) => $user->isAdministrator());

Gate::denyIf(fn ($user) => $user->banned());

アクションが承認されていない場合、または現在認証されているユーザーがいない場合、Laravel は自動的に Illuminate\Auth\Access\AuthorizationException 例外をスローします。 AuthorizationException のインスタンスは、Laravel の例外ハンドラーによって 403 HTTP 応答に自動的に変換されます。

ポリシーの作成 (Creating Policies)

ポリシーの生成

ポリシーは、特定のモデルまたはリソースに基づいて認可ロジックを編成するクラスです。たとえば、アプリケーションがブログの場合、投稿の作成や更新などのユーザーアクションを承認するために、App\Models\Post モデルと対応する App\Policies\PostPolicy が必要になる場合があります。

make:policy Artisan コマンドを使用してポリシーを生成できます。生成されたポリシーは、app/Policies ディレクトリに配置されます。このディレクトリがアプリケーションに存在しない場合は、Laravel が作成します。

php artisan make:policy PostPolicy

make:policy コマンドは空のポリシークラスを生成します。リソースの表示、作成、更新、削除に関連するポリシーメソッドの例を含むクラスを生成したい場合は、コマンドの実行時に --model オプションを指定できます。

php artisan make:policy PostPolicy --model=Post

ポリシーの登録

ポリシークラスを作成したら、登録する必要があります。ポリシーの登録は、特定のモデルタイプに対するアクションを承認するときにどのポリシーを使用するかを Laravel に通知する方法です。

新しい Laravel アプリケーションに含まれる App\Providers\AuthServiceProvider には、Eloquent モデルを対応するポリシーにマップする policies プロパティが含まれています。ポリシーを登録すると、特定の Eloquent モデルに対するアクションを承認するときにどのポリシーを利用するかを Laravel に指示します。

<?php

namespace App\Providers;

use App\Models\Post;
use App\Policies\PostPolicy;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Gate;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        Post::class => PostPolicy::class,
    ];

    /**
     * Register any application authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        //
    }
}

ポリシーの自動検出

モデルポリシーを手動で登録する代わりに、モデルとポリシーが標準の Laravel 命名規則に従っている限り、Laravel は自動的にポリシーを検出できます。具体的には、ポリシーは、モデルが含まれているディレクトリ以上の Policies ディレクトリに存在する必要があります。したがって、たとえば、モデルは app/Models ディレクトリに配置され、ポリシーは app/Policies ディレクトリに配置されることがあります。この状況では、Laravel は app/Models/Policies の次に app/Policies でポリシーをチェックします。さらに、ポリシー名はモデル名と一致し、Policy サフィックスが付いている必要があります。したがって、User モデルは、UserPolicy ポリシークラスに対応します。

独自のポリシー検出ロジックを定義したい場合は、Gate::guessPolicyNamesUsing メソッドを使用してカスタムポリシー検出コールバックを登録できます。通常、このメソッドは、アプリケーションの AuthServiceProvider の boot メソッドから呼び出す必要があります。

use Illuminate\Support\Facades\Gate;

Gate::guessPolicyNamesUsing(function ($modelClass) {
    // Return the name of the policy class for the given model...
});

警告 AuthServiceProvider で明示的にマップされているポリシーは、自動検出される可能性のあるポリシーよりも優先されます。

ポリシーの作成 (Writing Policies)

ポリシーの方法

ポリシークラスが登録されたら、それが許可するアクションごとにメソッドを追加できます。たとえば、特定の App\Models\User が特定の App\Models\Post インスタンスを更新できるかどうかを決定する update メソッドを PostPolicy に定義してみましょう。

update メソッドは、引数として User および Post インスタンスを受け取り、ユーザーが指定された Post を更新する権限があるかどうかを示す true または false を返す必要があります。したがって、この例では、ユーザーの id が投稿の user_id と一致することを確認します。

<?php

namespace App\Policies;

use App\Models\Post;
use App\Models\User;

class PostPolicy
{
    /**
     * Determine if the given post can be updated by the user.
     *
     * @param  \App\Models\User  $user
     * @param  \App\Models\Post  $post
     * @return bool
     */
    public function update(User $user, Post $post)
    {
        return $user->id === $post->user_id;
    }
}

必要に応じて、ポリシーで承認されるさまざまなアクションに追加のメソッドを定義し続けることができます。たとえば、view メソッドまたは delete メソッドを定義して、さまざまな Post 関連アクションを承認できますが、ポリシーメソッドには自由に任意の名前を付けることができることに注意してください。

Artisan コンソール経由でポリシーを生成するときに --model オプションを使用した場合、そのオプションには、viewAny、view、create、update、delete、restore、および forceDelete アクションのメソッドがすでに含まれています。

注記すべてのポリシーは Laravel サービスコンテナを介して解決されるため、ポリシーのコンストラクターで必要な依存関係をタイプヒントして自動的に挿入することができます。

政策対応

これまでは、単純なブール値を返すポリシーメソッドのみを調べてきました。ただし、エラーメッセージを含む、より詳細な応答を返したい場合もあります。これを行うには、ポリシーメソッドから Illuminate\Auth\Access\Response インスタンスを返すことができます。

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;

/**
 * Determine if the given post can be updated by the user.
 *
 * @param  \App\Models\User  $user
 * @param  \App\Models\Post  $post
 * @return \Illuminate\Auth\Access\Response
 */
public function update(User $user, Post $post)
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::deny('You do not own this post.');
}

ポリシーから認可応答を返す場合、Gate::allows メソッドは単純なブール値を返します。ただし、Gate::inspect メソッドを使用して、ゲートから返される完全な承認応答を取得することもできます。

use Illuminate\Support\Facades\Gate;

$response = Gate::inspect('update', $post);

if ($response->allowed()) {
    // The action is authorized...
} else {
    echo $response->message();
}

Gate::authorize('update', $post);

// The action is authorized...

HTTP 応答ステータスのカスタマイズ

アクションがポリシーメソッドによって拒否された場合、403 HTTP 応答が返されます。ただし、代替の HTTP ステータスコードを返すと便利な場合もあります。 Illuminate\Auth\Access\Response クラスの denyWithStatus 静的コンストラクターを使用して、失敗した認証チェックに対して返される HTTP ステータスコードをカスタマイズできます。

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;

/**
 * Determine if the given post can be updated by the user.
 *
 * @param  \App\Models\User  $user
 * @param  \App\Models\Post  $post
 * @return \Illuminate\Auth\Access\Response
 */
public function update(User $user, Post $post)
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::denyWithStatus(404);
}

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;

/**
 * Determine if the given post can be updated by the user.
 *
 * @param  \App\Models\User  $user
 * @param  \App\Models\Post  $post
 * @return \Illuminate\Auth\Access\Response
 */
public function update(User $user, Post $post)
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::denyAsNotFound();
}

モデルのないメソッド

一部のポリシーメソッドは、現在認証されているユーザーのインスタンスのみを受け取ります。この状況は、create アクションを承認するときに最も一般的です。たとえば、ブログを作成している場合、ユーザーに投稿を作成する権限が与えられているかどうかを確認したい場合があります。このような状況では、ポリシーメソッドはユーザーインスタンスの受信のみを期待する必要があります。

/**
 * Determine if the given user can create posts.
 *
 * @param  \App\Models\User  $user
 * @return bool
 */
public function create(User $user)
{
    return $user->role == 'writer';
}

ゲストユーザー

デフォルトでは、受信 HTTP リクエストが認証されたユーザーによって開始されたものでない場合、すべてのゲートとポリシーは自動的に false を返します。ただし、「オプション」のタイプヒントを宣言するか、ユーザー引数の定義に null のデフォルト値を指定することで、これらの認可チェックがゲートやポリシーを通過できるようにすることができます。

<?php

namespace App\Policies;

use App\Models\Post;
use App\Models\User;

class PostPolicy
{
    /**
     * Determine if the given post can be updated by the user.
     *
     * @param  \App\Models\User  $user
     * @param  \App\Models\Post  $post
     * @return bool
     */
    public function update(?User $user, Post $post)
    {
        return optional($user)->id === $post->user_id;
    }
}

ポリシーフィルター

特定のユーザーに対して、特定のポリシー内のすべてのアクションを承認したい場合があります。これを実現するには、ポリシーで before メソッドを定義します。 before メソッドは、ポリシーの他のメソッドよりも前に実行されるため、目的のポリシーメソッドが実際に呼び出される前にアクションを承認する機会が得られます。この機能は、アプリケーション管理者にアクションの実行を許可するために最も一般的に使用されます。

use App\Models\User;

/**
 * Perform pre-authorization checks.
 *
 * @param  \App\Models\User  $user
 * @param  string  $ability
 * @return void|bool
 */
public function before(User $user, $ability)
{
    if ($user->isAdministrator()) {
        return true;
    }
}

特定のタイプのユーザーに対するすべての認証チェックを拒否したい場合は、before メソッドから false を返すことができます。 null が返された場合、認可チェックはポリシーメソッドに渡されます。

警告チェック対象の機能の名前と一致する名前のメソッドがクラスに含まれていない場合、ポリシークラスの before メソッドは呼び出されません。

ポリシーを使用したアクションの承認 (Authorizing Actions Using Policies)

ユーザーモデル経由

Laravel アプリケーションに含まれる App\Models\User モデルには、アクションを承認するための 2 つの便利なメソッド、can と cannot が含まれています。 can メソッドと cannot メソッドは、承認するアクションの名前と関連モデルを受け取ります。たとえば、ユーザーが特定の App\Models\Post モデルを更新する権限を持っているかどうかを確認してみましょう。通常、これはコントローラメソッド内で行われます。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Update the given post.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Post $post)
    {
        if ($request->user()->cannot('update', $post)) {
            abort(403);
        }

        // Update the post...
    }
}

指定されたモデルのポリシーが登録されていますの場合、can メソッドは自動的に適切なポリシーを呼び出し、ブール値の結果を返します。モデルにポリシーが登録されていない場合、can メソッドは、指定されたアクション名に一致するクロージャーベースのゲートの呼び出しを試みます。

モデルを必要としないアクション

一部のアクションは、モデルインスタンスを必要としない create などのポリシーメソッドに対応する場合があることに注意してください。このような状況では、クラス名を can メソッドに渡すことができます。クラス名は、アクションを承認するときにどのポリシーを使用するかを決定するために使用されます。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Create a post.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        if ($request->user()->cannot('create', Post::class)) {
            abort(403);
        }

        // Create the post...
    }
}

コントローラヘルパ経由

App\Models\User モデルに提供される便利なメソッドに加えて、Laravel は、App\Http\Controllers\Controller 基本クラスを拡張する任意のコントローラに便利な authorize メソッドを提供します。

can メソッドと同様に、このメソッドは承認するアクションの名前と関連モデルを受け入れます。アクションが承認されていない場合、authorize メソッドは Illuminate\Auth\Access\AuthorizationException 例外をスローします。Laravel 例外ハンドラーは、この例外を 403 ステータスコードの HTTP 応答に自動的に変換します。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Update the given blog post.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Models\Post  $post
     * @return \Illuminate\Http\Response
     *
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    public function update(Request $request, Post $post)
    {
        $this->authorize('update', $post);

        // The current user can update the blog post...
    }
}

モデルを必要としないアクション

前に説明したように、create などの一部のポリシーメソッドはモデルインスタンスを必要としません。このような状況では、クラス名を authorize メソッドに渡す必要があります。クラス名は、アクションを承認するときにどのポリシーを使用するかを決定するために使用されます。

use App\Models\Post;
use Illuminate\Http\Request;

/**
 * Create a new blog post.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response
 *
 * @throws \Illuminate\Auth\Access\AuthorizationException
 */
public function create(Request $request)
{
    $this->authorize('create', Post::class);

    // The current user can create blog posts...
}

リソースコントローラの認可

リソースコントローラを利用している場合は、コントローラのコンストラクターで authorizeResource メソッドを利用できます。このメソッドは、適切な can ミドルウェア定義をリソースコントローラのメソッドにアタッチします。

authorizeResource メソッドは、モデルのクラス名を最初の引数として受け入れ、モデルの ID を含むルート/リクエストパラメーターの名前を 2 番目の引数として受け入れます。必要なメソッドシグネチャと型ヒントが含まれるように、リソースコントローラが --model フラグを使用して作成されていることを確認する必要があります。

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Create the controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->authorizeResource(Post::class, 'post');
    }
}

次のコントローラメソッドは、対応するポリシーメソッドにマップされます。リクエストが指定されたコントローラメソッドにルーティングされると、コントローラメソッドが実行される前に、対応するポリシーメソッドが自動的に呼び出されます。

コントローラメソッド	政策手法
索引	任意のビュー
見せる	ビュー
作成する	作成する
店	作成する
編集	アップデート
アップデート	アップデート
破壊する	消去

注記 make:policy コマンドを --model オプションとともに使用すると、特定のモデル php artisan make:policy PostPolicy --model=Post のポリシークラスを迅速に生成できます。

ミドルウェア経由

Laravel には、受信リクエストがルートやコントローラに到達する前にアクションを承認できるミドルウェアが含まれています。デフォルトでは、Illuminate\Auth\Middleware\Authorize ミドルウェアには、App\Http\Kernel クラスの can キーが割り当てられます。 can ミドルウェアを使用して、ユーザーが投稿を更新できることを承認する例を見てみましょう。

use App\Models\Post;

Route::put('/post/{post}', function (Post $post) {
    // The current user may update the post...
})->middleware('can:update,post');

この例では、can ミドルウェアに 2 つの引数を渡します。 1 つ目は承認するアクションの名前で、2 つ目はポリシーメソッドに渡すルートパラメーターです。この場合、暗黙的なモデルバインディングを使用しているため、App\Models\Post モデルがポリシーメソッドに渡されます。ユーザーが指定されたアクションを実行する権限を持たない場合、ミドルウェアから 403 ステータスコードを含む HTTP 応答が返されます。

便宜上、can メソッドを使用して、can ミドルウェアをルートにアタッチすることもできます。

use App\Models\Post;

Route::put('/post/{post}', function (Post $post) {
    // The current user may update the post...
})->can('update', 'post');

モデルを必要としないアクション

繰り返しますが、create などの一部のポリシーメソッドはモデルインスタンスを必要としません。このような状況では、クラス名をミドルウェアに渡すことができます。クラス名は、アクションを承認するときにどのポリシーを使用するかを決定するために使用されます。

Route::post('/post', function () {
    // The current user may create posts...
})->middleware('can:create,App\Models\Post');

文字列ミドルウェア定義内でクラス名全体を指定すると、面倒になる場合があります。このため、can メソッドを使用して、can ミドルウェアをルートにアタッチすることを選択できます。

use App\Models\Post;

Route::post('/post', function () {
    // The current user may create posts...
})->can('create', Post::class);

Blade テンプレート経由

Blade テンプレートを作成するとき、ユーザーが特定のアクションの実行を許可されている場合にのみページの一部を表示したい場合があります。たとえば、ユーザーが実際に投稿を更新できる場合にのみ、ブログ投稿の更新フォームを表示したい場合があります。この状況では、@can および @cannot ディレクティブを使用できます。

@can('update', $post)
    <!-- The current user can update the post... -->
@elsecan('create', App\Models\Post::class)
    <!-- The current user can create new posts... -->
@else
    <!-- ... -->
@endcan

@cannot('update', $post)
    <!-- The current user cannot update the post... -->
@elsecannot('create', App\Models\Post::class)
    <!-- The current user cannot create new posts... -->
@endcannot

これらのディレクティブは、@if および @unless ステートメントを作成するための便利なショートカットです。上記の @can ステートメントと @cannot ステートメントは、次のステートメントと同等です。

@if (Auth::user()->can('update', $post))
    <!-- The current user can update the post... -->
@endif

@unless (Auth::user()->can('update', $post))
    <!-- The current user cannot update the post... -->
@endunless

また、ユーザーが特定のアクションの配列から任意のアクションを実行することを許可されているかどうかを判断することもできます。これを実現するには、@canany ディレクティブを使用します。

@canany(['update', 'view', 'delete'], $post)
    <!-- The current user can update, view, or delete the post... -->
@elsecanany(['create'], \App\Models\Post::class)
    <!-- The current user can create a post... -->
@endcanany

モデルを必要としないアクション

他のほとんどの認証メソッドと同様に、アクションにモデルインスタンスが必要ない場合は、クラス名を @can および @cannot ディレクティブに渡すことができます。

@can('create', App\Models\Post::class)
    <!-- The current user can create posts... -->
@endcan

@cannot('create', App\Models\Post::class)
    <!-- The current user can't create posts... -->
@endcannot

追加のコンテキストの提供

ポリシーを使用してアクションを承認する場合、さまざまな承認関数およびヘルパに 2 番目の引数として配列を渡すことができます。配列の最初の要素はどのポリシーを呼び出すかを決定するために使用され、配列の残りの要素はパラメータとしてポリシーメソッドに渡され、承認の決定を行う際の追加のコンテキストに使用できます。たとえば、追加の $category パラメータを含む次の PostPolicy メソッド定義を考えてみましょう。

/**
 * Determine if the given post can be updated by the user.
 *
 * @param  \App\Models\User  $user
 * @param  \App\Models\Post  $post
 * @param  int  $category
 * @return bool
 */
public function update(User $user, Post $post, int $category)
{
    return $user->id === $post->user_id &&
           $user->canUpdateCategory($category);
}

認証されたユーザーが特定の投稿を更新できるかどうかを判断する場合、次のようにこのポリシーメソッドを呼び出すことができます。

/**
 * Update the given blog post.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \App\Models\Post  $post
 * @return \Illuminate\Http\Response
 *
 * @throws \Illuminate\Auth\Access\AuthorizationException
 */
public function update(Request $request, Post $post)
{
    $this->authorize('update', [$post, $request->category]);

    // The current user can update the blog post...
}

導入 (Introduction)​

ゲイツ (Gates)​

ゲートの書き込み​

アクションの承認​

例外の許可またはスロー​

追加のコンテキストの提供​

ゲート応答​

HTTP 応答ステータスのカスタマイズ​

ゲートチェックの傍受​

インライン認証​

ポリシーの作成 (Creating Policies)​

ポリシーの生成​

ポリシーの登録​

ポリシーの自動検出​

ポリシーの作成 (Writing Policies)​

ポリシーの方法​

政策対応​

HTTP 応答ステータスのカスタマイズ​

モデルのないメソッド​

ゲストユーザー​

ポリシーフィルター​

ポリシーを使用したアクションの承認 (Authorizing Actions Using Policies)​

ユーザーモデル経由​

モデルを必要としないアクション​

コントローラヘルパ経由​

モデルを必要としないアクション​

リソースコントローラの認可​

ミドルウェア経由​

モデルを必要としないアクション​

Blade テンプレート経由​

モデルを必要としないアクション​

追加のコンテキストの提供​

導入 (Introduction)

ゲイツ (Gates)

ゲートの書き込み

アクションの承認

例外の許可またはスロー

追加のコンテキストの提供

ゲート応答

HTTP 応答ステータスのカスタマイズ

ゲートチェックの傍受

インライン認証

ポリシーの作成 (Creating Policies)

ポリシーの生成

ポリシーの登録

ポリシーの自動検出

ポリシーの作成 (Writing Policies)

ポリシーの方法

政策対応

HTTP 応答ステータスのカスタマイズ

モデルのないメソッド

ゲストユーザー

ポリシーフィルター

ポリシーを使用したアクションの承認 (Authorizing Actions Using Policies)

ユーザーモデル経由

モデルを必要としないアクション

コントローラヘルパ経由

モデルを必要としないアクション

リソースコントローラの認可

ミドルウェア経由

モデルを必要としないアクション

Blade テンプレート経由

モデルを必要としないアクション

追加のコンテキストの提供