类 JobCommand

命名空间： Cake\Queue\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

表定位器实例
$connection public

string
$defaultTable protected

string|null

此对象的默认表别名。
$force public

bool
$name protected

string

此命令的名称。
$pathFragment public

string

附加到插件/应用程序路径的路径片段。
$plugin public

string
$theme public

string|null

方法摘要

_camelize() protected

创建 $name 的骆驼式版本
_entityName() protected

为指定名称创建正确的实体名称（单数）
_fixtureName() protected

创建夹具名称
_getBakeThemes() protected

获取可用的烘焙主题
_getName() protected

处理插件前缀和类名的拆分。
_modelKey() protected

为关联创建正确的下划线模型键
_modelNameFromKey() protected

从外键创建正确的模型名称
_pluginNamespace() protected

返回插件的命名空间
_pluginPath() protected

查找插件的正确路径。扫描 $pluginPaths 以查找您想要的插件。
_pluralHumanName() protected

创建视图中使用的复数人名
_setCommonOptions() protected

设置所有烘焙任务使用的通用选项。
_singularHumanName() protected

创建视图中使用的单数人名
_singularName() protected

创建用于视图的单数名称。
_variableName() protected

为视图创建复数变量名
abort() public

使用 StopException 停止当前进程。
bake() protected

生成类存根
bakeTest() public

生成测试用例。
buildOptionParser() public

获取选项解析器实例并配置它。
createTemplateRenderer() public

使用设置的主题创建 TemplateRenderer 的新实例。
defaultName() public static

获取命令名称。
deleteEmptyFile() protected

删除给定路径中的空文件
dispatchEvent() public

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

输出帮助内容
execute() public

执行命令。
executeCommand() public

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

将常用/频繁使用的参数和选项拉入属性，以便方法签名更简单。
fetchTable() public

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

获取生成的对象的文件名，不包括前导路径。
getDescription() public static

获取命令描述。
getEventManager() public

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

获取命令名称。
getOptionParser() public

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

获取输出路径。检查 plugin 属性并返回正确的路径。
getPrefix() protected

获取前缀名称。
getRootName() public

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

获取表定位器。
getTemplatePath() public

获取应用程序或插件的模板路径。
initialize() public

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

检查列名是否有效。
log() public

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

获取生成的对象的名称。
parseFile() protected

如果文件存在，则解析文件。
run() public

运行命令。
setEventManager() public

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

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

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

设置表定位器。
template() public

获取模板名称。
templateData() public

获取模板数据。
writeFile() protected

将文件内容写入路径，并提示用户选择文件是否存在的选项。

方法详细信息

_camelize() ¶ protected

_camelize(string $name): string

创建 $name 的骆驼式版本

参数

string $name: 名称

string

_entityName() ¶ protected

_entityName(string $name): string

为指定名称创建正确的实体名称（单数）

参数

string $name: 名称

string

_fixtureName() ¶ protected

_fixtureName(string $name): string

创建夹具名称

参数

string $name: 模型类名

string

_getBakeThemes() ¶ protected

_getBakeThemes(): array

获取可用的烘焙主题

array

_getName() ¶ protected

_getName(string $name): string

处理插件前缀和类名的拆分。

设置 plugin 参数和 plugin 属性。

参数

string $name: 要拆分的名称。

string

_modelKey() ¶ protected

_modelKey(string $name): string

为关联创建正确的下划线模型键

如果输入包含点，则假设右侧是真实的表名。

参数

string $name: 模型类名

string

_modelNameFromKey() ¶ protected

_modelNameFromKey(string $key): string

从外键创建正确的模型名称

参数

string $key: 外键

string

_pluginNamespace() ¶ protected

_pluginNamespace(string $pluginName): string

返回插件的命名空间

参数

string $pluginName: 插件名称

string

_pluginPath() ¶ protected

_pluginPath(string $pluginName): string

查找插件的正确路径。扫描 $pluginPaths 以查找您想要的插件。

参数

string $pluginName: 您想要的插件的名称，例如 DebugKit

string

_pluralHumanName() ¶ protected

_pluralHumanName(string $name): string

创建视图中使用的复数人名

参数

string $name: 控制器名称

string

_setCommonOptions() ¶ protected

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

设置所有烘焙任务使用的通用选项。

参数

Cake\Console\ConsoleOptionParser $parser: 选项解析器。

Cake\Console\ConsoleOptionParser

_singularHumanName() ¶ protected

_singularHumanName(string $name): string

创建视图中使用的单数人名

参数

string $name: 控制器名称

