Spec-Zone.ru › CakePHP 2.10

Класс ExtractTask

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

AppShell
Extended by ExtractTask
Пакет: Cake\Console\Command\Task
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/Task/ExtractTask.php

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

  • $_exclude protected
    array
    Массив директорий для исключения.
  • $_extractCore protected
    boolean
    Указывает, следует ли извлекать сообщения CakePHP Lib.
  • $_extractValidation protected
    boolean
    Указывает, следует ли извлекать сообщения валидации моделей.
  • $_file protected
    string
    Обрабатываемый в данный момент файл.
  • $_files protected
    array
    Файлы, из которых необходимо извлечь данные.
  • $_merge protected
    boolean
    Объединить все строки доменов и категорий в файл default.pot.
  • $_output protected
    string
    Путь назначения.
  • $_paths protected
    string
    Пути для поиска строк.
  • $_storage protected
    string
    Содержит все данные, ожидающие записи.
  • $_tokens protected
    array
    Извлечённые токены.
  • $_translations protected
    array
    Извлечённые строки, индексированные по категории, домену, msgid и контексту.
  • $_validationDomain protected
    boolean
    Домен строк валидации для использования при извлечении сообщений валидации.

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

  • _addTranslation() protected
    Добавляет перевод в свойство внутренних переводов.
  • _buildFiles() protected
    Создаёт содержимое шаблона файла перевода из полученных строк.
  • _extract() protected
    Извлекает текст.
  • _extractPluginValidationMessages() protected
    Извлекает сообщения валидации из моделей приложения или плагинов.
  • _extractTokens() protected
    Извлекает токены из всех обрабатываемых файлов.
  • _extractValidationMessages() protected

    Ищет модели в приложении и извлекает сообщения валидации, которые нужно добавить в карту переводов

  • _formatString() protected
    Форматирует строку для добавления в качестве переводимой строки.
  • _getPaths() protected
    Метод взаимодействия с пользователем для получения выбора путей.
  • _getStrings() protected
    Получение строк с указанной позиции.
  • _isExtractingApp() protected

    Возвращает, предназначена ли эта операция для извлечения строк только из директорий в папке, представленной константой APP, т.е. этот задача извлекает строки из того же приложения.

  • _isPathUsable() protected
    Проверяет, можно ли использовать заданный путь для записи.
  • _markerError() protected
    Указывает на недопустимый маркер в обработанном файле.
  • _parse() protected
    Обрабатывает токены.
  • _processValidationRules() protected

    Обрабатывает правило валидации для поля и ищет сообщение, которое нужно добавить в карту переводов.

  • _searchFiles() protected
    Поиск файлов, которые могут содержать переводимые строки.
  • _store() protected
    Подготовка файла для сохранения.
  • _writeFiles() protected
    Запись файлов, которые нужно сохранить.
  • _writeHeader() protected
    Создание заголовка шаблона перевода.
  • execute() public
    Метод выполнения, всегда используемый для задач.
  • getOptionParser() public
    Получение экземпляра анализатора опций и его настройка.

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

_addTranslation()source protected 

_addTranslation( string $category , string $domain , string $msgid , array $details array() )

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

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

Параметры

строка $category
Категория
строка $domain
Домен
строка $msgid
Строка сообщения
массив $details необязательно array()
Ссылоки на файл и строку

_buildFiles()source protected 

_buildFiles( )

Создаёт содержимое шаблона файла перевода из полученных строк.

_extract()source protected 

_extract( )

Извлекает текст.

_extractPluginValidationMessages()source protected 

_extractPluginValidationMessages( string $plugin null )

Извлекает сообщения валидации из моделей приложения или плагинов.

Параметры

строка $plugin необязательно null
Имя плагина или null для обработки моделей приложения

_extractTokens()source protected 

_extractTokens( )

Извлекает токены из всех обрабатываемых файлов.

_extractValidationMessages()source protected 

_extractValidationMessages( )

