Spec-Zone.ru › CakePHP 2.8

Класс I18n

I18n обрабатывает перевод строк текста и форматов времени.

Пакет: Cake\I18n
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/I18n/I18n.php

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

  • integer

    LC_ALL
    0
  • integer

    LC_COLLATE
    1
  • integer

    LC_CTYPE
    2
  • integer

    LC_MESSAGES
    6
  • integer

    LC_MONETARY
    3
  • integer

    LC_NUMERIC
    4
  • integer

    LC_TIME
    5

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

  • $_categories protected
    array
    Категории перевода
  • $_domains protected
    array
    Строки перевода для определенного домена, считываемые из файлов .mo или .po
  • $_escape protected
    string
    Строка экранирования
  • $_lang protected
    string
    Текущий язык, используемый для переводов
  • $_noLocale protected
    boolean

    Устанавливается в true, когда I18N::_bindTextDomain() вызывается в первый раз. Если найден файл перевода, он снова устанавливается в false.

  • $category public
    string
    Текущая категория перевода
  • $defaultDomain public static
    string
    Домен перевода по умолчанию
  • $domain public
    string
    Текущий домен перевода
  • $l10n public
    L10n
    Экземпляр класса L10n для локализации

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

  • __construct() public
    Конструктор, используйте I18n::getInstance() для получения объекта перевода i18n.
  • _bindTextDomain() protected
    Привязывает заданный домен к файлу в указанной директории.
  • _parseLiteralValue() protected
    Вспомогательная функция для разбора символа из файла определения локали
  • _pluralGuess() protected
    Попытка найти множественное число строки.
  • _translateTime() protected
    Возвращает определение формата времени из соответствующего домена
  • clear() public static
    Очищает внутренний массив данных доменов. Полезно для тестирования i18n.
  • domains() public static
    Получение кэша загруженных доменов.
  • getInstance() public static
    Возвращает статический экземпляр класса I18n
  • insertArgs() public static
    Вставляет параметры в сырые переведенные строки
  • loadLocaleDefinition() public static
    Разбирает файл определения локали, следуя стандарту POSIX
  • loadMo() public static
    Загружает двоичный файл .mo и возвращает массив переводов
  • loadPo() public static
    Загружает текстовый файл .po и возвращает массив переводов
  • translate() public static

    Используется функциями перевода в basics.php Возвращает переведенную строку на основе текущего языка и файлов перевода, хранящихся в папке locale

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

__construct()source public

__construct( )

Конструктор, используйте I18n::getInstance() для получения объекта перевода i18n.

_bindTextDomain()source protected

_bindTextDomain( string $domain )

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

Параметры

строка $domain
Домен для привязки

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

строка
Привязанный домен

_parseLiteralValue()source protected

_parseLiteralValue( string $string )

Вспомогательная функция для разбора символа из файла определения локали

Параметры

строка $string
Символ для разбора

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

строка
Разборенный символ

_pluralGuess()source protected

_pluralGuess( string $header , integer $n )

Попытка найти множественное число строки.

Параметры

строка $header
Тип
целое число $n
Число

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

целое число
Соответствие множественного числа

Ссылка

http://localization-guide.readthedocs.org/en/latest/l10n/pluralforms.html
https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_and_Plurals#List_of_Plural_Rules

_translateTime()source protected

_translateTime( string $format , string $domain )

Возвращает определение формата времени из соответствующего домена

Параметры

строка $format
Формат для перевода
строка $domain
Домен, где хранится формат

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

смешанный тип
Переведенная строка формата, если это только значение, или массив переведенных строк для соответствующего формата.

clear()source public static

clear( )

Очищает внутренний массив данных доменов. Полезно для тестирования i18n.

domains()source public static

domains( )

Получение кэша загруженных доменов.

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

массив

getInstance()source public static

getInstance( )

Возвращает статический экземпляр класса I18n

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

I18n
END_OF_DOCUMENT_MARKER ```

insertArgs()source public static

insertArgs( string $translated , array $args )

Подставляет параметры в обычные переведённые строки

Параметры

строка $translated
Исходная переведённая строка
массив $args
Аргументы для подстановки в перевод

Возвращает

строка
Переведённая строка с аргументами

loadLocaleDefinition()source public static

loadLocaleDefinition( string $filename )

Парсит файл определения локали, следуя стандарту POSIX

Параметры

строка $filename
Имя файла определения локали

Возвращает

смешанный тип
Массив определений при успехе или false при ошибке

loadMo()source public static

loadMo( string $filename )

Загружает двоичный файл .mo и возвращает массив переводов

Параметры

строка $filename
Двоичный файл .mo для загрузки

Возвращает

смешанный тип
Массив переводов при успехе или false при ошибке

Ссылка

https://www.gnu.org/software/gettext/manual/html_node/MO-Files.html

loadPo()source public static

loadPo( string $filename )

Загружает текстовый файл .po и возвращает массив переводов

Параметры

строка $filename
Текстовый файл .po для загрузки

Возвращает

смешанный тип
Массив переводов при успехе или false при ошибке

translate()source public static

translate( string $singular , string $plural null , string $domain null , string $category self::LC_MESSAGES , integer $count null , string $language null , string $context null )

Используется функциями перевода в basics.php. Возвращает переведённую строку на основе текущего языка и файлов переводов, сохранённых в папке locale

Параметры

строка $singular
Строка для перевода
строка $plural необязательно null
Строка множественного числа (если есть)
строка $domain необязательно null

Домен Домен перевода. Домены часто используются для переводов плагинов. Если null, будет использован домен по умолчанию.

строка $category необязательно self::LC_MESSAGES
Категория Целочисленное значение категории для использования.
целое число $count необязательно null
Счётчик Счётчик используется с $plural для выбора правильной формы множественного числа.
строка $language необязательно null

Язык для перевода строки. Если null, ищет язык в сессии, а затем в переменной конфигурации Config.language.

строка $context необязательно null
Контекст Контекст перевода, например, глагол или существительное.

Возвращает

строка
переведённая строка.

Выбрасывает

CakeException
Когда '' указан в качестве домена.

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

$_categoriessource

protected массив

Категории перевода

array(
    'LC_ALL', 'LC_COLLATE', 'LC_CTYPE', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME', 'LC_MESSAGES'
)

$_domainssource

protected массив

Строки перевода для определённого домена, считанные из файлов .mo или .po

array()

$_escapesource

protected строка

Строка экранирования

null

$_langsource

protected строка

Текущий язык, используемый для переводов

null

$_noLocalesource

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

Устанавливается в true, когда I18N::_bindTextDomain() вызывается в первый раз. Если файл перевода найден, он снова устанавливается в false

false

$categorysource

public строка

Текущая категория перевода

'LC_MESSAGES'

$defaultDomainsource

public static строка

Домен перевода по умолчанию

'default'

$domainsource

public строка

Текущий домен перевода

null

$l10nsource

public L10n

Экземпляр класса L10n для локализации

null

© 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.
http://api.cakephp.org/2.8/class-I18n.html

Spec-Zone.ru

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