【Laravel】
artisanコマンドを自作して実行する方法

参考文献

目次

• 新規artisanコマンドを作成する
• コマンドの処理を書く
• 新規作成したartisanコマンドを実行する
• まとめ
• 参考文献・おすすめ文献
• 関連記事

新規artisanコマンドを作成する

php artisan make:command XXXXX

php artisan make:command SampleCommand

コマンドの処理を書く

先ほど提示した例のコマンドで作成したクラスファイルを見ると以下のような内容になっていると思います（コメントは削除しています）。

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class SampleCommand extends Command{
    protected $signature = 'command:name';
    protected $description = 'Command description';

    public function handle(){
        return Command::SUCCESS;
    }
}

それぞれの内容をざっくり説明すると以下のような感じです。

実際にコードの内容を記載すると以下のような感じになります。

今回はログに「Sample」という文字を出力するartisanコマンドを作成します。

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class SampleCommand extends Command{
    protected $signature = 'sample:cmd';
    protected $description = 'サンプルコマンドです。';

    public function handle(){
        echo("sample\n");
        return Command::SUCCESS;
    }
}

これで自作のartisanコマンドは完成です。

実際本格的なコマンド等を作成する場合は、DBから値を取得したり外部のREST APIを叩いたりすると思うので、その場合は適宜処理を記載してください。

新規作成したartisanコマンドを実行する

最後に今回作成したコマンドを実行してみましょう。

php artisan sample:cmd

実行するとコンソールにsampleと文字が出力されることが確認できます。

まとめ

Laravelで自作のartisanコマンドを自作するには
1. php artisan make:commandを使用してコマンドのクラスファイルを作成。
2. 1で作成したファイルに処理を記載する です。

参考文献・おすすめ文献

Laravel Document - コマンド記述