[自定义应用命令行]

第一步，我们以demo应用为例创建demo:hello命令行,在app/demo/command目录里创建Hello.php文件

  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkCMF [ WE CAN DO IT MORE SIMPLE ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2013-present http://www.thinkcmf.com All rights reserved.
  6. // +----------------------------------------------------------------------
  7. // | Released under the MIT License.
  8. // +----------------------------------------------------------------------
  9. // | Author: 老猫 <thinkcmf@126.com>
  10. // +----------------------------------------------------------------------
  12. namespace app\demo\command;
  14. use think\console\Command;
  15. use think\console\Input;
  16. use think\console\input\Argument;
  17. use think\console\input\Option;
  18. use think\console\Output;
  20. class Hello extends Command
  21. {
  22.     protected function configure()
  23.     {
  24.         $this->setName('demo:hello')
  25.             ->addArgument('name', Argument::OPTIONAL, "your name")
  26.             ->addOption('city', '-c', Option::VALUE_REQUIRED, 'city name')
  27.             ->setDescription('Say App Hello');
  28.     }
  30.     protected function execute(Input $input, Output $output)
  31.     {
  32.         $name = $input->getArgument('name');
  33.         $name = $name ? $name : 'ThinkCMF';
  34.         $city = $input->getOption('city');
  35.         $city = $city ? $city : 'China';
  36.         $output->writeln("Hello, My name is " . $name . '! I\'m from ' . $city);
  37.     }
  40. }

这个文件定义了一个叫demo:hello的命令，并设置了一个name参数和一个city选项。

第二步，我们创建命令行配置文件app/demo/command.php，并添加如下内容

  1. <?php
  2. return [
  3.     // 指令名 =》完整的类名
  4.     'demo:hello' => 'app\demo\command\Hello'
  5. ];

第三步，测试-命令帮助-命令行下运行

  1. php think

输出

  1. ThinkPHP v6.0.12LTS & ThinkCMF v6.0.5
  3. Usage:
  4.   command [options] [arguments]
  6. Options:
  7.   -h, --help Display this help message
  8.   -V, --version Display this console version
  9.   -q, --quiet Do not output any message
  10.       --ansi Force ANSI output
  11.       --no-ansi Disable ANSI output
  12.   -n, --no-interaction Do not ask any interactive question
  13.   -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  15. Available commands:
  16.   clear Clear runtime file
  17.   cli List lightweight CLI commands
  18.   help Displays help for a command
  19.   list Lists commands
  20.   run PHP Built-in Server for ThinkPHP
  21.   version Show ThinkPHP & ThinkCMF version
  22.  demo
  23.   demo:hello Say App Hello
  24.  migrate
  25.   migrate:create Create a new migration
  26.   migrate:run Execute database migration
  27.  plugin
  28.   plugin:hello Say Plugin Hello
  29.  publish
  30.   publish:app Publish a ThinkCMF app
  31.   publish:plugin Publish a ThinkCMF plugin
  32.   publish:theme Publish a ThinkCMF theme
  33.  service
  34.   service:discover Discover Services for ThinkPHP
  35.  vendor
  36.   vendor:publish Publish any publishable assets from vendor packages

第四步，运行demo:hello命令

  1. php think demo:hello

输出

  1. Hello, My name is ThinkCMF! I'm from China

添加命令参数

  1. php think demo:hello catman

输出

  1. Hello, My name is catman! I'm from China

添加city选项

  1. php think demo:hello --city Shanghai

输出

  1. Hello, My name is ThinkCMF! I'm from Shanghai