Spec-Zone.ru › CakePHP 4.4

Класс I18nExtractCommand

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

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

Константы

  • int
    CODE_ERROR 
    1

    Значение ошибки по умолчанию

  • int
    CODE_SUCCESS 
    0

    Значение успеха по умолчанию

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

  • $_countMarkerError protected
    int

    Количество ошибок маркера, обнаруженных

  • $_exclude protected
    array<string>

    Массив каталогов для исключения.

  • $_extractCore protected
    bool

    Указывает, следует ли извлекать сообщения CakePHP Lib

  • $_file protected
    string

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

  • $_files protected
    array<string>

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

  • $_markerError protected
    bool

    Отображать ли ошибки маркера(ов) (если true)

  • $_merge protected
    bool

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

  • $_modelFactories protected
    array<callableCake\Datasource\Locator\LocatorInterface>

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

  • $_modelType protected
    string

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

  • $_output protected
    string

    Путь назначения

  • $_paths protected
    array<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

    Псевдоним таблицы по умолчанию для данного объекта.

  • $modelClass protected deprecated
    string|null

    Имя основного класса модели для данного объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.

  • $name protected
    string

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

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

  • __construct() public

    Конструктор

  • _addTranslation() protected

    Добавить перевод в свойство internal translations

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

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

  • fetchTable() public

    Удобный метод для получения экземпляра таблицы.

  • getDescription() public static

    Получить описание команды.

  • getModelType() public

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

  • getName() public

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

  • getOptionParser() public

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

  • getRootName() public

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

  • getTableLocator() public

    Получить локатор таблицы.

  • initialize() public

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

  • loadModel() public deprecated

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

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

Имя псевдонима, которое вы хотите получить. Должно быть в формате CamelCase. Если 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

getModelType() public 

getModelType(): string

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

Возвращает

string

getName() public 

getName(): string

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

Возвращает

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

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

Можно переопределить buildOptionParser() для определения опций и аргументов.

Возвращает

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При некорректном парсере

getRootName() public 

getRootName(): string

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

Возвращает

string

getTableLocator() public 

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получить локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

initialize() public 

initialize(): void

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

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

Возвращает

void

loadModel() public 

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

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

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

Если поставщик репозитория не возвращает объект, будет выброшено исключение 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, string|int $level = LogLevel::ERROR, array|string $context = []): bool

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

Параметры

string $message

Сообщение журнала.

string|int $level optional

Уровень ошибки.

array|string $context optional

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public 

modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void

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

Параметры

string $type

Имя типа репозитория, для которого предназначена функция фабрики.

Cake\Datasource\Locator\LocatorInterface|callable $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

Подробности свойств

$_countMarkerError protected

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

Тип

int

$_exclude protected

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

Тип

array<string>

$_extractCore protected

Указывает, нужно ли извлекать сообщения CakePHP Lib.

Тип

bool

$_file protected

Обрабатываемый в данный момент файл.

Тип

string

$_files protected

Файлы, из которых нужно извлечь данные.

Тип

array<string>

$_markerError protected

Отображать ошибки маркера(ов), если true.

Тип

bool

$_merge protected

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

Тип

bool

$_modelFactories protected

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

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

$_modelType protected

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

Тип

string

$_output protected

Путь назначения.

Тип

string

$_paths protected

Пути для поиска строк.

Тип

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

$modelClass protected deprecated

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

Пример: Для объекта с именем «Комментарии», modelClass будет «Комментарии». Классы плагинов должны использовать имена в формате Plugin.Comments для правильной загрузки моделей из соответствующего плагина.

Используйте пустую строку, чтобы не использовать автоматическую загрузку для этого объекта. Нулевое значение автоматически определяет класс на основе имени контроллера.

Тип

string|null

$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.4/class-Cake.Command.I18nExtractCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API