Установка и удаление

Установка модуля

Инсталляция осуществляется в административном интерфейсе на странице Настройки > Настройки продукта > Модули нажатием кнопки Установить.

При этом будет вызван метод DoInstall класса с именем, представляющим собой ID модуля, где точка заменяется на нижнее подчеркивание. Этот класс должен быть описан в файле /bitrix/modules/ID модуля/install/index.php.

В процессе инсталляции должны быть выполнены в обязательном порядке:

Регистрация, которая осуществляется с помощью функции RegisterModule.
Если модуль обладает административными скриптами, то для их вызова в каталог /bitrix/admin/ должны быть скопированы вызывающие скрипты.
Все изображения, используемые модулем, должны быть скопированы в каталог /bitrix/images/ID модуля/.

В самом начале файла лучше объявить все используемые в коде синонимы. Скорее всего их сразу не удастся все объявить, но их можно добавлять в процессе работы. Очень важно следить, чтобы одни и те же синонимы не использовались для разных пространств имен.

Удаление модуля

Деинсталляция осуществляется нажатием кнопки Удалить. При этом будет вызван метод DoUninstall класса с именем совпадающим с ID модуля. Этот класс должен быть описан в файле /bitrix/modules/ID модуля/install/index.php.

В процессе деинсталляции должны быть выполнены в обязательном порядке:

Удаление регистрационной записи, которая осуществляется с помощью функции UnRegisterModule
Если модуль обладает административными скриптами, то вызывающие их скрипты должны быть удалены из каталога /bitrix/admin/.
Все изображения, используемые модулем, должны быть удалены из каталога /bitrix/images/ID модуля/.

Примечание: Модули Главный и Управление структурой удалить нельзя.