Ищет модели в приложении и извлекает сообщения валидации, которые нужно добавить в карту переводов.

_formatString()source protected 

_formatString( string $string )

Форматирует строку для добавления в качестве переводимой строки.

Параметры

строка $string
Строка для форматирования

Возвращает

строка
Отформатированная строка

_getPaths()source protected 

_getPaths( )

Метод взаимодействия с пользователем для получения выбора путей.

END_OF_DOCUMENT_MARKER

_getStrings()source protected 

_getStrings( integer $position , integer $target )

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

Параметры

целое число $position
$position Текущая позиция в массиве токенов
целое число $target
Количество строк для извлечения

Возвращает

массив
Извлеченные строки

_isExtractingApp()source protected 

_isExtractingApp( )

Возвращает, предназначено ли текущее выполнение для извлечения строк только из каталогов в папке, представленной константой APP, т.е. эта задача извлекает строки из того же приложения.

Возвращает

boolean

_isPathUsable()source protected 

_isPathUsable( string $path )

Проверяет, доступен ли заданный путь для записи.

Параметры

строка $path
Путь к папке

Возвращает

boolean
true, если путь существует и доступен для записи, иначе false

_markerError()source protected 

_markerError( string $file , integer $line , string $marker , integer $count )

Указывает на неверный маркер в обработанном файле.

Параметры

строка $file
Файл, в котором находится неверный маркер
целое число $line
Номер строки
строка $marker
Найденный маркер
целое число $count
Счетчик

_parse()source protected 

_parse( string $functionName , array $map )

Обработка токенов.

Параметры

строка $functionName
Имя функции, указывающее на переводимую строку (например: '__')
массив $map
Массив, содержащий переменные, которые будут найдены (например: категория, домен, единственное число, множественное число)

_processValidationRules()source protected 

_processValidationRules( string $field , array $rules , string $file , string $domain , string $category 'LC_MESSAGES' )

Обрабатывает правило валидации для поля и ищет сообщение, которое нужно добавить в карту переводов.

Параметры

строка $field
имя поля, которое обрабатывается
массив $rules
набор правил валидации для поля
строка $file
имя файла, в котором было найдено это правило валидации
строка $domain
домен по умолчанию для привязки валидации
строка $category необязательно 'LC_MESSAGES'
категория перевода

_searchFiles()source protected 

_searchFiles( )

Поиск файлов, которые могут содержать переводимые строки.

_store()source protected 

_store( string $category , string $domain , string $header , string $sentence )

Подготовка файла для хранения.

Параметры

строка $category
Категория
строка $domain
Домен
строка $header
Контент заголовка.
строка $sentence
Предложение для хранения.

_writeFiles()source protected 

_writeFiles( )

Запись файлов, которые нужно сохранить.

_writeHeader()source protected 

_writeHeader( )

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

Возвращает

строка
Заголовок шаблона перевода

execute()source public 

execute( )

Метод выполнения, всегда используемый для задач.

getOptionParser()source public 

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

$_excludesource

protected массив

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

array()

$_extractCoresource

protected boolean

Содержит информацию о том, следует ли извлекать сообщения CakePHP Lib.

false

$_extractValidationsource

protected boolean

Содержит информацию о том, следует ли извлекать сообщения валидации модели.

true

$_filesource

protected строка

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

null

$_filessource

protected массив

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

array()

$_mergesource

protected boolean

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

false

$_outputsource

protected строка

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

null

$_pathssource

protected строка

Пути, используемые при поиске строк.

array()

$_storagesource

protected строка

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

array()

$_tokenssource

protected массив

Извлеченные токены.

array()

$_translationssource

protected массив

Извлеченные строки, индексированные по категории, домену, msgid и контексту.

array()

$_validationDomainsource

protected boolean

Содержит домен строк валидации, используемый для сообщений о валидации при извлечении.

'default'

© 2005–2017 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/2.10/class-ExtractTask.html

Spec-Zone.ru

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