イントロダクション

アプリケーションで動作させる追加のカスタムコマンドを構築することも可能です。app/Console/Commandsディレクトリーにカスタムコマンドを保存してください。しかし、コマンドがオートロードされるようにcomposer.jsonで設定する限り、どこにでも好きな場所に置くことができます。

コマンドの構築

クラスを生成する

新しいコマンドを生成するには、Artisanコマンドのmake:consoleを使用し、開発を始める手助けとなる、コマンドのひな形を生成してください。

新しいコマンドクラスを生成する

php artisan make:console FooCommand

上のコマンドは、app/Console/FooCommand.phpにクラスを生成します。

--commandオプションを付け、コマンドを生成すると、コマンド名を指定することができます。

php artisan make:console AssignUsers --command=users:assign

コマンドを書く

コマンドを生成したら、クラスのnamedescriptionプロパティーを埋めてください。listスクリーンであなたのコマンドを表示する時に使用されます。

fireメソッドはコマンドが実行される時に呼び出されます。このメソッドの中に、コマンドロジックを書いてください。

引数とオプション

getArgumentsgetOptionsメソッドでコマンドが受け取る引数とオプションを定義します。両者のメソッドはオプションを配列のリストで記述した、コマンドの配列をリターンします。

argumentsを定義する定義配列は以下のような形式です。

array($name, $mode, $description, $defaultValue)

引数modeInputArgument::REQUIREDInputArgument::OPTIONALのどちらかです。

optionsを定義する定義配列は以下のような形式です。

array($name, $shortcut, $mode, $description, $defaultValue)

オプションでは、引数modeInputOption:REQUIREDInputOption::OPTIONALInputOption::VALUE_IS_ARRAYInputOption::VALUE_NONEのどちらかです。

VALUE_IS_ARRAYモードはコマンド実行時に複数回指定されるスイッチを表します。

php artisan foo --option=bar --option=baz

VALUE_NONEオプションは「スイッチ」として指定されるオプションを表します。

php artisan foo --option

入力の取り込み

コマンド実行時、アプリケーションが受け取った引数やオプションの値にアクセスする必要があるのは明らかです。これを行うには、argumentoptionメソッドを使用します。

コマンド引数の値を取得する

$value = $this->argument('name');

全ての引数を取得する

$arguments = $this->argument();

コマンドオプションの値を習得する

$value = $this->option('name');

全てのオプションを取得する

$options = $this->option();

出力

コンソールに出力するには、infocommentquestionerrorメソッドを使います。その名前が表す目的で使用し、それぞれ適当なANSIカラーが表示に使われます。

お知らせをコンソールに送る

$this->info('Display this on the screen');

エラーメッセージをコンソールに送る

$this->error('Something went wrong!');

質問

入力を求めるためにaskconfirmメソッドも使用できます。

ユーザーに入力を求める

$name = $this->ask('What is your name?');

ユーザーに秘密の文字列の入力を求める

$password = $this->secret('What is the password?');

ユーザーに確認を求める

if ($this->confirm('Do you wish to continue? [yes|no]'))
{
    //
}

また、confirmメソッドにはtruefalseのデフォルト値が指定できます。

$this->confirm($question, true);

他のコマンドを呼び出す

場合により、コマンドの中から他のコマンドを呼び出したい場合もあります。callメソッドを使ってください。

$this->call('command:name', ['argument' => 'foo', '--option' => 'bar']);

コマンドの登録

Artisanコマンドを登録する

コマンドが完成したら、使用するにはArtisanとして登録する必要があります。通常、app/Console/Kernel.phpファイルの中で行います。このファイルのcommandsプロパティに、コマンドのリストがあります。自作したコマンドを登録するには、ただこのリストに追加するだけです。Artisanが起動すると、このプロパティにリストされている全コマンドがIoCコンテナにより依存解決され、Artisanコマンドとして登録されます。