RegisterModuleDependences

Описание и параметры

RegisterModuleDependences(
	string from_module_id,
	string MESSAGE_ID,
	string to_module_id,
	string to_class = "",
	string to_method = "",
	int sort = 100,
	TO_PATH="",
	TO_METHOD_ARG = array()
);

Регистрирует обработчик события. Выполняется один раз (при установке модуля) и этот обработчик события действует до момента вызова события UnRegisterModuleDependences.

Аналог функции в новом ядре: Bitrix\Main\EventManager::registerEventHandler.

Параметры функции

Параметр	Описание	С версии
from_module_id	Идентификатор модуля, который будет инициировать событие.
MESSAGE_ID	Идентификатор события.
to_module_id	Идентификатор модуля, содержащий функцию-обработчик события.
to_class	Класс принадлежащий модулю module, метод которого является функцией-обработчиком события. Необязательный параметр. По умолчанию - "" (будет просто подключен файл /bitrix/modules/to_module_id/include.php).
to_method	Метод класса to_class являющийся функцией-обработчиком события. Необязательный параметр. По умолчанию - "" (будет просто подключен файл /bitrix/modules/to_module_id/include.php).
sort	Очередность (порядок), в котором выполняется данный обработчик (обработчиков данного события может быть больше одного). Необязательный параметр, по умолчанию равен 100.	3.0.10
TO_PATH	Необязательный параметр, по умолчанию пустой. Подключает файл по указанному пути (с функцией обработчика) без подключения модуля. Это позволяет создавать более экономные обработчики.	5.1.0
TO_METHOD_ARG	Массив аргументов для функции-обработчика событий. Необязательный параметр.	8.5.0

Смотрите также

Примеры использования

<?
// Для того, чтобы при удалении пользователя сайта 
// производилась соответствующая очистка данных форума, 
// при установке форума выполняется регистрация нового 
// обработчика события "OnUserDelete" модуля main. 
// Этим обработчиком является метод OnUserDelete класса CForum модуля forum.

RegisterModuleDependences("main", "OnUserDelete", "forum", "CForum", "OnUserDelete");
?>

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Денис Максимов 14.10.2022 10:55:33

Сообщение не промодерировано, возможны ошибки и неточности.

Цитата

to_class Класс принадлежащий модулю module, метод которого является функцией-обработчиком события.
Необязательный параметр. По умолчанию - "" (будет просто подключен файл /bitrix/modules/to_module_id/include.php).

to_method Метод класса to_class являющийся функцией-обработчиком события.
Необязательный параметр. По умолчанию - "" (будет просто подключен файл /bitrix/modules/to_module_id/include.php).

это не работает, файл include.php не подключается

Дмитрий Кубицкий 16.05.2012 12:37:35

Задача: Добавить выполнение функции на событие в своем модуле для Marketplace

Решение:

Код

//Работа с базой данных при установке

function InstallDB($arModuleParams = array()) 
{
   RegisterModule("mymodule");
   RegisterModuleDependences("iblock", "OnBeforeIblockElementAdd", "mymodule", "CMyModuleClass", "MyTriggerFunction");

        ...
}
...

//Работа с базой данных при деинсталляции модуля

function UnInstallDB()
{
   COption::RemoveOption("mymodule");
   UnRegisterModuleDependences("iblock", "OnBeforeIblockElementAdd", "mymodule", "CMyModuleClass", "MyTriggerFunction");
   UnRegisterModule("mymodule");
   
   return true;
}

0 Антон Долганин 04.10.2010 12:48:43
Следует указать, что данный метод тяжеловат для обычного использования: http://dev.1c-bitrix.ru/community/forums/messages/forum6/topic28942/message159479/#message159479

Наверх