367  /  382
Справочник

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

Просмотров: 64693
Дата последнего изменения: 06.06.2023
Роберт Басыров
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5
Недоступно в лицензиях:
Ограничений нет

Файлы модуля располагаются в папке /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).

Курсы разработаны в компании «1С-Битрикс»

Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
Развернуть комментарии