Получить языковой файл фразы Loc::getMessageSourceFile

Модуль: main — подключать отдельно не нужно

Метод Loc::getMessageSourceFile возвращает путь языкового файла, из которого класс Loc загрузил фразу. Путь нужен, например, чтобы найти файл с переводом, который надо исправить.

Метод появился в версии main новее 26.150.0.

Сигнатура метода в классе Bitrix\Main\Localization\Loc:

public static function getMessageSourceFile(string $code, ?string $language = null): ?string

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
code* string Задает код фразы
language string, null Задает код языка. По умолчанию — null, тогда метод берет язык из getCurrentLang

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

Метод возвращает полный путь языкового файла или null. Метод возвращает null, если фраза еще не загружена или класс загрузил ее без обработчика фраз.

Особенности

  • Класс запоминает файлы фраз, только пока задан обработчик из setMessageDecorator. Задайте обработчик до загрузки фраз, иначе метод вернет null.
  • Метод не загружает фразы сам. Сначала получите фразу через getMessage или загрузите файл через loadLanguageFile.
  • Класс загружает сначала файл языка по умолчанию, затем файл запрошенного языка. Если существуют оба файла, метод возвращает путь файла запрошенного языка для всех фраз. Это верно и для фразы, которая есть только в файле языка по умолчанию.
  • Для фразы, которую заменил loadCustomMessages, метод возвращает исходный языковой файл, а не файл замены.

Примеры

Пример. Код задает обработчик фраз, получает фразу установщика модуля main и проверяет путь ее языкового файла. Блок 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;
    }
);

try
{
    Loc::loadMessages($_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/install/index.php');
    Loc::getMessage('MAIN_EVERYONE_GROUP_NAME', null, 'en');

    $file = Loc::getMessageSourceFile('MAIN_EVERYONE_GROUP_NAME', 'en');
    echo str_ends_with((string)$file, '/main/lang/en/install/index.php') ? 'Found' : 'Not found';
}
finally
{
    Loc::setMessageDecorator(null);
}

Код выведет Found.

Смотрите также