【Laravel】artisanのmake:scopeコマンドを解説

Laravel 10.xのartisanの「make:scope」コマンドを解説します。

Description
Usage
Arguments
Options
Examples
1. no options
Stub
Source
1. 10.x
2. 11.x

Description

新しいグローバルスコープクラスを作成します。
scope.stubを利用して作成されます。

Usage

php artisan make:scope [-f|--force] [--] <name>

Bash

Arguments

引数	必須	設営
name	必須	グローバルスコープクラス名

Options

オプション	省略形	必須	説明
force	f	-	グローバルスコープが既に存在する場合でもクラスを作成

Examples

no options

php artisan make:scope FooScope

Bash

   INFO  Scope [app/Models/Scopes/FooScope.php] created successfully.

Plaintext

app/Models/Scopes/FooScope.php

<?php

namespace App\Models\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class FooScope implements Scope
{
    /**
     * Apply the scope to a given Eloquent query builder.
     */
    public function apply(Builder $builder, Model $model): void
    {
        //
    }
}