イントロダクションIntroduction
アプリケーションで動作させる、追加のカスタムコマンドを構築することも可能です。app/Console/Commandsディレクトリーにカスタムコマンドを保存してください。しかし、composer.jsonで設定し、コマンドがオートロードされる限り、どこにでも好きな場所に置くことができます。In addition to the commands provided with Artisan, you may also build your own custom commands for working with your application. You may store your custom commands in the app/Console/Commands directory; however, you are free to choose your own storage location as long as your commands can be autoloaded based on your composer.json settings.
コマンドの構築Building A Command
クラス生成Generating The Class
新しいコマンドを生成するには、Artisanコマンドのmake:consoleを使用し、開発を開始するために役立つ、コマンドのひな形を生成してください。To create a new command, you may use the make:console Artisan command, which will generate a command stub to help you get started:
新コマンドクラスの生成Generate A New Command Class
php artisan make:console FooCommand
上のコマンドは、app/Console/Commands/FooCommand.phpにクラスを生成します。The command above would generate a class at app/Console/Commands/FooCommand.php.
--commandオプションを付け、コマンドを生成すると、コマンド名を指定することができます。When creating the command, the --command option may be used to assign the terminal command name:
php artisan make:console AssignUsers --command=users:assign
コマンドの記述Writing The Command
コマンドを生成したら、クラスのnameとdescriptionプロパティーを埋めてください。listスクリーンであなたのコマンドを表示する時に表示されます。Once your command is generated, you should fill out the name and description properties of the class, which will be used when displaying your command on the list screen.
fireメソッドはコマンドが実行される時に呼び出されます。このメソッドの中に、コマンドロジックを書いてください。The fire method will be called when your command is executed. You may place any command logic in this method.
引数とオプションArguments & Options
getArgumentsとgetOptionsメソッドでコマンドが受け取る引数とオプションを定義します。両者のメソッドはオプションを配列のリストで記述した、コマンドの配列をリターンします。The getArguments and getOptions methods are where you may define any arguments or options your command receives. Both of these methods return an array of commands, which are described by a list of array options.
argumentsを定義する定義配列は以下のような形式です。When defining arguments, the array definition values represent the following:
[$name, $mode, $description, $defaultValue]
引数modeはInputArgument::REQUIREDかInputArgument::OPTIONALのどちらかです。The argument mode may be any of the following: InputArgument::REQUIRED or InputArgument::OPTIONAL.
optionsを定義する定義配列は以下のような形式です。When defining options, the array definition values represent the following:
[$name, $shortcut, $mode, $description, $defaultValue]
オプションでは、引数modeはInputOption:REQUIRED、InputOption::OPTIONAL、InputOption::VALUE_IS_ARRAY、InputOption::VALUE_NONEのどれかです。For options, the argument mode may be: InputOption::VALUE_REQUIRED, InputOption::VALUE_OPTIONAL, InputOption::VALUE_IS_ARRAY, InputOption::VALUE_NONE.
VALUE_IS_ARRAYモードはコマンド実行時に複数回指定されるスイッチを表します。The VALUE_IS_ARRAY mode indicates that the switch may be used multiple times when calling the command:
InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY
これにより、以下のような指定が可能になります。Would then allow for this command:
php artisan foo --option=bar --option=baz
VALUE_NONEオプションは「スイッチ」として指定されるオプションを表します。The VALUE_NONE option indicates that the option is simply used as a "switch":
php artisan foo --option
入力の取り込みRetrieving Input
コマンド実行時、アプリケーションが受け取った引数やオプションの値にアクセスする必要があるのは明らかです。これを行うには、argumentとoptionメソッドを使用します。While your command is executing, you will obviously need to access the values for the arguments and options accepted by your application. To do so, you may use the argument and option methods:
コマンド引数値の取得Retrieving The Value Of A Command Argument
$value = $this->argument('name');
全引数の取得Retrieving All Arguments
$arguments = $this->argument();
コマンドオプションの値を習得するRetrieving The Value Of A Command Option
$value = $this->option('name');
全オプションの取得Retrieving All Options
$options = $this->option();
出力Writing Output
コンソールに出力するには、info、comment、question、errorメソッドを使います。その名前が表す目的で使用し、それぞれ適当なANSIカラーが表示に使われます。To send output to the console, you may use the info, comment, question and error methods. Each of these methods will use the appropriate ANSI colors for their purpose.
お知らせをコンソールに出力Sending Information To The Console
$this->info('Display this on the screen');
エラーメッセージをコンソールに出力Sending An Error Message To The Console
$this->error('Something went wrong!');
質問Asking Questions
入力を求めるためにaskとconfirmメソッドも使用できます。You may also use the ask and confirm methods to prompt the user for input:
ユーザーからの入力Asking The User For Input
$name = $this->ask('What is your name?');
ユーザーからの秘密文字列の入力Asking The User For Secret Input
$password = $this->secret('What is the password?');
ユーザーへの確認Asking The User For Confirmation
if ($this->confirm('Do you wish to continue? [yes|no]'))
{
//
}
また、confirmメソッドにはtrueかfalseのデフォルト値が指定できます。You may also specify a default value to the confirm method, which should be true or false:
$this->confirm($question, true);
他コマンドの呼び出しCalling Other Commands
場合により、コマンドの中から他のコマンドを呼び出したい場合もあります。callメソッドを使ってください。Sometimes you may wish to call other commands from your command. You may do so using the call method:
$this->call('command:name', ['argument' => 'foo', '--option' => 'bar']);
コマンド登録Registering Commands
Artisanコマンドの登録Registering An Artisan Command
コマンドが完成後、使用するにはArtisanとして登録する必要があります。通常、app/Console/Kernel.phpファイルで行います。このファイルのcommandsプロパティに、コマンドのリストがあります。自作したコマンドを登録するには、このリストに追加するだけです。Once your command is finished, you need to register it with Artisan so it will be available for use. This is typically done in the app/Console/Kernel.php file. Within this file, you will find a list of commands in the commands property. To register your command, simply add it to this list.
protected $commands = [
'App\Console\Commands\FooCommand'
];
Artisanが起動すると、このプロパティにリストされている全コマンドがサービスコンテナにより依存解決され、Artisanコマンドとして登録されます。When Artisan boots, all the commands listed in this property will be resolved by the service container[/docs/{{version}}/container] and registered with Artisan.