Spec-Zone.ru › CakePHP 2.9

Класс ExtractTask

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

AppShell
Extended by ExtractTask
Пакет: Cake\Console\Command\Task
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: 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
    Добавить перевод в свойство internal translations.
  • _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() )

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

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

Параметры

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

_buildFiles()source protected 

_buildFiles( )

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

_extract()source protected 

_extract( )

Извлечь текст.

_extractPluginValidationMessages()source protected 

_extractPluginValidationMessages( string $plugin null )

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

Параметры

строка $plugin optional 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, т.е. задача извлекает строки из того же приложения.

Возвращаемое значение

логическое значение

_isPathUsable()source protected 

_isPathUsable( string $path )

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

Параметры

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

Возвращаемое значение

логическое значение
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
Массив, содержащий переменные, которые будут найдены (например: category, domain, singular, plural)

_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 логическое значение

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

false

$_extractValidationsource

protected логическое значение

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

true

$_filesource

protected строка

Текущий обрабатываемый файл

null

$_filessource

protected массив

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

array()

$_mergesource

protected логическое значение

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

false

$_outputsource

protected строка

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

null

$_pathssource

protected строка

Пути, которые нужно использовать при поиске строк

array()

$_storagesource

protected строка

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

array()

$_tokenssource

protected массив

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

array()

$_translationssource

protected массив

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

array()

$_validationDomainsource

protected логическое значение

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

'default'

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

Spec-Zone.ru

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