命令行应用（Command Line Applications）

CLI应用即是运行在命令行窗体上的应用。 主要用来实现后台任务， 命令行工具等。

结构（Structure）

最小结构的CLI程序如下：

  • app/config/config.php
  • app/tasks/MainTask.php
  • app/cli.php <– 主要启动文件

创建引导（Creating a Bootstrap）

普通的MVC程序中，启动文件用来启动整个应用。和web应用不同, 此处应用中我们使用cli.php来作为启动文件。

下面是一个简单的启动文件示例：

  1. <?php
  3. use Phalcon\Di\FactoryDefault\Cli as CliDI;
  4. use Phalcon\Cli\Console as ConsoleApp;
  5. use Phalcon\Loader;
  9. // 使用CLI工厂类作为默认的服务容器
  10. $di = new CliDI();
  14. /**
  15.  * 注册类自动加载器
  16.  */
  17. $loader = new Loader();
  19. $loader->registerDirs(
  20.     [
  21.         __DIR__ . "/tasks",
  22.     ]
  23. );
  25. $loader->register();
  29. // 加载配置文件（如果存在）
  31. $configFile = __DIR__ . "/config/config.php";
  33. if (is_readable($configFile)) {
  34.     $config = include $configFile;
  36.     $di->set("config", $config);
  37. }
  41. // 创建console应用
  42. $console = new ConsoleApp();
  44. $console->setDI($di);
  48. /**
  49.  * 处理console应用参数
  50.  */
  51. $arguments = [];
  53. foreach ($argv as $k => $arg) {
  54.     if ($k === 1) {
  55.         $arguments["task"] = $arg;
  56.     } elseif ($k === 2) {
  57.         $arguments["action"] = $arg;
  58.     } elseif ($k >= 3) {
  59.         $arguments["params"][] = $arg;
  60.     }
  61. }
  65. try {
  66.     // 处理参数
  67.     $console->handle($arguments);
  68. } catch (\Phalcon\Exception $e) {
  69.     echo $e->getMessage();
  71.     exit(255);
  72. }

上面的代码可以使用如下方式执行：

  1. $ php app/cli.php
  3. 这样程序会直接执行默认的任务及默认动作.

任务（Tasks）

这里的任务同于web应用中的控制器。 任一 CLI 应用程序都至少包含一个mainTask 及一个 mainAction， 每个任务至少有一个mainAction, 这样在使用者未明确的 指定action时 此mainAction就会执行。

下面即是一个mainTask的例子（ app/tasks/MainTask.php ）：

  1. <?php
  3. use Phalcon\Cli\Task;
  5. class MainTask extends Task
  6. {
  7.     public function mainAction()
  8.     {
  9.         echo "This is the default task and the default action" . PHP_EOL;
  10.     }
  11. }

处理动作参数（Processing action parameters）

CLI应用中， 开发者也可以在action中处理传递过来的参数， 下面的例子中已经对传递过来的参数进行了处理。

如果你使用下面的参数和动作运行应用程序:

  1. <?php
  3. use Phalcon\Cli\Task;
  5. class MainTask extends Task
  6. {
  7.     public function mainAction()
  8.     {
  9.         echo "This is the default task and the default action" . PHP_EOL;
  10.     }
  12.     /**
  13.      * @param array $params
  14.      */
  15.     public function testAction(array $params)
  16.     {
  17.         echo sprintf(
  18.             "hello %s",
  19.             $params[0]
  20.         );
  22.         echo PHP_EOL;
  24.         echo sprintf(
  25.             "best regards, %s",
  26.             $params[1]
  27.         );
  29.         echo PHP_EOL;
  30.     }
  31. }

我们可以使用下面的命令行及参数执行程序：

  1. $ php app/cli.php main test world universe
  3. hello world
  4. best regards, universe

链中运行任务（Running tasks in a chain）

CLI应用中可以在一个action中执行另一action. 要实现这个需要在 DI 中设置console.

  1. <?php
  3. $di->setShared("console", $console);
  5. try {
  6.     // Handle incoming arguments
  7.     $console->handle($arguments);
  8. } catch (\Phalcon\Exception $e) {
  9.     echo $e->getMessage();
  11.     exit(255);
  12. }

然后开发者即可在一个action中使用用其它的action了. 下面即是例子：

  1. <?php
  3. use Phalcon\Cli\Task;
  5. class MainTask extends Task
  6. {
  7.     public function mainAction()
  8.     {
  9.         echo "This is the default task and the default action" . PHP_EOL;
  11.         $this->console->handle(
  12.             [
  13.                 "task"   => "main",
  14.                 "action" => "test",
  15.             ]
  16.         );
  17.     }
  19.     public function testAction()
  20.     {
  21.         echo "I will get printed too!" . PHP_EOL;
  22.     }
  23. }

当然， 通过扩展 Phalcon\Cli\Task 来实现如上操作会是一个更好主意。