CModule Class
CModule class is used to handle modules.
All the classes describing the specific modules in the system must inherit from the CModule class. Classes implementing any module must have a name equal to the module ID. The module description must reside in file /bitrix/modules/module ID/install/index.php.
Class properties
| Parameter | Description |
|---|---|
| MODULE_ID | Module ID. |
| MODULE_VERSION | Current module version. |
| MODULE_VERSION_DATE | Current module version date. |
| MODULE_NAME | Module name. |
| MODULE_DESCRIPTION | Module description. |
| MODULE_GROUP_RIGHTS | If set to "Y", the module supports the access permission distribution schema specified in the module settings. |
Class methods
| Method | Description | Available from version |
|---|---|---|
| GetList | Returns a list of modules installed in the system. | |
| GetDropDownList | Returns selection from the database which can be passed to the SelectBox function. | |
| Add | Adds the module ID to the table b_module. | |
| Remove | Deletes the module ID from the table b_module. | |
| GetModuleRightList | Returns the array describing a specialized schema of the module access permission distribution. | |
| DoInstall | Launches the module installation procedure. | |
| DoUninstall | Launches the module uninstallation procedure. | |
| IncludeModule | Checks whether the module is installed and if so, includes it (namely, includes file /bitrix/modules/module ID/include.php). | |
| IsInstalled | Determines whether the module is installed. |
See Also
- Description of module concept
- Functions to handle modules
© «Bitrix24», 2001-2024