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

チートシート

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

Description

新しいジョブクラスを作成します。

Usage

php artisan make:job [-f|--force] [--sync] [--test] [--pest] [--] <name>

Arguments

引数必須説明
name必須ジョブ名

Options

オプション省略形必須説明
forcef-ジョブが既に存在する場合でもクラスを作成
sync--ジョブが同期的であることを示す
test--Jobに付随するPHPUnitのテストを生成
pest--ジョブに付随するペストテストを生成

Examples

no options

php artisan make:job FooJob
   INFO  Job [app/Jobs/FooJob.php] created successfully.  
<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

class FooJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    /**
     * Create a new job instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Execute the job.
     */
    public function handle(): void
    {
        //
    }
}

sync

php artisan make:job --sync FooJob
   INFO  Job [app/Jobs/FooJob.php] created successfully.  
<?php

namespace App\Jobs;

use Illuminate\Foundation\Bus\Dispatchable;

class FooJob
{
    use Dispatchable;

    /**
     * Create a new job instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Execute the job.
     */
    public function handle(): void
    {
        //
    }
}

Stub

OptionStub file name
-job.stub
syncjob.queued.stub

Source

10.x

framework/src/Illuminate/Foundation/Console/JobMakeCommand.php at 10.x · laravel/framework
The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.

11.x

framework/src/Illuminate/Foundation/Console/JobMakeCommand.php at 11.x · laravel/framework
The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.

コメント

タイトルとURLをコピーしました