Класс I18nExtractCommand

Экстрактор строк языка

Пространство имён: Cake\Command

Константы

int

CODE_ERROR
```
1
```
Значение по умолчанию для кода ошибки
int

CODE_SUCCESS
```
0
```
Значение по умолчанию для кода успеха

Краткое описание свойств

$_countMarkerError protected

int

Количество ошибок маркеров, найденных
$_exclude protected

string[]

Массив директорий для исключения.
$_extractCore protected

bool

Указывает, должен ли этот вызов извлекать сообщения CakePHP Lib
$_file protected

string

Обрабатываемый в данный момент файл
$_files protected

string[]

Файлы, из которых необходимо извлечь текст
$_markerError protected

bool

Отображать ошибки маркера, если true
$_merge protected

bool

Объединить все строки доменов в файл default.pot
$_modelFactories protected

(callableCake\Datasource\Locator\LocatorInterface)[]

Список переопределённых функций фабрики моделей.
$_modelType protected

string

Тип модели для использования.
$_output protected

string

Путь назначения
$_paths protected

string[]

Пути для поиска строк
$_relativePaths protected

bool

Использовать относительные пути в файлах pot вместо полных путей
$_storage protected

array

Содержит весь контент, ожидающий записи
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локализации таблиц
$_tokens protected

array

Извлечённые токены
$_translations protected

array

Извлечённые строки, индексированные по домену.
$modelClass protected

string|null

Название основного класса модели этого объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.
$name protected

string

Название этой команды.

Краткое описание методов

__construct() public

Конструктор
_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

Поиск файлов, которые могут содержать строки, подлежащие переводу
_setModelClass() protected

Установить свойство modelClass на основе соглашений.
_store() protected

Подготовить файл для сохранения
_writeFiles() protected

Записать файлы, которые нужно сохранить
_writeHeader() protected

Сгенерировать заголовок шаблона перевода
abort() public

Прервать текущий процесс с исключением StopException.
buildOptionParser() public

Получает экземпляр анализатора опций и настраивает его.
checkUnchanged() protected

Проверить, совпадают ли старый и новый выходы, т.е. неизменённые
defaultName() public static

Получить имя команды.
displayHelp() protected

Вывод содержимого справки
execute() public

Выполнить команду
executeCommand() public

Выполнить другую команду с указанным набором аргументов.
getModelType() public

Получить тип модели, который будет использоваться этим классом
getName() public

Получить имя команды.
getOptionParser() public

Получить анализатор опций.
getRootName() public

Получить имя корневой команды.
getTableLocator() public

Получает локатор таблицы.
initialize() public

Метод обратного вызова, вызываемый CakePHP, когда команда должна быть выполнена.
loadModel() public

Загружает и создаёт объекты репозитория, необходимые этому объекту
log() public

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.
modelFactory() public

Переопределить существующую вызываемую функцию для генерации репозиториев заданного типа.
run() public

Выполнить команду.
setModelType() public

Установить тип модели, который будет использоваться этим классом
setName() public

Установить имя, которое эта команда использует в коллекции.
setOutputLevel() protected

Установить уровень вывода на основе аргументов.
setTableLocator() public

Устанавливает локатор таблицы.

END_OF_DOCUMENT_MARKER

Подробное описание методов

__construct() public

__construct()

Конструктор

По умолчанию CakePHP будет создавать объекты команд при построении CommandCollection для вашего приложения.

_addTranslation() protected

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

Добавление перевода в внутреннее свойство переводов

Обрабатывает дублирующие переводы

Параметры

string $domain: Домен
string $msgid: Строка сообщения
array $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: Фактическая позиция в массиве токенов
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

_setModelClass() protected

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе соглашений.

Если свойство уже установлено, оно не будет перезаписано.

Параметры

string $name: Имя класса.

Возвращает

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: Консольный ввод-вывод

Возвращает

void

_writeHeader() protected

_writeHeader(string $domain): string

Строит заголовок шаблона перевода

Параметры

string $domain: Домен

Возвращает

string

abort() public

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

Прерывание текущего процесса с помощью StopException.

Параметры

int $code optional: Код завершения для использования.

Возвращает

void

Исключения

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

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(stringCake\Console\CommandInterface $command, array $args = [], Cake\Console\ConsoleIo $io = null): int|null

Выполнить другую команду с заданным набором аргументов.

Если вы используете строковое имя команды, зависимости этой команды не будут разрешены с помощью контейнера приложения. Вместо этого вам нужно передать команду как объект со всеми ее зависимостями.

Параметры

stringCake\Console\CommandInterface $command: Имя класса команды или экземпляр команды.
array $args optional: Аргументы для вызова команды.
Cake\Console\ConsoleIo $io optional: Экземпляр ConsoleIo для использования при выполнении команды.

Возвращает

int|null

getModelType() public

getModelType(): string

Получить тип модели, используемый этим классом

Возвращает

string

getName() public

getName(): string

Получить имя команды.

Возвращает

string

getOptionParser() public

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить парсер опций.

Вы можете переопределить buildOptionParser(), чтобы определить свои опции и аргументы.

initialize(): void

Метод-обработчик, вызываемый CakePHP, когда команда собирается быть выполнена.

Переопределите этот метод и реализуйте дорогостоящие/важные этапы настройки, которые не должны выполняться при каждом запуске команды. Этот метод будет вызываться до валидации и обработки опций и аргументов.

Возвращает

void

loadModel() public

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

Загружает и создает объекты репозитория, необходимые для этого объекта

Обычно используется для загрузки объектов таблицы ORM по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

string|null $modelClass optional: Имя класса модели для загрузки. По умолчанию равно $this->modelClass. Имя может быть алиасом, например, 'Post' или полным именем класса, например App\Model\Table\PostsTable::class.
string|null $modelType optional: Тип репозитория для загрузки. По умолчанию равен значению getModelType().

Возвращает

Cake\Datasource\RepositoryInterface

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
UnexpectedValueException
Если аргумент $modelClass не указан, а свойство ModelAwareTrait::$modelClass пустое.

log() public

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

Удобный метод для записи сообщения в журнал. Подробнее о записи в журналы см. Log::write().

Параметры

string $message: Сообщение для журнала.
int|string $level optional: Уровень ошибки.
string|array $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

Переопределить существующую вызываемую функцию для генерации репозиториев заданного типа.

Параметры

string $type: Имя типа репозитория, для которого предназначена фабричная функция.
callableCake\Datasource\Locator\LocatorInterface $factory: Фабричная функция, используемая для создания экземпляров.

Возвращает

void

run() public

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

Выполнить команду.

Параметры

array $argv
Cake\Console\ConsoleIo $io

Возвращает

int|null

setModelType() public

setModelType(string $modelType): $this

Установить тип модели, который будет использоваться этим классом

Параметры

string $modelType: Тип модели

Возвращает

$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

setTableLocator() public

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

Устанавливает локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращает

$this

`$name` protected

Имя этой команды.

Тип

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Command.I18nExtractCommand.html