Документация для разработчиков
Темная тема

Класс CModule

Описание и свойства класса

CModule - класс для работы с модулями.

Все классы представляющие из себя описание конкретных модулей системы должны наследоваться от класса CModule. Классы описывающие тот или иной модуль должны иметь имя равное ID модуля и их описание должно располагаться в файле /bitrix/modules/ID модуля/install/index.php.

Свойства класса

ПараметрОписание
MODULE_ID Идентификатор модуля.
MODULE_VERSION Текущая версия модуля.
MODULE_VERSION_DATE Дата текущей версии модуля.
MODULE_NAME Наименование модуля.
MODULE_DESCRIPTION Описание модуля.
MODULE_GROUP_RIGHTS Если значение "Y", то модуль поддерживает схему распределения прав настраиваемую как правило в настройках модуля.

Список методов

Метод Описание С версии
GetList Возвращает список установленных модулей системы.
GetDropDownList Возвращает выборку из базы для применения в функции SelectBox, предназначенной для вывода HTML выпадающего списка.3.0.18
Add Вставляет идентификатор модуля в таблицу b_module.
Remove Удаляет идентификатор модуля из таблицы b_module.
GetModuleRightList Возвращает массив описывающий индивидуальную схему распределения прав модуля.
DoInstall Запускает процедуру инсталляции модуля.
DoUninstall Запускает процедуру деинсталляции модуля.
IncludeModule Проверяет установлен ли модуль и если установлен, то подключает его (точнее подключает файл /bitrix/modules/ID модуля/include.php).
IsInstalled Проверяет установлен ли модуль.

См. также



© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх