Задать обработчик фраз Loc::setMessageDecorator
Модуль: main — подключать отдельно не нужно
Метод Loc::setMessageDecorator задает функцию-обработчик фраз. Метод getMessage передает обработчику каждую фразу и возвращает то, что вернул обработчик. Обработчик подходит, например, для подсветки непереведенных фраз или для вывода кода фразы рядом с текстом.
Метод появился в версии main новее 26.150.0.
Сигнатура метода в классе Bitrix\Main\Localization\Loc:
public static function setMessageDecorator(?callable $decorator): void
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| decorator* | callable, null |
Задает обработчик фраз. Значение null отключает обработчик |
Метод getMessage вызывает обработчик с пятью аргументами.
| Аргумент | Тип | Описание |
|---|---|---|
| code | string |
Код фразы |
| raw | string, null |
Фраза из языкового файла. Если фразы нет, передается null |
| message | string, null |
Фраза, которую вернет getMessage. Сейчас совпадает с raw |
| file | string, null |
Путь языкового файла фразы, как у getMessageSourceFile |
| language | string |
Код языка |
Обработчик возвращает строку или null. Результат заменяет фразу.
Возвращаемое значение
Метод ничего не возвращает.
Особенности
- Обработчик действует до конца запроса или до следующего вызова метода. Класс хранит один обработчик, новый вызов заменяет прежний.
- Метод
getMessageвызывает обработчик и для фразы, которой нет в языковых файлах. Если обработчик вернул строку,getMessageвернет ее вместоnull. - Метод
getMessageподставляет значения из параметраreplaceпосле обработчика. Обработчик получает фразу с метками вида#NUM#. - Пока обработчик задан, класс запоминает языковой файл каждой загруженной фразы. Фразы, которые класс загрузил до вызова метода, остаются без файла, и обработчик получает
nullв аргументеfile. - Классическая функция
GetMessageвозвращает фразу из глобального массива$MESSбез обработчика. Обработчик срабатывает, только еслиGetMessageпередает вызов вLoc::getMessage.
Примеры
Пример. Код задает обработчик, который добавляет к фразе ее код, получает фразу и в блоке finally отключает обработчик:
<?php
use Bitrix\Main\Localization\Loc;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
Loc::setMessageDecorator(
static function (string $code, ?string $raw, ?string $message, ?string $file, string $language): ?string
{
return $message === null ? null : $message . ' [' . $code . ']';
}
);
try
{
Loc::loadMessages($_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/install/index.php');
echo Loc::getMessage('MAIN_EVERYONE_GROUP_NAME', null, 'en');
}
finally
{
Loc::setMessageDecorator(null);
}
Код выведет All users (with non-authorized users) [MAIN_EVERYONE_GROUP_NAME].