README

FyreCommand 是一个免费、开源的 PHP CLI 命令库。

安装

使用 Composer

composer require fyre/command

在 PHP 中

use Fyre\Command\CommandRunner;

方法

添加命名空间

为加载命令添加命名空间。

$namespace 是一个表示命名空间的字符串。

CommandRunner::addNamespace($namespace);

所有

获取所有可用命令。

$commands = CommandRunner::all();

此方法将返回一个数组，其中键是命令别名，值是命令的实例。

清除

清除所有命名空间和已加载的命令。

CommandRunner::clear();

获取命名空间

获取命名空间。

$namespaces = CommandRunner::getNamespaces();

处理

处理 argv 命令。

$argv 是一个包含 CLI 参数的数组。

$code = CommandRunner::handle($argv);

有命令

检查命令是否存在。

$alias 是表示命令别名的字符串。

$hasCommand = CommandRunner::hasCommand($alias);

有命名空间

检查命名空间是否存在。

$namespace 是一个表示命名空间的字符串。

$hasNamespace = CommandRunner::hasNamespace($namespace);

移除命名空间

移除一个命名空间。

$namespace 是一个表示命名空间的字符串。

$removed = CommandRunner::removeNamespace($namespace);

运行

运行命令。

$alias 是表示命令别名的字符串。
$arguments 是一个包含命令参数的数组，默认为 []。

$code = CommandRunner::run($alias, $arguments);

命令

可以通过扩展 \Fyre\Command\Command 来创建自定义命令，类名后缀为 "Command"，并确保实现了 run 方法。

别名

获取命令别名。

$alias = $command->getAlias();

别名可以通过在命令上定义 $alias 属性来设置，否则默认使用类名。

获取描述

获取命令描述。

$description = $command->getDescription();

描述可以通过在命令上定义 $description 属性来设置。

获取名称

获取命令名称。

$name = $command->getName();

名称可以通过在命令上定义 $name 属性来设置，否则默认使用类名。

运行

运行命令。

$arguments 是一个包含命令参数的数组。

$code = $command->run($arguments);

此方法应返回一个表示命令退出代码的整数。可以使用类常量 Command::CODE_SUCCESS 和 Command::CODE_ERROR。

fyre / command

维护者

详细信息

README

目录

安装

方法

命令