Spark 命令

CodeIgniter 附带官方命令 spark 和内置命令。

运行命令

通过 CLI 运行

命令从项目根目录的命令行运行。已提供命令文件 spark 用于运行任何 CLI 命令。

显示命令列表

当调用 spark 而不指定命令时,会显示一个简单的帮助页面,该页面还提供可用命令及其描述的列表,按类别排序

php spark
spark list

php sparklist 命令完全相同。

php spark list

您也可以使用 --simple 选项来获取所有可用命令的原始列表,按字母顺序排序。

php spark list --simple

显示帮助

您可以使用 help 命令获取有关任何 CLI 命令的帮助,如下所示。

php spark help db:seed

从 v4.3.0 开始,您也可以使用 --help 选项代替 help 命令。

php spark db:seed --help

运行命令

您应该将命令的名称作为第一个参数传递以运行该命令。

php spark migrate

某些命令需要额外的参数,这些参数应该直接在命令之后提供,用空格隔开。

php spark db:seed DevUserSeeder

对于 CodeIgniter 提供的所有命令,如果您没有提供必需的参数,系统会提示您提供它正常运行所需的信息。

php spark make:controller

Controller class name :

抑制标题输出

当您运行命令时,将输出包含 CodeIgniter 版本和当前时间的标题。

php spark env

CodeIgniter v4.3.5 Command Line Tool - Server Time: 2023-06-16 12:45:31 UTC+00:00

Your environment is currently set as development.

您始终可以传递 --no-header 来抑制标题输出,这对于解析结果很有用。

php spark env --no-header

Your environment is currently set as development.

调用命令

命令也可以从您自己的代码中运行。这通常在控制器中用于 cronjob 任务,但它们可以在任何时候使用。您可以使用 command() 函数来实现。此函数始终可用。

<?php

echo command('make:migration TestMigration');

唯一的参数是字符串,即调用的命令和任何参数。这与您从命令行调用它的方式完全相同。

当不从命令行运行时,从运行的命令中捕获所有输出。它从命令返回,以便您可以选择显示它或不显示它。