string

_singularName() ¶ protected

_singularName(string $name): string

创建用于视图的单数名称。

参数

string $name: 要使用的名称

string

_variableName() ¶ protected

_variableName(string $name): string

为视图创建复数变量名

参数

string $name: 要使用的名称

string

abort() ¶ public

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

使用 StopException 停止当前进程。

参数

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

从不

抛出

Cake\Console\Exception\StopException

bake() ¶ 受保护

bake(string $name, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

生成类存根

参数

string $name: 类名
Cake\Console\Arguments $args: 控制台参数
Cake\Console\ConsoleIo $io: 控制台 I/O

void

bakeTest() ¶ 公共

bakeTest(string $className, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

生成测试用例。

参数

string $className: 要为其烘焙测试的类。
Cake\Console\Arguments $args: 控制台参数
Cake\Console\ConsoleIo $io: 控制台 I/O

void

buildOptionParser() ¶ 公共

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

获取选项解析器实例并配置它。

参数

Cake\Console\ConsoleOptionParser $parser: 要更新的解析器。

Cake\Console\ConsoleOptionParser

createTemplateRenderer() ¶ 公共

createTemplateRenderer(): Bake\Utility\TemplateRenderer

使用设置的主题创建 TemplateRenderer 的新实例。

Bake\Utility\TemplateRenderer

defaultName() ¶ 公共静态

defaultName(): string

获取命令名称。

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

string

deleteEmptyFile() ¶ 受保护

deleteEmptyFile(string $path, Cake\Console\ConsoleIo $io): void

删除给定路径中的空文件

参数

string $path: 包含“空”文件的文件夹的路径。
Cake\Console\ConsoleIo $io: 用于删除文件的 ConsoleIo。

void

dispatchEvent() ¶ 公共

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

创建和调度事件的包装器。

返回一个已分派的事件。

参数

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

Cake\Event\EventInterface<TSubject>

displayHelp() ¶ 受保护

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: 控制台 I/O

void

execute() ¶ 公共

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

执行命令。

参数

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

int|null

executeCommand() ¶ 公共

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

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

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

参数

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

int|null

extractCommonProperties() ¶ 受保护

extractCommonProperties(Cake\Console\Arguments $args): void

将常用/频繁使用的参数和选项拉入属性，以便方法签名更简单。

参数

Cake\Console\Arguments $args: 要提取的参数

void

fetchTable() ¶ 公共

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

获取表实例的便捷方法。

参数

string|null $alias 可选: 您想要获取的别名。应采用 CamelCase 格式。如果为 null，则使用 $defaultTable 属性的值。
array<string, mixed> $options 可选: 您想要使用它构建表的选项。如果表已加载，则注册表选项将被忽略。

Cake\ORM\Table

抛出

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

另请参阅

\Cake\ORM\TableLocator::get()

fileName() ¶ 公共

fileName(string $name): string

获取生成的对象的文件名，不包括前导路径。

参数

string $name

string

getDescription() ¶ 公共静态

getDescription(): string

获取命令描述。

string

getEventManager() ¶ 公共

getEventManager(): Cake\Event\EventManagerInterface

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

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

Cake\Event\EventManagerInterface

getName() ¶ 公共

getName(): string

获取命令名称。

string

getOptionParser() ¶ 公共

getOptionParser(): Cake\Console\ConsoleOptionParser

获取选项解析器。

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

Cake\Console\ConsoleOptionParser

抛出

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

getPath() ¶ 公共

getPath(Cake\Console\Arguments $args): string

获取输出路径。检查 plugin 属性并返回正确的路径。

参数

Cake\Console\Arguments $args: 用于读取前缀选项的参数实例。

string

getPrefix() ¶ 受保护

getPrefix(Cake\Console\Arguments $args): string

获取前缀名称。

处理前缀路径中每个命名空间的骆驼式命名。

参数

Cake\Console\Arguments $args: 用于读取前缀选项的参数实例。

string

getRootName() ¶ 公共

getRootName(): string

获取根命令名称。

string

getTableLocator() ¶ 公共

getTableLocator(): Cake\ORM\Locator\LocatorInterface

获取表定位器。

Cake\ORM\Locator\LocatorInterface

getTemplatePath() ¶ 公共

getTemplatePath(Cake\Console\Arguments $args, string|null $container = null): string

获取应用程序或插件的模板路径。

参数

Cake\Console\Arguments $args: 用于读取前缀选项的参数实例。
string|null $container 可选: 模板目录中的容器目录。

string

initialize() ¶ 公共

initialize(): void

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

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

void

isValidColumnName() ¶ 受保护

isValidColumnName(string $name): bool

检查列名是否有效。

这里使用的正则表达式基本上表示

列名必须以 ASCII 字符（小写或大写）或下划线开头，并且
其他字符可以是小写或大写 ASCII 字符、数字或下划线。

参数

string $name: 列的名称。

bool

log() ¶ 公共

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

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

参数

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

bool

name() ¶ 公共

name(): string

获取生成的对象的名称。

string

parseFile() ¶ 受保护

parseFile(string $path): Bake\CodeGen\ParsedFile|null

如果文件存在，则解析文件。

参数

string $path: 文件路径

Bake\CodeGen\ParsedFile|null

run() ¶ 公共

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

运行命令。

参数

array $argv
Cake\Console\ConsoleIo $io

int|null

setEventManager() ¶ 公共

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

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

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

参数

Cake\Event\EventManagerInterface $eventManager: 要设置的 eventManager

$this

setName() ¶ 公共

setName(string $name): $this

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

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

参数

string $name

$this

setOutputLevel() ¶ 受保护

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

根据 Arguments 设置输出级别。

参数

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

void

setTableLocator() ¶ 公共

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

设置表定位器。

参数

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

$this

template() ¶ 公共

template(): string

获取模板名称。

string

templateData() ¶ 公共

templateData(Cake\Console\Arguments $arguments): array

获取模板数据。

参数

Cake\Console\Arguments $arguments

array

writeFile() ¶ 受保护

writeFile(Cake\Console\ConsoleIo $io, string $path, string $contents, bool $forceOverwrite = false, bool $skipIfUnchanged = true): bool

将文件内容写入路径，并提示用户选择文件是否存在的选项。

参数

Cake\Console\ConsoleIo $io: 控制台 I/O
string $path: 要创建文件的路径
string $contents: 要放入文件的内容
bool $forceOverwrite 可选: 是否应在不提示用户的情况下覆盖文件
bool $skipIfUnchanged 可选: 如果内容与现有文件匹配，则跳过写入输出

bool

抛出

Cake\Console\Exception\StopException
当 `q` 作为是否应覆盖文件的答案给出时。

属性详细信息

`$_eventClass` ¶ 受保护

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ 受保护

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

类型

Cake\Event\EventManagerInterface|null

`$_tableLocator` ¶ 受保护

表定位器实例

类型

Cake\ORM\Locator\LocatorInterface|null

`$connection` ¶ 公共

类型

string

`$defaultTable` ¶ 受保护

此对象的默认表别名。

类型

string|null

`$force` ¶ 公共

类型

bool

`$name` ¶ 受保护

此命令的名称。

类型

string

`$pathFragment` ¶ 公共

附加到插件/应用程序路径的路径片段。

类型

string

`$plugin` ¶ 公共

类型

string

`$theme` ¶ 公共

类型

string|null

命名空间

类 JobCommand

常量

属性摘要

方法摘要

_camelize() protected

_entityName() protected

_fixtureName() protected

_getBakeThemes() protected

_getName() protected

_modelKey() protected

_modelNameFromKey() protected

_pluginNamespace() protected

_pluginPath() protected

_pluralHumanName() protected

_setCommonOptions() protected

_singularHumanName() protected

_singularName() protected

_variableName() protected

abort() public

bake() protected

bakeTest() public

buildOptionParser() public

createTemplateRenderer() public

defaultName() public static

deleteEmptyFile() protected

dispatchEvent() public

displayHelp() protected

execute() public

executeCommand() public

extractCommonProperties() protected

fetchTable() public

fileName() public

getDescription() public static

getEventManager() public

getName() public

getOptionParser() public

getPath() public

getPrefix() protected

getRootName() public

getTableLocator() public

getTemplatePath() public

initialize() public

isValidColumnName() protected

log() public

name() public

parseFile() protected

run() public

setEventManager() public

setName() public

setOutputLevel() protected

setTableLocator() public

template() public

templateData() public

writeFile() protected

方法详细信息

_camelize() ¶ protected

参数

返回

_entityName() ¶ protected

参数

返回

_fixtureName() ¶ protected

参数

返回

_getBakeThemes() ¶ protected

返回

_getName() ¶ protected

参数

返回

_modelKey() ¶ protected

参数

返回

_modelNameFromKey() ¶ protected

参数

返回

_pluginNamespace() ¶ protected

参数

返回

_pluginPath() ¶ protected

defaultName() ¶ 公共静态

getDescription() ¶ 公共静态