The following is the structure of files required to be included in a module:
- /bitrix/modules/module ID/ -
module root folder
- /admin/ - directory containing module
administrative scripts
- /classes/ - scripts with the module
classes
- /general/ -
database independent module classes
- /mysql/ - the MySQL only module classes
- /oracle/ - the Oracle only module
classes
- /lang/language ID/ - directory containing language
files used by the module scripts
- /install/ - directory containing files used to install
and uninstall a module
- /admin/ - directory with scripts including module
administrative scripts (calling scripts)
- /db/ - directory containing SQL scripts used to
install/uninstall the database
- /mysql/ - SQL scripts used to
install/uninstall MySQL tables
- /oracle/ - SQL scripts used to
install/uninstall Oracle tables
- /images/ - directory containing images used by
module; after the module installation
they should be copied to the directory /bitrix/images/module ID/
- /templates/ - directory with the module
components
- index.php - file containing the module
description
- include.php - this file is included when a function that includes
the module is called; the file should include all files implementing
functions and classes of the
module
- default_option.php - contains an array $module ID_default_option,
in which the default values of the module
parameters are specified
- options.php - this file is included by the module settings page in the
Settings menu
- prolog.php - file included by all administrative scripts of the module;
it should initialise the following two variables:
- ADMIN_MODULE_NAME - the module ID;
- ADMIN_MODULE_ICON - HTML code of the module large icon displayed above the page title.