类 HelpCommand

打印命令列表

命名空间: Cake\Console\Command

常量

int

CODE_ERROR ¶
```
1
```
默认错误代码
int

CODE_SUCCESS ¶
```
0
```
默认成功代码

属性摘要

$_eventClass protected

string

新事件对象的默认类名。
$_eventManager protected

Cake\Event\EventManagerInterface|null

此对象用于分派内部事件的 Cake\Event\EventManager 实例。
$commands protected

Cake\Console\CommandCollection

用于获取帮助的命令集合。
$name protected

string

此命令的名称。

方法摘要

abort() public

使用 StopException 中止当前进程。
asText() protected

输出文本。
asXml() protected

输出为 XML
buildOptionParser() protected

获取选项解析器实例并对其进行配置。
defaultName() public static

获取命令名称。
dispatchEvent() public

用于创建和分派事件的包装器。
displayHelp() protected

输出帮助内容
execute() public

主函数打印命令列表。
executeCommand() public

使用提供的参数集执行另一个命令。
getDescription() public static

获取命令描述。
getEventManager() public

返回此对象的 Cake\Event\EventManager 管理器实例。
getName() public

获取命令名称。
getOptionParser() public

获取选项解析器。
getRootName() public

获取根命令名称。
getShortestName() protected
initialize() public

CakePHP 在执行命令之前调用的钩子方法。
outputPaths() protected

输出相关路径（如果已定义）。
run() public

运行命令。
setCommandCollection() public

设置正在使用的命令集合。
setEventManager() public

返回此对象的 Cake\Event\EventManagerInterface 实例。
setName() public

设置此命令在集合中使用的名称。
setOutputLevel() protected

根据参数设置输出级别。

方法详情

abort() ¶ public

abort(int $code = self::CODE_ERROR): never

使用 StopException 中止当前进程。

参数

int $code optional: 要使用的退出代码。

返回值

never

抛出

Cake\Console\Exception\StopException

asText() ¶ protected

asText(Cake\Console\ConsoleIo $io, iterable<string, string|object> $commands): void

输出文本。

参数

Cake\Console\ConsoleIo $io: 控制台输入输出
iterable<string, string|object> $commands: 要输出的命令集合。

返回值

void

asXml() ¶ protected

asXml(Cake\Console\ConsoleIo $io, iterable<string, string|object> $commands): void

输出为 XML

参数

Cake\Console\ConsoleIo $io: 控制台输入输出
iterable<string, string|object> $commands: 要输出的命令集合

返回值

void

buildOptionParser() ¶ protected

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

获取选项解析器实例并对其进行配置。

参数

Cake\Console\ConsoleOptionParser $parser: 要构建的解析器

返回值

Cake\Console\ConsoleOptionParser

defaultName() ¶ public static

defaultName(): string

获取命令名称。

根据类名返回命令名称。例如，对于类名为 UpdateTableCommand 的命令，返回的默认名称将为 'update_table'。

返回值

string

dispatchEvent() ¶ public

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

用于创建和分派事件的包装器。

返回分派的事件。

参数

string $name: 事件的名称。
array $data optional: 您希望通过此事件传递的任何值，侦听器都可以读取。
TSubject|null $subject optional: 此事件适用的对象（默认情况下为 $this）。

返回值

Cake\Event\EventInterface<TSubject>

displayHelp() ¶ protected

displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

输出帮助内容

参数

Cake\Console\ConsoleOptionParser $parser: 选项解析器。
Cake\Console\Arguments $args: 命令参数。
Cake\Console\ConsoleIo $io: 控制台输入输出

返回值

void

execute() ¶ public

execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int|null

主函数打印命令列表。

参数

Cake\Console\Arguments $args: 命令参数。
Cake\Console\ConsoleIo $io: 控制台输入输出

返回值

int|null

executeCommand() ¶ public

