CodeIgniter框架怎么实现自定义CLI命令工具_CodeIgniter框架命令行扩展应用【应用】

秋明酱_9901

秋明酱_9901

2026-04-17

915人浏览

原创

ci4原生支持cli命令,需在app/commands/下创建继承basecommand的类,定义$name和$description,实现run()方法,通过$this->params获取参数,用cli::write()输出。

codeigniter框架怎么实现自定义cli命令工具_codeigniter框架命令行扩展应用【应用】

CodeIgniter 3 和 CodeIgniter 4 实现 CLI 命令的方式完全不同:CI3 必须靠“伪装 HTTP 环境 + 手动补全 $_SERVER 变量”才能跑通,而 CI4 原生支持、开箱即用,且提供 CLI 类封装交互逻辑。直接拿 CI3 的写法套到 CI4 上会报错,反之亦然。

CI4 中怎么注册一个可执行的 CLI 命令

CI4 把 CLI 命令视为独立于控制器的类,放在 app/Commands/ 目录下,继承 CodeIgniter\CLI\BaseCommand,并实现 run() 方法。

  • 命令类必须有 $name 属性(如 'tools:hello'),冒号前是组名,后是命令名,终端里就用 php spark tools:hello
  • $description 是必填项,否则 php spark list 不显示该命令
  • 参数通过 $this->params 获取(不是 $argv),例如执行 php spark tools:hello --name=John,则 $this->params['name'] 为 'John'
  • 不推荐在 run() 里直接 echo 输出,应使用 CLI::write(),它自动处理颜色、换行和 Windows 兼容性

CI3 中为什么不能直接运行 php index.php controller method

因为 CI3 的 index.php 在初始化时硬依赖 $_SERVER['REQUEST_METHOD']、$_SERVER['PATH_INFO'] 等 Web 环境变量,而 CLI 下它们根本不存在,导致 Undefined index: REQUEST_METHOD 或白屏。

CodeIgniter 4.7.0
CodeIgniter 4.7.0

CodeIgniter下载页提供 CodeIgniter 4.7.0 官方源码包,并整理框架安装、数据库配置与入门开发说明。

下载
  • 必须另建入口文件(如 cli.php),手动预设关键变量:$_SERVER['REQUEST_METHOD'] = 'GET'; $_SERVER['PATH_INFO'] = '';
  • 需显式定义 ENVIRONMENT,否则日志可能写入错误目录
  • CI3 的 $this->input->argv() 只返回从第 3 个元素开始的参数(即跳过 php 和 index.php),但原生 $argv 是完整的,别混用
  • 不要在 CI3 CLI 控制器里调用 $this->input->get() 或 $this->input->post(),它们永远为空

如何让 CLI 命令只允许命令行访问,禁止 URL 调用

CI3 和 CI4 都提供了可靠的运行环境判断方式,但实现位置和推荐做法不同。

  • CI3 推荐在控制器构造函数中加:if (!$this->input->is_cli_request()) { show_error('CLI only.'); } —— 注意这个方法内部实际检查的是 PHP_SAPI === 'cli'
  • CI4 更推荐在命令类的 run() 开头加:if (is_cli() === false) { throw new \RuntimeException('This command must be run from the CLI.'); },因为命令类本身就不走控制器生命周期
  • CI3 中还常见手动判断:if (php_sapi_name() !== 'cli') { exit('No direct script access allowed'); },这个更底层、更可靠,但要放在入口或控制器最顶部

CLI 下读取用户输入和输出格式化容易踩哪些坑

CI4 的 CLI 类封装了交互能力,但默认行为和开发者直觉有偏差。

  • CLI::prompt() 默认不回显用户输入(比如密码场景需要隐藏),若要明文输入,得加第四个参数:CLI::prompt('Password:', null, 'required', false)
  • 彩色输出要用 CLI::color('text', 'red'),直接写 \033[31mtext\033[0m 在 Windows CMD 下大概率失效
  • CLI::error() 和 CLI::success() 自动加换行,重复调用 CLI::write() 会导致空行过多
  • 长文本自动换行由 CLI::wrap() 处理,但它的宽度默认按 80 字符算,如果终端更宽,得传入 CLI::wrap($text, 120)

真正麻烦的从来不是写一个能跑的 CLI 命令,而是确保它在不同 PHP SAPI(cli/phpdbg)、不同操作系统(Linux/macOS/Windows)、不同终端宽度下行为一致——尤其是参数解析和用户输入反馈。CI4 的 spark 命令层已经做了大量适配,CI3 则几乎全靠自己兜底。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10204

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6021

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2095

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3788

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4494

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3511

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5017

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3922

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11882

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程