Класс yii\i18n\I18N

Все классы | Свойства | Методы

Наследование	yii\i18n\I18N » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступна с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/i18n/I18N.php

I18N предоставляет функции, связанные с интернационализацией (I18N) и локализациями (L10N).

I18N по умолчанию настраивается как компонент приложения в yii\base\Application. Вы можете получить доступ к этому экземпляру через Yii::$app->i18n.

Публичные свойства

Свойство	Тип	Описание	Определено в
$behaviors	yii\base\Behavior[]	Список присоединённых к этому компоненту поведений	yii\base\Component
$messageFormatter	yii\i18n\MessageFormatter	Форматировщик сообщений, используемый для форматирования сообщений с помощью формата сообщений ICU.	yii\i18n\I18N
$translations	array	Список конфигураций или объектов yii\i18n\MessageSource.	yii\i18n\I18N

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путём клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__unset()	Устанавливает свойство компонента в значение null.	yii\base\Component
attachBehavior()	Присоединяет поведение к компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен вести себя этот компонент.	yii\base\Component
canGetProperty()	Возвращает значение, указывающее, можно ли считать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное имя этого класса.	yii\base\Object
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
format()	Форматирует сообщение с помощью yii\i18n\MessageFormatter.	yii\i18n\I18N
getBehavior()	Возвращает объект указанного поведения.	yii\base\Component
getBehaviors()	Возвращает все присоединённые к этому компоненту поведения.	yii\base\Component
getMessageFormatter()	Возвращает экземпляр форматировщика сообщений.	yii\i18n\I18N
getMessageSource()	Возвращает источник сообщений для данной категории.	yii\i18n\I18N
hasEventHandlers()	Возвращает значение, указывающее, прикреплён ли какой-либо обработчик к указанному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для этого компонента.	yii\base\Component
init()	Инициализирует компонент, настроив стандартные категории сообщений.	yii\i18n\I18N
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
setMessageFormatter()		yii\i18n\I18N
translate()	Переводит сообщение на указанный язык.	yii\i18n\I18N
trigger()	Вызывает событие.	yii\base\Component

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

$messageFormatter публичное свойство

Форматировщик сообщений, используемый для форматирования сообщений с помощью формата сообщений ICU.

public yii\i18n\MessageFormatter getMessageFormatter ( )
public void setMessageFormatter ( $value )

$translations публичное свойство

Список конфигураций или объектов yii\i18n\MessageSource. Ключи массива — шаблоны категорий сообщений, а значения — соответствующие объекты yii\i18n\MessageSource или конфигурации для создания объектов yii\i18n\MessageSource.

Шаблоны категорий сообщений могут содержать символ подстановки * в конце, чтобы соответствовать нескольким категориям с тем же префиксом. Например, app/* соответствует как app/cat1, так и app/cat2.

Шаблон категории * будет соответствовать всем категориям, не соответствующим другим шаблонам категорий.

Это свойство можно изменять на лету с помощью расширений, которые хотят регистрировать свои собственные источники сообщений в своих собственных пространствах имён.

Категории yii и app всегда определены. Первая относится к сообщениям, используемым в коде фреймворка Yii, а вторая — к стандартной категории сообщений для пользовательского кода приложения. По умолчанию обе эти категории используют yii\i18n\PhpMessageSource, а соответствующие файлы сообщений хранятся в @yii/messages и @app/messages, соответственно.

Вы можете переопределить конфигурацию обеих категорий.

public array $translations = null

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

format() public method

Форматирует сообщение с помощью yii\i18n\MessageFormatter.

public string format ( $message, $params, $language )
$message	string	Сообщение для форматирования.
$params	array	Параметры, которые будут использованы для замены соответствующих заполнительных значений в сообщении.
$language	string	Код языка (например, `en-US`, `en`).
return	string	Отформатированное сообщение.

getMessageFormatter() public method

Возвращает экземпляр форматировщика сообщений.

public yii\i18n\MessageFormatter getMessageFormatter ( )
return	yii\i18n\MessageFormatter	Форматировщик сообщений, используемый для форматирования сообщений с помощью формата сообщений ICU.

getMessageSource() public method

Возвращает источник сообщений для заданной категории.

public yii\i18n\MessageSource getMessageSource ( $category )
$category	string	Название категории.
return	yii\i18n\MessageSource	Источник сообщений для заданной категории.
throws	yii\base\InvalidConfigException	если для указанной категории нет доступного источника сообщений.

init() public method

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

public void init ( )

setMessageFormatter() public method

public void setMessageFormatter ( $value )
$value	string\|array\|yii\i18n\MessageFormatter	Форматировщик сообщений, который будет использоваться для форматирования сообщений с помощью формата сообщений ICU. Может быть задан как конфигурация в виде массива или строки, которая будет передана в Yii::createObject() для создания экземпляра или экземпляр yii\i18n\MessageFormatter.

translate() public method

Переводит сообщение на указанный язык.

После перевода сообщение будет отформатировано с помощью yii\i18n\MessageFormatter, если оно содержит формат сообщений ICU, и $params не пустые.

public string translate ( $category, $message, $params, $language )
$category	string	Категория сообщения.
$message	string	Сообщение для перевода.
$params	array	Параметры, которые будут использованы для замены соответствующих заполнительных значений в сообщении.
$language	string	Код языка (например, `en-US`, `en`).
return	string	Переведённое и отформатированное сообщение.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-i18n-i18n.html