executeCommand(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

使用提供的参数集执行另一个命令。

如果您使用的是字符串命令名称，则该命令的依赖项将不会与应用程序容器一起解析。相反，您需要将命令作为带有所有依赖项的对象传递。

参数

Cake\Console\CommandInterface|string $command: 命令类名或命令实例。
array $args optional: 用于调用命令的参数。
Cake\Console\ConsoleIo|null $io optional: 用于执行命令的 ConsoleIo 实例。

返回值

int|null

getDescription() ¶ public static

getDescription(): string

获取命令描述。

返回值

string

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

返回此对象的 Cake\Event\EventManager 管理器实例。

您可以使用此实例向对象事件注册任何新的侦听器或回调，或者创建您自己的事件并根据需要触发它们。

返回值

Cake\Event\EventManagerInterface

getName() ¶ public

getName(): string

获取命令名称。

返回值

string

getOptionParser() ¶ public

getOptionParser(): Cake\Console\ConsoleOptionParser

获取选项解析器。

您可以覆盖 buildOptionParser() 来定义您的选项和参数。

返回值

Cake\Console\ConsoleOptionParser

抛出

Cake\Core\Exception\CakeException
当解析器无效时

getRootName() ¶ public

getRootName(): string

获取根命令名称。

返回值

string

getShortestName() ¶ protected

getShortestName(list<string> $names): string

参数

string[] $names: 名称

返回值

string

initialize() ¶ public

initialize(): void

CakePHP 在执行命令之前调用的钩子方法。

覆盖此方法并实现昂贵的/重要的设置步骤，这些步骤不应该在每次命令运行时执行。此方法将在选项和参数被验证和处理之前调用。

返回值

void

outputPaths() ¶ protected

outputPaths(Cake\Console\ConsoleIo $io): void

输出相关路径（如果已定义）。

参数

Cake\Console\ConsoleIo $io: IO 对象。

返回值

void

run() ¶ public

run(array $argv, Cake\Console\ConsoleIo $io): int|null

运行命令。

参数

array $argv
Cake\Console\ConsoleIo $io

返回值

int|null

setCommandCollection() ¶ public

setCommandCollection(Cake\Console\CommandCollection $commands): void

设置正在使用的命令集合。

参数

Cake\Console\CommandCollection $commands

返回值

void

setEventManager() ¶ public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

返回此对象的 Cake\Event\EventManagerInterface 实例。

您可以使用此实例向对象事件注册任何新的侦听器或回调，或者创建您自己的事件并根据需要触发它们。

参数

Cake\Event\EventManagerInterface $eventManager: 要设置的事件管理器

返回值

$this

setName() ¶ public

setName(string $name): $this

设置此命令在集合中使用的名称。

通常由 CommandCollection 在添加命令时调用。需要在名称中至少有一个空格，以便可以计算出根命令。

参数

string $name

返回值

$this

setOutputLevel() ¶ protected

setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

根据参数设置输出级别。

参数

Cake\Console\Arguments $args: 命令参数。
Cake\Console\ConsoleIo $io: 控制台输入输出

返回值

void

属性详情

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ protected

此对象用于分派内部事件的 Cake\Event\EventManager 实例。

类型

Cake\Event\EventManagerInterface|null

`$commands` ¶ protected

用于获取帮助的命令集合。

类型

Cake\Console\CommandCollection

`$name` ¶ protected

此命令的名称。

类型

string

命名空间

类 HelpCommand

常量

属性摘要

方法摘要

abort() public

asText() protected

asXml() protected

buildOptionParser() protected

defaultName() public static

dispatchEvent() public

displayHelp() protected

execute() public

executeCommand() public

getDescription() public static

getEventManager() public

getName() public

getOptionParser() public

getRootName() public

getShortestName() protected

initialize() public

outputPaths() protected

run() public

setCommandCollection() public

setEventManager() public

setName() public

setOutputLevel() protected

方法详情

abort() ¶ public

参数

返回值

抛出

asText() ¶ protected

参数

返回值

asXml() ¶ protected

参数

返回值

buildOptionParser() ¶ protected

参数

返回值

defaultName() ¶ public static

返回值

dispatchEvent() ¶ public

参数

返回值

displayHelp() ¶ protected

参数

返回值

execute() ¶ public

参数

返回值

executeCommand() ¶ public

参数

返回值

getDescription() ¶ public static

返回值

getEventManager() ¶ public

返回值

getName() ¶ public

返回值

getOptionParser() ¶ public

返回值

抛出

getRootName() ¶ public

返回值

getShortestName() ¶ protected

参数

返回值

initialize() ¶ public

返回值

outputPaths() ¶ protected

参数

返回值

run() ¶ public

参数

返回值

setCommandCollection() ¶ public

参数

返回值

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$commands` ¶ protected

`$name` ¶ protected