Класс yii\i18n\MessageSource
| Наследование | yii\i18n\MessageSource » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\i18n\DbMessageSource, yii\i18n\GettextMessageSource, yii\i18n\PhpMessageSource, yii\mongodb\i18n\MongoDbMessageSource |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/i18n/MessageSource.php |
MessageSource — базовый класс для классов-хранилищ переводов сообщений.
Источник сообщений хранит переводы сообщений в каком-либо постоянном хранилище.
Подклассы должны переопределить loadMessages() для предоставления переведённых сообщений.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $forceTranslation | boolean | Выполнять ли принудительный перевод сообщений, когда исходный и целевой языки совпадают. | yii\i18n\MessageSource |
| $sourceLanguage | string | Язык, на котором находятся исходные сообщения. | yii\i18n\MessageSource |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует этот компонент. | yii\i18n\MessageSource |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| translate() | Переводит сообщение на указанный язык. | yii\i18n\MessageSource |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| loadMessages() | Загружает перевод сообщений для указанного языка и категории. | yii\i18n\MessageSource |
| translateMessage() | Переводит указанное сообщение. | yii\i18n\MessageSource |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_MISSING_TRANSLATION | yii\i18n\MissingTranslationEvent | Событие, которое срабатывает, когда перевод сообщения не найден. | yii\i18n\MessageSource |
Подробное описание свойств
$forceTranslation открытое свойство
Выполнять ли принудительный перевод сообщений, когда исходный и целевой языки совпадают. По умолчанию значение false, что означает, что перевод выполняется только при разнице исходного и целевого языков.
public boolean $forceTranslation = false
$sourceLanguage открытое свойство
Язык, на котором находятся исходные сообщения. Если не задано, используется значение yii\base\Application::$sourceLanguage.
public string $sourceLanguage = null
Подробное описание методов
init() общественный метод
Инициализирует этот компонент.
| public void init ( ) |
|---|
loadMessages() защищённый метод
Загружает перевод сообщений для указанного языка и категории.
Если перевод для конкретного кода локали, например en-US, не найден, он пытается найти более общий en.
| protected array loadMessages ( $category, $language ) | ||
|---|---|---|
| $category | string |
Категория сообщения |
| $language | string |
Целевой язык |
| return | array |
Загруженные сообщения. Ключами являются исходные сообщения, а значениями — переведённые сообщения. |
translate() общественный метод
Переводит сообщение на указанный язык.
Обратите внимание, что если $forceTranslation не равен true, если целевой язык совпадает с исходным языком, сообщение НЕ будет переведено.
Если перевод не найден, будет вызвано событие missingTranslation.
| public string|boolean translate ( $category, $message, $language ) | ||
|---|---|---|
| $category | string |
Категория сообщения |
| $message | string |
Сообщение, подлежащее переводу |
| $language | string |
Целевой язык |
| return | string|boolean |
Переведённое сообщение или false, если перевод не был найден или не требуется |
translateMessage() защищённый метод
Переводит указанное сообщение.
Если сообщение не найдено, будет вызвано событие missingTranslation. Если есть обработчик события, он может предоставить запасной перевод. Если запасной перевод не предоставлен, этот метод вернёт false.
| protected string|boolean translateMessage ( $category, $message, $language ) | ||
|---|---|---|
| $category | string |
Категория, к которой принадлежит сообщение. |
| $message | string |
Сообщение, подлежащее переводу. |
| $language | string |
Целевой язык. |
| return | string|boolean |
Переведённое сообщение или false, если перевод не был найден. |
Подробное описание событий
EVENT_MISSING_TRANSLATION событие типа yii\i18n\MissingTranslationEvent
Событие, которое срабатывает, когда перевод сообщения не найден.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-i18n-messagesource.html
