Перейти к содержанию

Структура файлов

Файлы модуля располагаются в папке /bitrix/modules/ID модуля/. Структура папки:

  • admin/ – каталог с административными скриптами;
  • menu.php – файл с административным меню;
  • classes/ – скрипты с классами модуля;
  • general/ – классы, не зависящие от используемой базы данных;
  • mysql/ – классы, предназначенные для работы только с MySQL;
  • mssql/ – классы, предназначенные для работы только с MS SQL;
  • oracle/ – классы, предназначенные для работы только с Oracle;
  • lang/ID языка/ – каталог с языковыми файлами;
  • lib/ – каталог с файлами (API: классы, логика) нового ядра D7 (может не присутствовать, если у модуля нет собственных методов);
  • install/ – каталог с файлами используемыми для инсталляции и деинсталляции модуля;
  • admin/ – каталог со скриптами подключающими административные скрипты (вызывающие скрипты);
  • js/ – каталог с js-скриптами модуля. Копируются в /bitrix/js/ID_модуля/;
  • db/ – каталог с SQL скриптами для инсталляции/деинсталляции базы данных;
    • mysql/ – SQL скрипты для инсталляции/деинсталляции таблиц в MySQL;
    • mssql/ – SQL скрипты для инсталляции/деинсталляции таблиц в MS SQL;
    • oracle/ – SQL скрипты для инсталляции/деинсталляции таблиц в Oracle;
  • images/ – каталог с изображениями; после инсталляции модуля они должны быть скопированы в каталог /bitrix/images/ID модуля/;
  • templates/ – каталог с компонентами 1.0. (Сохраняется только с целью совместимости версий.);
    • ID модуля/ – каталог с основными файлами компонентов;
    • lang/ID языка/ID модуля/ – каталог с языковыми файлами компонентов;
  • components/пространство имен/имя компонента/ – каталог с компонентами 2.0;
  • themes/имя_модуля/ – css и картинки для стилей административной панели, если модуль в таковых нуждается (Устаревшая, до версии 12.0);
  • panel/имя_модуля/ – css и картинки для стилей административной панели, если модуль в таковых нуждается.
  • index.php – файл с описанием модуля;
  • version.php – файл с номером версии. Версия не может быть равной нулю.
  • include.php – файл подключается в тот момент, когда речь идет о подключении модуля в коде, в нем должны находиться включения всех файлов с библиотеками функций и классов;
  • default_option.php – содержит массив с именем $ID модуля_default_option, в котором заданы значения по умолчанию для параметров модуля;

Примечание: В случае партнерских модулей, в названии которых содержится точка (пример – mycompany.forum) в имени переменной точка будет автоматически заменена на символ подчеркивания. - options.php – файл подключается на странице настройки параметров модулей в административном меню Настройки; - prolog_admin.php – файл должен подключаться во всех административных скриптах модуля. Обычно в нем определяется константа ADMIN_MODULE_NAME (идентификатор модуля), используемая в панели управления; - .settings.php – файл настроек, описывающий настройки модуля, которые можно прочитать через \Bitrix\Main\Config\Configuration::getInstance($module).