tokenCan()

トークンキャン（Laravel Sanctum）

意味トークンの権限チェック

tokenCan()とは？

tokenCan()は、Laravel Sanctumで現在のAPIトークンが特定の能力（アビリティ）を持っているかどうかをチェックするメソッドです。トークンに付与された権限に基づいて、特定のアクションの実行を制御するのに使用します。

tokenCan()の具体的な使い方

トークンの権限チェック例

use Illuminate\Support\Facades\Route;

Route::middleware('auth:sanctum')->get('/update-server', function (Request $request) {
    if ($request->user()->tokenCan('server:update')) {
        // サーバー更新のロジック
        return response()->json(['message' => 'サーバーが更新されました']);
    } else {
        return response()->json(['error' => '権限がありません'], 403);
    }
});

// トークン作成例（別の場所で実行）
$user = User::find(1);
$token = $user->createToken('api-token', ['server:update']);
echo $token->plainTextToken;

👇出力結果

{"message":"サーバーが更新されました"}
または
{"error":"権限がありません"}

この例では、/update-serverエンドポイントを定義し、tokenCan()メソッドを使用してユーザーのトークンが'server:update'権限を持っているかチェックしています。権限がある場合はサーバー更新のロジックを実行し、ない場合はエラーレスポンスを返します。また、トークン作成時に権限を指定する例も示しています。

tokenCan()に関するよくある質問

Q. tokenCan()の使用目的は？

A. tokenCan()メソッドは、現在のAPIトークンが特定の能力（アビリティ）を持っているかどうかをチェックするために使用されます。これにより、特定のアクションに対する権限を制御できます。

Q. 複数の能力をチェックできますか？

A. はい、tokenCan()を複数回呼び出すか、配列を使用して複数の能力をチェックできます。例：$user->tokenCan(['ability1', 'ability2'])

Q. トークンの能力はどこで設定？

A. トークンの能力は、トークン作成時に設定します。例：$token = $user->createToken('token-name', ['server:update']);

tokenCan()が学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、LaravelのtokenCan()やcurrentAccessToken()、HasApiTokens、createToken、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。