类 I18nExtractCommand

语言字符串提取器

命名空间： Cake\Command

常量

int

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

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

属性汇总

$_countMarkerError protected

int

计算找到的标记错误数量
$_eventClass protected

string

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

Cake\Event\EventManagerInterface|null

Cake\Event\EventManager 的实例，此对象使用该实例来调度内部事件。
$_exclude protected

list<string>

要排除的目录数组。
$_extractCore protected

bool

保存此调用是否应该提取 CakePHP Lib 消息
$_file protected

string

当前正在处理的文件
$_files protected

list<string>

要从中提取的文件
$_markerError protected

bool

如果为 true，则显示标记错误
$_merge protected

bool

将所有域字符串合并到 default.pot 文件中
$_output protected

string

目标路径
$_paths protected

list<string>

在查找字符串时要使用的路径
$_storage protected

array<string, mixed>

包含所有等待写入的内容
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

表定位器实例
$_tokens protected

array

提取的令牌
$_translations protected

array<string, mixed>

按域索引的提取字符串。
$defaultTable protected

string|null

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

string

此命令的名称。

方法汇总

_addTranslation() protected

将翻译添加到内部翻译属性中
_buildFiles() protected

从获得的字符串构建翻译模板文件内容
_extract() protected

提取文本
_extractTokens() protected

从所有要处理的文件中提取令牌
_formatString() protected

格式化要添加为可翻译字符串的字符串
_getPaths() protected

与用户交互并获取路径选择的方法。
_getStrings() protected

从当前位置获取字符串
_isExtractingApp() protected

返回此执行是否仅从 APP 常量所代表的文件夹中的目录提取字符串，即此任务正在从同一应用程序提取字符串。
_isPathUsable() protected

检查给定路径是否可用于写入。
_markerError() protected

指示已处理文件中存在无效标记
_parse() protected

解析令牌
_searchFiles() protected

搜索可能包含可翻译字符串的文件
_store() protected

准备要存储的文件
_writeFiles() protected

写入需要存储的文件
_writeHeader() protected

构建翻译模板头
abort() public

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

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

检查旧输出和新输出是否相同，因此未更改
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

设置表定位器。

方法详细说明

_addTranslation() ¶ protected

_addTranslation(string $domain, string $msgid, array<string, mixed> $details = []): void

将翻译添加到内部翻译属性中

处理重复翻译

参数

string $domain: 域
string $msgid: 消息字符串
array<string, mixed> $details optional: 上下文和复数形式（如果有），文件和行引用

返回值

void

_buildFiles() ¶ protected

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

从获得的字符串构建翻译模板文件内容

参数

Cake\Console\Arguments $args: 控制台参数

返回值

void

_extract() ¶ protected

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

提取文本

参数

Cake\Console\Arguments $args: Arguments 实例
Cake\Console\ConsoleIo $io: io 实例

返回值

void

_extractTokens() ¶ protected

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

从所有要处理的文件中提取令牌

参数

Cake\Console\Arguments $args: io 实例
Cake\Console\ConsoleIo $io: io 实例

返回值

void

_formatString() ¶ protected

_formatString(string $string): string

格式化要添加为可翻译字符串的字符串

参数

string $string: 要格式化的字符串

返回值

string

_getPaths() ¶ protected

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

与用户交互并获取路径选择的方法。

参数

Cake\Console\ConsoleIo $io: io 实例。

返回值

void

_getStrings() ¶ protected

_getStrings(int $position, int $target): array

从当前位置获取字符串

参数

int $position: tokens 数组上的实际位置
int $target: 要提取的字符串数量

返回值

array

_isExtractingApp() ¶ protected

_isExtractingApp(): bool

返回此执行是否仅从 APP 常量所代表的文件夹中的目录提取字符串，即此任务正在从同一应用程序提取字符串。

返回值

bool

_isPathUsable() ¶ protected

_isPathUsable(string $path): bool

检查给定路径是否可用于写入。

参数

string $path: 文件夹路径

返回值

bool

_markerError() ¶ protected

_markerError(Cake\Console\ConsoleIo $io, string $file, int $line, string $marker, int $count): void

指示已处理文件中存在无效标记

参数

Cake\Console\ConsoleIo $io: io 实例。
string $file: 无效标记所在的文
int $line: 行号
string $marker: 找到的标记
int $count: 计数

返回值

void

_parse() ¶ protected

_parse(Cake\Console\ConsoleIo $io, string $functionName, array $map): void

解析令牌

参数

Cake\Console\ConsoleIo $io: io 实例
string $functionName: 指示可翻译字符串的函数名（例如：'__')
array $map: 包含它将查找哪些变量的数组（例如：domain，singular，plural）

返回值

void

_searchFiles() ¶ protected

_searchFiles(): void

搜索可能包含可翻译字符串的文件

返回值

void

_store() ¶ protected

_store(string $domain, string $header, string $sentence): void

准备要存储的文件

参数

string $domain: 域
string $header: 标题内容。
string $sentence: 要存储的句子。

返回值

void

_writeFiles() ¶ protected

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

写入需要存储的文件

参数

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

返回值

void

_writeHeader() ¶ protected

_writeHeader(string $domain): string

构建翻译模板头

参数

string $domain: 领域

返回值

string

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

checkUnchanged() ¶ protected

checkUnchanged(string $oldFile, int $headerLength, string $newFileContent): bool

检查旧输出和新输出是否相同，因此未更改

比较旧文件和新文件的 sha1 哈希值（不含标题）。

参数

string $oldFile: 现有文件。
int $headerLength: 文件标题的长度（以字节为单位）。
string $newFileContent: 新文件的内容。

返回值

bool

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

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() 来定义您的选项和参数。

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 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

类 I18nExtractCommand

常量

属性汇总

方法汇总

_addTranslation() protected

_buildFiles() protected

_extract() protected

_extractTokens() protected

_formatString() protected

_getPaths() protected

_getStrings() protected

_isExtractingApp() protected

_isPathUsable() protected

_markerError() protected

_parse() protected

_searchFiles() protected

_store() protected

_writeFiles() protected

_writeHeader() protected

abort() public

buildOptionParser() public

checkUnchanged() protected

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

方法详细说明

_addTranslation() ¶ protected

参数

返回值

_buildFiles() ¶ protected

参数

返回值

_extract() ¶ protected

参数

返回值

_extractTokens() ¶ protected

参数

返回值

_formatString() ¶ protected

参数

返回值

_getPaths() ¶ protected

参数

返回值

_getStrings() ¶ protected

参数

返回值

_isExtractingApp() ¶ protected

返回值

_isPathUsable() ¶ protected

参数

返回值

_markerError() ¶ protected

参数

返回值

_parse() ¶ protected

参数

返回值

_searchFiles() ¶ protected

返回值

_store() ¶ protected

参数

返回值