Laravelでコマンドラインアプリケーションを作る

Laravelでコマンドラインアプリケーションを作るには、php artisan make:commandコマンドを使います。

# php artisan make:command Sample

このコマンドでapp/Console/CommandsディレクトリにSample.phpという名前でファイルが作られます。

作られたファイルの中身は以下のようになっています。

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class Sample extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:name';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

コマンドとして動作するクラスはIlluminate\Console\Commandを継承します。

コマンドで実行したい処理はhandle()で実装します。

handle()メソッドを以下のようにしてみます。

    public function handle()
    {
        echo 'sample command.'.PHP_EOL;
    }

実行するコマンド名は以下の行で定義されています。
コマンドを変更したい場合は「’command:name’」の部分を書き換える事になります。

protected $signature = 'command:name';

実行するにはLaravelアプリケーションのルートディレクトリで以下のようなコマンドを打ちます。

# php artisan command:name
sample command.

ちなみにLaravelアプリケーションのルートディレクトリ以外で実行するとエラーになります。

# cd app/
# php artisan command:name
Could not open input file: artisan

Laravelでコマンドラインアプリケーションを作る方法は以上です。