# 自動創建類（Class） 要創建一個新的自定義命令，您可以使用 make:console 這個 Artisan 命令，這將會自動產生一個 Command stub 協助您開始創建您的自定義命令： ## 自動創建一個新的命令類 ~~~ php artisan make:console FooCommand ~~~ 上面的命令將會協助你自動創建一個類，并保存為文件 `app/Console/FooCommand.php`。 在創建自定義命令時，加上 `--command` 這個選項，將可以指定之后在終端機使用此自定義命令時，所要輸入的自定義命令名稱： ~~~ php artisan make:console AssignUsers --command=users:assign ~~~ # 撰寫自定義命令 一旦你的自定義命令被創建后，你需要填寫自定義命令的 `名稱（name）` 與 `描述（description）`，您所填寫的內容將會被顯示在 Artisan 的 `list` 畫面中。 當您的自定義命令被執行時，將會調用 `fire` 方法，您可以在此為自定義命令加入任何的邏輯判斷。 # 參數與選項 你可以通過 `getArguments` 與 `getOptions` 為自定義命令自行定義任何需要的參數與選項。這兩個方法都會返回一組命令數組，并由選項數組的清單所組成。 當定義 `arguments` 時，該數組值的定義分別如下： ~~~ [$name, $mode, $description, $defaultValue] ~~~ 參數 mode 可以是下列其中一項： `InputArgument::REQUIRED` 或 `InputArgument::OPTIONAL`。 當定義 `options` 時，該數組值的定義分別如下： ~~~ [$name, $shortcut, $mode, $description, $defaultValue] ~~~ 對選項而言，參數 `mode` 可以是下列其中一項：`InputOption::VALUE_REQUIRED`, `InputOption::VALUE_OPTIONAL`, `InputOption::VALUE_IS_ARRAY`, `InputOption::VALUE_NONE`。 模式為 `VALUE_IS_ARRAY` 表示調用命令時可以多次使用此選項來傳入多個值： ~~~ InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY ~~~ 這個命令將允許: ~~~ php artisan foo --option=bar --option=baz ~~~ 模式為 `VALUE_NONE` 則表示將此選項純粹作為一種有或無的「開關」使用： ~~~ php artisan foo --option ~~~ # 取得輸入值（參數與選項） 當您的自定義命令執行時，您需要讓您的應用程序可以訪問到這些參數和選項的值，要做到這一點，您可以使用 `argument` 和 `option` 方法： ## 取得自定義命令被輸入的參數 ~~~ $value = $this->argument('name'); ~~~ ## 取得自定義命令被輸入的所有參數 ~~~ $arguments = $this->argument(); ~~~ ## 取得自定義命令被輸入的選項 ~~~ $value = $this->option('name'); ~~~ ## 取得自定義命令被輸入的所有選項 ~~~ $options = $this->option(); ~~~ # 產生輸出 想要顯示信息到終端屏幕上，您可以使用 `info`、`comment`、`question` 和 `error` 方法。每一種方法將會依據它所代表的目的，分別對應一種適當的 ANSI 顏色。 ## 顯示一般消息到終端屏幕 ~~~ $this->info('Display this on the screen'); ~~~ ## 顯示錯誤消息到終端屏幕 ~~~ $this->error('Something went wrong!'); ~~~ # 詢問式輸入 您也可以使用 `ask` 和 `confirm` 方法來提示用戶進行輸入： ## 提示用戶進行輸入 ~~~ $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` 方法，可以是 `true` 或 `false`： ~~~ $this->confirm($question, true); ~~~ # 調用其它命令 有時候您可能希望在您的命令內部調用其它命令，此時您可以使用 `call` 方法： ~~~ $this->call('command:name', ['argument' => 'foo', '--option' => 'bar']); ~~~