通过 CLI 运行控制器

除了通过浏览器的 URL 调用应用程序的控制器外, 它们也可以通过命令行接口 (CLI) 加载。

备注

建议使用 Spark 命令来编写 CLI 脚本,而不是通过 CLI 调用控制器。有关详细信息,请参阅 Spark 命令和创建 Spark 命令页面。

让我们试一试:Hello World!

创建控制器 

让我们创建一个简单的控制器,这样你就可以看到它的实际效果。使用文本编辑器, 创建一个名为 Tools.php 的文件,并添加以下代码:

<?php

namespace App\Controllers;

use CodeIgniter\Controller;

class Tools extends Controller
{
    public function message($to = 'World')
    {
        return "Hello {$to}!" . PHP_EOL;
    }
}

备注

如果使用自动路由(改进版),请将方法名更改为 cliMessage()。

然后将该文件保存到 app/Controllers/ 目录中。

定义路由 

如果使用自动路由,请跳过此步骤。

在 app/Config/Routes.php 文件中,你可以轻松创建只能通过 CLI 访问的路由, 就像创建任何其他路由一样。与使用 get()、post() 或类似的方法不同,你将使用 cli() 方法。其他所有内容的工作原理与正常的路由定义完全相同:

<?php

$routes->cli('tools/message/(:segment)', 'Tools::message/$1');

有关更多信息,请参阅 Routes 页面。

警告

如果启用自动路由(传统) 并将命令文件放在 app/Controllers 中, 任何人都可以在自动路由(传统) 的帮助下通过 HTTP 访问该命令。