Module description

Each module should be correctly described in a system, for the latter to know how to handle this module. Modules described incorrectly can cause total or partial inoperability of the system (for example, the Update subsystem may become inoperative).

The main file the system uses to manipulate a module is /bitrix/modules/module ID/install/index.php. The main function of this file is to implement the class with the same name as module ID in it.

The following are the required methods of this class:

DoInstall runs after a user clicks Install in the administrative menu Modules. Performs the module installation (see also CModule::DoInstall);
DoUninstall runs after clicking Delete in the administrative menu Modules. Uninstalls a module (see also CModule::DoUninstall).

Optional method of the class:

GetModuleRightList returns a list of unique permissions (or roles) of a module (see also CModule::GetModuleRightList).

The following properties are required in this class:

MODULE_ID stores the module ID;
MODULE_VERSION - the current version of the module in the format XX.XX.XX;
MODULE_VERSION_DATE - string containing the module version date; the date is to be specified in the format YYYY-MM-DD HH:MI:SS;
MODULE_NAME - the module name;
MODULE_DESCRIPTION - the module description;
MODULE_GROUP_RIGHTS - if the method GetModuleRightList is implemented, this property should be set to "Y".

Example of a file describing the Web forms module

<?
global $MESS;
$PathInstall = str_replace("\\", "/", __FILE__);
$PathInstall = substr($PathInstall, 0, strlen($PathInstall)-strlen("/index.php"));

IncludeModuleLangFile($PathInstall."/install.php");
include($PathInstall."/version.php");

if (class_exists("form"))
    return;

Class form extends CModule
{
    var $MODULE_ID = "form";
    var $MODULE_VERSION;
    var $MODULE_VERSION_DATE;
    var $MODULE_NAME;
    var $MODULE_DESCRIPTION;
    var $MODULE_GROUP_RIGHTS = "Y";

    function form()
    {
        $this->MODULE_VERSION = FORM_VERSION;
        $this->MODULE_VERSION_DATE = FORM_VERSION_DATE;
        $this->MODULE_NAME = GetMessage("FORM_MODULE_NAME");
        $this->MODULE_DESCRIPTION = GetMessage("FORM_MODULE_DESCRIPTION");
    }

    function DoInstall()
    {
        global $DB, $APPLICATION, $step;
        $FORM_RIGHT = $APPLICATION->GetGroupRight("form");
        if ($FORM_RIGHT=="W")
        {
            $step = IntVal($step);
            if ($step<2)
                $APPLICATION->IncludeAdminFile(GetMessage("FORM_INSTALL_TITLE"),
                $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/form/install/step1.php");
            elseif ($step==2)
                $APPLICATION->IncludeAdminFile(GetMessage("FORM_INSTALL_TITLE"),
                $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/form/install/step2.php");
        }
    }

    function DoUninstall()
    {
        global $DB, $APPLICATION, $step;
        $FORM_RIGHT = $APPLICATION->GetGroupRight("form");
        if ($FORM_RIGHT=="W")
        {
            $step = IntVal($step);
            if ($step<2)
                $APPLICATION->IncludeAdminFile(GetMessage("FORM_UNINSTALL_TITLE"),
                $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/form/install/unstep1.php");
            elseif ($step==2)
                $APPLICATION->IncludeAdminFile(GetMessage("FORM_UNINSTALL_TITLE"),
                $_SERVER["DOCUMENT_ROOT"]."/bitrix/modules/form/install/unstep2.php");
        }
    }

    function GetModuleRightList()
    {
        global $MESS;
        $arr = array(
            "reference_id" => array("D","R","W"),
            "reference" => array(
                GetMessage("FORM_DENIED"),
                GetMessage("FORM_OPENED"),
                GetMessage("FORM_FULL"))
            );
        return $arr;
    }
}
?>

Module description

Example of a file describing the Web forms module

See Also