类 PluginAssetsCopyCommand

将插件资产复制到应用程序的 webroot 的命令。

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

表格定位器实例
$args protected

Cake\Console\Arguments

参数
$defaultTable protected

string|null

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

Cake\Console\ConsoleIo

控制台 IO
$name protected

string

此命令的名称。

方法摘要

_copyDirectory() protected

复制目录
_createDirectory() protected

创建目录
_createSymlink() protected

创建符号链接
_list() protected

获取要处理的插件列表。没有 webroot 目录的插件将被跳过。
_process() protected

处理插件
_remove() protected

删除文件夹/符号链接。
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::write()。
run() public

运行命令。
setEventManager() public

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

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

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

设置表格定位器。

方法详情

_copyDirectory() ¶ protected

_copyDirectory(string $source, string $destination): bool

复制目录

参数

string $source: 源目录
string $destination: 目标目录

bool

_createDirectory() ¶ protected

_createDirectory(string $dir): bool

创建目录

参数

string $dir: 目录名称

bool

_createSymlink() ¶ protected

_createSymlink(string $target, string $link): bool

创建符号链接

参数

string $target: 目标目录
string $link: 链接名称

bool

_list() ¶ protected

_list(string|null $name = null): array<string, mixed>

获取要处理的插件列表。没有 webroot 目录的插件将被跳过。

参数

string|null $name optional: 要为其创建资产符号链接的插件名称。如果为 null，将处理所有插件。

array<string, mixed>

_process() ¶ protected

_process(array<string, mixed> $plugins, bool $copy = false, bool $overwrite = false): void

处理插件

参数

array<string, mixed> $plugins: 要处理的插件列表
bool $copy optional: 强制复制模式。默认 false。
bool $overwrite optional: 覆盖现有文件。

void

_remove() ¶ protected

_remove(array<string, mixed> $config): bool

删除文件夹/符号链接。

参数

array<string, mixed> $config: 插件配置。

bool

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

执行命令

将插件资产复制到应用程序的 webroot。对于供应商命名空间的插件，如果需要，将创建供应商名称的父文件夹。

参数

Cake\Console\Arguments $args: 命令参数。
Cake\Console\ConsoleIo $io: 控制台 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

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::write()。

参数

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

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: 要设置的 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

`$args` ¶ protected

参数

类型

Cake\Console\Arguments

`$defaultTable` ¶ protected

此对象的默认表格别名。

类型

string|null

`$io` ¶ protected

控制台 IO

类型

Cake\Console\ConsoleIo

`$name` ¶ protected

此命令的名称。

类型

string

命名空间

类 PluginAssetsCopyCommand

常量

属性摘要

方法摘要

_copyDirectory() protected

_createDirectory() protected

_createSymlink() protected

_list() protected

_process() protected

_remove() protected

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

方法详情

_copyDirectory() ¶ protected

参数

返回

_createDirectory() ¶ protected

参数

返回

_createSymlink() ¶ protected

参数

返回

_list() ¶ protected

参数

返回

_process() ¶ protected

参数

返回

_remove() ¶ protected

参数

返回

abort() ¶ public

参数

返回

抛出

buildOptionParser() ¶ public

参数

返回

defaultName() ¶ public static

返回

dispatchEvent() ¶ public

参数

返回

displayHelp() ¶ protected

参数

返回

execute() ¶ public

参数

返回

executeCommand() ¶ public

参数

返回

fetchTable() ¶ public

参数

返回

抛出

另请参阅

getDescription() ¶ public static

返回

getEventManager() ¶ public

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$_tableLocator` ¶ protected

`$args` ¶ protected

`$defaultTable` ¶ protected

`$io` ¶ protected

`$name` ¶ protected