You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

Данный класс содержит методы, возвращающие переведенные сообщения. У него нет конструктора, поэтому доступ к методам осуществляется через глобальный объект s_i18n.

getMessage(msgKey, config, callback)


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

Параметр msgKey содержит строку для перевода, а параметр callback является функцией, которая выполняется после ответа сервера.


Параметры:

НазваниеТипОбязательноеЗначение по умолчанию
msgKeyStringДаНет
configObjectНет''
callbackFunctionНетНет


Параметр config представляет собой объект, содержащий три параметра:

НазваниеТипОбязательноеЗначение по умолчанию
languageStringНет''
categoryStringНет'app'
paramsObjectНет''

Параметр language принимает значения, указанные в таблице Язык (sys_language). Если он не указан, метод будет использовать текущий язык пользователя.

Параметр category принимает значения, хранящиеся в записи таблицы Исходные сообщения (source_message) в поле Категория.

Если в сообщении присутствуют заполнители, а у объекта params есть ключ, совпадающий с заполнителем, то в итоговое сообщение будет подставлено его значение.

Как правило, параметр config не является обязательным, поэтому для получения перевода можно использовать функцию обратного вызова:

getMessage
await s_i18n.getMessage('Description', (response) => {console.log(response)});
// Описание

Данный метод является асинхронным. Для оптимальной работы используйте ключевое слово await, как в примере ниже.


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

ТипОписание
StringДанный метод возвращает сообщение, переведенное на указанный язык,  соответствующее параметру language.


Пример:

getMessage
if (!s_form.getValue('condition')) {
  await s_i18n.getMessage('Specify conditions in "Condition" [condition] field.', (response) => {
    s_form.addErrorMessage(response);
  });
  return false;
}
getMessage
const serviceNameValue = 'Почта';
s_i18n.getMessage('Sorry, The {serviceName} Service Is Temporarily Unavailable', {params: {"serviceName": serviceNameValue}, language: "ru", category: "app"}, (response) => console.log(response));

  // Извините, Почта временно недоступна

getMessages(msgKeys, config, callback)


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

Параметр msgKeys передает массив строк на перевод. Параметр callback является функцией, которая выполняется после ответа сервера.

Параметры:

НазваниеТипОбязательноеЗначение по умолчанию
msgKeysArray of StringsДаНет
configObjectНет''
callbackFunctionНетНет


Параметр config представляет собой объект, содержащий три параметра:

НазваниеТипОбязательноеЗначение по умолчанию
languageStringНет''
categoryStringНет'app'
paramsObjectНет''

Параметр language принимает значения, указанные в таблице Язык (sys_language). Если он не указан, метод будет использовать текущий язык пользователя.

Параметр category принимает значения, хранящиеся в записи таблицы Исходные сообщения (source_message) в поле Категория.

Если в сообщении присутствуют заполнители, а у объекта params есть ключ, совпадающий с заполнителем, то в итоговое сообщение будет подставлено его значение.

Данный метод является асинхронным. Для оптимальной работы используйте ключевое слово await, как в примере ниже.


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

ТипОписание
Array of stringsМетод возвращает массив строк, которые могут быть переведены на язык, соответствующий параметру language.


Пример:

getMessages
const data = {};
const btnTitles = ['Accept', 'Cancel'];
await s_i18n.getMessages(btnTitles, (response) => {
  [data.acceptBtnTitle, data.cancelBtnTitle] = response;
});
console.log(JSON.stringify(data));

// {"acceptBtnTitle":"Принять","cancelBtnTitle":"Отмена"}

При использовании одного и того же заполнителя в разных сообщениях метод getMessages() возвращает одинаковые значения. 


getMessages
window.s_i18n.getMessages(
                [
                    'Дата и время должны быть в {translation}.',
                    'Имя пользователя должно состоять не менее чем из 2 символов {translation}.',
                ],
                { params: { 'translation': 'TEST' } },
               

Данный метод возвращает сообщения: 

  • Дата и время должны быть в TEST.
  • Имя пользователя должно состоять не менее чем из 2 символов TEST.

  • No labels