Loc — языковые фразы

Пространство имен: Bitrix\Main\Localization

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

Доступно с версии: 12.0.7

Когда использовать

Класс Loc возвращает тексты интерфейса из языковых файлов. Метод loadMessages регистрирует PHP-файл, для которого нужны фразы, метод getMessage возвращает фразу по коду. Класс финальный, все методы статические.

Класс ищет каталог lang, поднимаясь вверх от PHP-файла. В каталоге lang языковой файл лежит в подкаталоге с кодом языка. Путь языкового файла повторяет путь PHP-файла от родителя каталога lang. Например, для /local/php_interface/mylib.php русский языковой файл — /local/php_interface/lang/ru/mylib.php. Языковой файл содержит массив $MESS с фразами.

Аналог в классическом API — функции IncludeModuleLangFile и GetMessage. Функция IncludeModuleLangFile без второго и третьего аргументов вызывает Loc::loadMessages. Функция GetMessage вызывает Loc::getMessage, если фразы нет в глобальном массиве $MESS.

Подробнее — в разделе «Механизм языковых сообщений» статьи Локализация.

Методы класса

Метод Описание С версии
loadMessages Регистрирует PHP-файл для отложенной загрузки фраз
getMessage Возвращает фразу по коду
getMessagePlural Возвращает фразу в форме, согласованной с числом
getPluralForm Возвращает номер формы фразы для числа по правилам языка
loadLanguageFile Сразу загружает фразы языкового файла и возвращает их
loadCustomMessages Загружает фразы, которые заменяют фразы с теми же кодами
getCurrentLang Возвращает код текущего языка
setCurrentLang Задает код текущего языка
getDefaultLang Возвращает язык, фразы которого класс берет, если перевода нет
getIncludedFiles Возвращает загруженные языковые файлы
setMessageDecorator Задает функцию, которая обрабатывает каждую фразу перед возвратом
getMessageSourceFile Возвращает языковой файл, из которого загружена фраза

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