## 創建自定義指令 第一步，創建一個自定義命令類文件，運行指令 ~~~ php think make:command Hello hello ~~~ 會生成一個`app\command\Hello`命令行指令類，我們修改內容如下： ~~~ <?php namespace app\command; use think\console\Command; use think\console\Input; use think\console\input\Argument; use think\console\input\Option; use think\console\Output; class Hello extends Command { ? ? protected function configure() ? ? { ? ? ? ? $this->setName('hello') ->addArgument('name', Argument::OPTIONAL, "your name") ->addOption('city', null, Option::VALUE_REQUIRED, 'city name') ->setDescription('Say Hello'); ? ? } ? ? protected function execute(Input $input, Output $output) ? ? { $name = trim($input->getArgument('name')); $name = $name ?: 'thinkphp'; if ($input->hasOption('city')) { $city = PHP_EOL . 'From ' . $input->getOption('city'); } else { $city = ''; } ? ? ? ? $output->writeln("Hello," . $name . '!' . $city); ? ? } } ~~~ 這個文件定義了一個叫`hello`的命令，并設置了一個`name`參數和一個`city`選項。 第二步，配置`config/console.php`文件 ~~~ <?php return [ 'commands' => [ ? ? 'hello' => 'app\command\Hello', ] ]; ~~~ 第三步，測試-命令幫助-命令行下運行 ~~~ php think ~~~ 輸出 ~~~cmd Think Console version 0.1 Usage: ? command [options] [arguments] Options: ? -h, --help ? ? ? ? ? ?Display this help message ? -V, --version ? ? ? ? Display this console version ? -q, --quiet ? ? ? ? ? Do not output any message ? ? ? --ansi ? ? ? ? ? ?Force ANSI output ? ? ? --no-ansi ? ? ? ? Disable ANSI output ? -n, --no-interaction ?Do not ask any interactive question ? -v|vv|vvv, --verbose ?Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Available commands: ? build ? ? ? ? ? ? ?Build Application Dirs ? clear ? ? ? ? ? ? ?Clear runtime file hello? ? ? ? ? ? ? Say Hello ? help ? ? ? ? ? ? ? Displays help for a command ? list ? ? ? ? ? ? ? Lists commands ?make ? make:controller ? ?Create a new resource controller class ? make:model ? ? ? ? Create a new model class ?optimize ? optimize:autoload ?Optimizes PSR0 and PSR4 packages to be loaded with classmaps too, good for production. ? optimize:config ? ?Build config and common file cache. ? optimize:schema ? ?Build database schema cache. ~~~ 第四步，運行`hello`命令 ~~~cmd php think hello ~~~ 輸出 ~~~ Hello thinkphp! ~~~ 添加命令參數 ~~~cmd php think hello kancloud ~~~ 輸出 ~~~ Hello kancloud! ~~~ 添加`city`選項 ~~~cmd php think hello kancloud --city shanghai ~~~ 輸出 ~~~ Hello kancloud! From shanghai ~~~ >[danger] 注意看參數和選項的調用區別 > 如果需要生成一個指定的命名空間，可以使用： ~~~ php think make:command app\index\Command second ~~~ ## 在控制器中調用命令 支持在控制器的操作方法中直接調用命令，例如： ~~~ <?php namespace app\index\controller; use think\facade\Console; class Index { public function hello($name) { $output = Console::call('hello', [$name]); return $output->fetch(); } } ~~~ 訪問該操作方法后，例如： ~~~ http://serverName/index/hello/name/thinkphp ~~~ 頁面會輸出 ~~~ Hello thinkphp! ~~~ ## 命令行選項 ``` use think\\console\\input\\Option; // 無需傳值 Option::VALUE_NONE ? ? = 1; // 必須傳值 Option::VALUE_REQUIRED = 2; // 可選傳值 Option::VALUE_OPTIONAL = 4; // 傳數組值 Option::VALUE_IS_ARRAY = 8; ``` ## addOption ``` /** * 添加選項 * @param string $name ? ? ? ?選項名稱 * @param string $shortcut ? ?別名 * @param int $mode ? ? ? ?類型 * @param string $description 描述 * @param mixed $default ? ? 默認值 * @return Command */ public function addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', $default = null) ``` ### 示例 定義如下: ``` ->addOption('adminname', 'p', Option::VALUE_OPTIONAL, '管理員賬號') ``` 調用方式可以如下: ``` // 無需任何參數 php think install // 使用全名參數 php think install --adminuser admin // 使用縮寫 php think install -u admin ``` 指令邏輯中可以這樣獲取: ``` $input->getOption('adminname'); ```