类 RoutesCheckCommand

提供用于测试路由的交互式 CLI 工具。

命名空间: Cake\Command

常量

int

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

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

属性摘要

$_eventClass protected

string

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

Cake\Event\EventManagerInterface|null

Cake\Event\EventManager 的实例，该对象用于调度内部事件。
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

表定位器实例
$defaultTable protected

string|null

此对象的默认表别名。
$name protected

string

此命令的名称。

方法摘要

abort() public

使用 StopException 中止当前进程。
buildOptionParser() public

获取选项解析器。
defaultName() public static

获取命令名称。
dispatchEvent() public

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

输出帮助内容
execute() public

显示应用程序中的所有路由
executeCommand() public

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

获取表实例的便捷方法。
getDescription() public static

获取命令描述。
getEventManager() public

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

获取命令名称。
getOptionParser() public

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

获取根命令名称。
getTableLocator() public

获取表定位器。
initialize() public

在命令即将执行时由 CakePHP 调用的钩子方法。
log() public

向 Log 写入消息的便捷方法。有关写入日志的更多信息，请参阅 Log::write()。
run() public

运行命令。
setEventManager() public

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

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

根据参数设置输出级别。
setTableLocator() public

设置表定位器。

方法详情

abort() ¶ public

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

使用 StopException 中止当前进程。

参数

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

返回值

never

抛出

Cake\Console\Exception\StopException

buildOptionParser() ¶ public

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: 控制台 io

返回值

void

execute() ¶ public

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

显示应用程序中的所有路由

参数

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

返回值

int|null

抛出

JsonException

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

fetchTable() ¶ public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

获取表实例的便捷方法。

参数

string|null $alias optional: 您要获取的别名。应使用驼峰式命名法。如果为 null，则使用 $defaultTable 属性的值。
array<string, mixed> $options optional: 您要使用该表构建的选项。如果表已加载，则注册选项将被忽略。

返回值

Cake\ORM\Table

抛出

Cake\Core\Exception\CakeException
如果 `$alias` 参数和 `$defaultTable` 属性都为 `null`。

另请参阅

\Cake\ORM\TableLocator::get()

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

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

获取表定位器。

返回值

Cake\ORM\Locator\LocatorInterface

initialize() ¶ public

initialize(): void

在命令即将执行时由 CakePHP 调用的钩子方法。

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

返回值

void

log() ¶ public

log(Stringable|string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool

向 Log 写入消息的便捷方法。有关写入日志的更多信息，请参阅 Log::write()。

参数

Stringable|string $message: 日志消息。
string|int $level 可选: 错误级别。
array|string $context 可选: 与此消息相关的其他日志数据。

返回值

bool

run() ¶ public

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

运行命令。

参数

array $argv
Cake\Console\ConsoleIo $io

返回值

int|null

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: 控制台 io

返回值

void

setTableLocator() ¶ public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

设置表定位器。

参数

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface 实例。

返回值

$this

属性详情

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ protected

Cake\Event\EventManager 的实例，该对象用于调度内部事件。

类型

Cake\Event\EventManagerInterface|null

`$_tableLocator` ¶ protected

表定位器实例

类型

Cake\ORM\Locator\LocatorInterface|null

`$defaultTable` ¶ protected

此对象的默认表别名。

类型

string|null

`$name` ¶ protected

此命令的名称。

类型

string

命名空间

类 RoutesCheckCommand

常量

属性摘要

方法摘要

abort() public

buildOptionParser() public

defaultName() public static

dispatchEvent() public

displayHelp() protected

execute() public

executeCommand() public

fetchTable() public

getDescription() public static

getEventManager() public

getName() public

getOptionParser() public

getRootName() public

getTableLocator() public

initialize() public

log() public

run() public

setEventManager() public

setName() public

setOutputLevel() protected

setTableLocator() public

方法详情

abort() ¶ public

参数

返回值

抛出

buildOptionParser() ¶ public

参数

返回值

defaultName() ¶ public static

返回值

dispatchEvent() ¶ public

参数

返回值

displayHelp() ¶ protected

参数

返回值

execute() ¶ public

参数

返回值

抛出

executeCommand() ¶ public

参数

返回值

fetchTable() ¶ public

参数

返回值

抛出

另请参阅

getDescription() ¶ public static

返回值

getEventManager() ¶ public

返回值

getName() ¶ public

返回值

getOptionParser() ¶ public

返回值

抛出

getRootName() ¶ public

返回值

getTableLocator() ¶ public

返回值

initialize() ¶ public

返回值

log() ¶ public

参数

返回值

run() ¶ public

参数

返回值

setEventManager() ¶ public

参数

返回值

setName() ¶ public

参数

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$_tableLocator` ¶ protected

`$defaultTable` ¶ protected

`$name` ¶ protected