Loader — подключение модулей и автозагрузка классов

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

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

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

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

Класс Loader подключает модули и загружает классы. Перед вызовом классов модуля, кроме main, подключите модуль методом includeModule или requireModule.

Ядро регистрирует метод autoLoad как автозагрузчик PHP в файле /bitrix/modules/main/include/autoload.php. Автозагрузчик ищет класс по порядку:

Метод includeModule сам регистрирует пространство имен каталога lib для каждого подключенного модуля.

Все методы класса статические. Аналоги в классическом API — CModule::IncludeModule и CModule::IncludeModuleEx, они вызывают методы этого класса.

Подробнее — в статье Автозагрузка классов.

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

Метод Описание С версии
includeModule Подключает модуль
requireModule Подключает модуль или выбрасывает исключение
setRequireThrowException Включает или отключает исключение при подключении модуля методом requireModule
includeSharewareModule Подключает модуль с демо-режимом и возвращает его состояние 14.0.2
clearModuleCache Сбрасывает запомненный результат подключения модуля
registerNamespace Регистрирует каталог для пространства имен
unregisterNamespace Удаляет регистрацию пространства имен
getNamespaces Возвращает зарегистрированные пространства имен
registerAutoLoadClasses Регистрирует файлы классов для автозагрузки
registerClassAliases Регистрирует псевдонимы классов
registerHandler Добавляет свой автозагрузчик
autoLoad Загружает класс по имени
requireClass Подключает модуль класса и загружает класс
getDocumentRoot Возвращает корень сайта 14.0.0
getLocal Находит файл в каталоге /local/ или /bitrix/
getPersonal Находит файл в персональном каталоге, /local/ или /bitrix/
includeComposerAutoload Подключает автозагрузчик Composer из настроек

Константы

Константа Значение Назначение
MODULE_NOT_FOUND 0 Модуль не найден или не установлен
MODULE_INSTALLED 1 Модуль подключен и работает
MODULE_DEMO 2 Модуль работает в демо-режиме
MODULE_DEMO_EXPIRED 3 Демо-период модуля закончился
BITRIX_HOLDER bitrix Каталог модулей ядра — /bitrix/modules/
LOCAL_HOLDER local Каталог своих модулей — /local/modules/
SAFE_MODE false Режим, в котором подключаются только модули main и fileman

Метод includeSharewareModule возвращает константы MODULE_*. Константы ALPHA_LOWER и ALPHA_UPPER устарели.

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