Как при изменении в форме настроек своего модуля, запускать обработчик событий в Битрикс?

Question

[Александр]

Я пишу модуль в которым должен быть функционал логирования событий элементов highload-блоков, он должен фиксировать количество добавленных/измененных/удаленных элементов.

Подскажите, как при изменении настроек в модуле запускать обработчик события в Битрикс. В форме настроек я указываю highload блок для которого надо провести отслеживания событий (на изменение/удаление/редактирование).И далее при сохранении нужно чтобы Битрикс установил обработчик события только на выбранный в форме highload-блок.



Я предположил, что в файле install/index.php в методе InstallEvents надо обращаться к настройкам модуля, брать ID выбранного highload блока, но это сработает наверное только при установке модуля когда указан дефолтный highload-блок? Как быть в случае изменения настроек модуля, в каком файле должен располагаться такой обработчик?

Comments

[Ярослав Александров]

логирования событий элементов highload-блоков, он должен фиксировать количество добавленных/измененных/удаленных элементов.

Я если честно не видел в документации событий для highload https://dev.1c-bitrix.ru/api_help/main/events
Единственное, что вижу это можно зацепиться за события при работе с пользовательскими полями, так как highload-блоки используют поля

Как при изменении в форме настроек своего модуля, запускать обработчик событий в Битрикс?

- событий тоже таких не видел, тут как вариант запускать агент битрикс, который выполнить нужную функцию.

[Александр]

Ярослав Александров, запускать агент из модуля? События highload-блоков есть https://estrin.pw/bitrix-d7-snippets/s/orm-highloa... но тут вопрос как поставить обработчик события когда меняются настройки в модуле. Если бы это был обычный инфоблок как бы вы при изменении настроек в модуле указывали ему обработчик, точнее в каком файле модуля и в каком методе?

[Ярослав Александров]

Александр, по ссылке это по сути пользовательские события, вполне думаю рабочий вариант.
Тут есть примеры своих обработчиков в своих модуляхhttps://dev.1c-bitrix.ru/api_d7/bitrix/main/EventM...

точнее в каком файле модуля и в каком методе?

- ну вам нужно писать свой класс со своими методами.

как поставить обработчик события когда меняются настройки в модуле

- нужно продумывать, как вариант привязывать к кнопке "сохранить", дополнительно сравнивать старые значения настроек модуля с новыми

[PetrPo]

Александр, хз насколько это корректно, но как вариант - в ядре нашел событие OnAfterSetOption_.$name (параметр $value), его регистрируешь при установке модуля, в нем можно сделать unregister register событий для hl

[Александр]

Решил проблему, я сделал немного по другому у меня в файле options.php находится обработчик формы настройки модуля, а в файле lib/helper.php находится класс который и устанавливает обработчик на событие.

Так выглядит интерфейс настроек модуля


Из options.php когда идет обработка формы я вызываю у класса Helper (он находится в lib/helper.php) статический метод InstallHLEvents($hlId, $handler) который принимает ID highload блока и название события (OnBeforeAdd, OnBeforeDelete) и тд.

Вызов метода InstallHLEvents в файле

// регистрируем обработчики событий
	if($add_hlId){
		
		if($add_hlId != $remove_hlId){
			$handlers = [];
			switch ($add_handler_action) {
					case 'create':
						$handlers[0] = 'OnBeforeAdd';
						break;
					case 'update':
						$handlers[0] = 'OnBeforeUpdate';
						break;
					case 'delete':
						$handlers[0] = 'OnBeforeDelete';
						break;
					default:
						$handlers[0] ='OnBeforeAdd';
						$handlers[1] = 'OnBeforeUpdate';
						$handlers[2] = 'OnBeforeDelete';
					break;
			}

			// file_put_contents($_SERVER['DOCUMENT_ROOT'].'/log_iblock_setlog.txt', serialize($handlers)."\r\n", FILE_APPEND);
			foreach ($handlers as $handler) {
				$hlname = \Alexburov\Exportimport\Helper::InstallHLEvents($add_hlId, $handler);
			}
		}

Метод InstallHLEvents в файле Helper
код обработчика события

public static function InstallHLEvents($hlId, $handler){
        
        $entity = self::GetHLentity($hlId);
        $hlname = $entity->getName(); // получаем имя highload блока
        // $handler -  принимает значение OnBeforeAdd, OnBeforeUpdate, OnBeforeDelete, 
        $eventName = $hlname.$handler; // конкатинируем имя highload блока и название обработчика получаем имя события на который мы и ставим обработчик (метод класса Helper например OnBeforeUpdate)
        // регистрируем событие
        $eventManager = \Bitrix\Main\EventManager::getInstance();
        $eventManager->registerEventHandler("", $eventName, "alexburov.exportimport", "\Alexburov\Exportimport\Helper",$handler);
        return $eventName;
	}

Теперь я могу добавлять обработчики событий к highload-блокам или удалять их

UnInstallHLEvents в классе Helper

public static function UnInstallHLEvents($hlId, $handler){

        $entity = self::GetHLentity($hlId);
        $hlname = $entity->getName();

        $eventManager = \Bitrix\Main\EventManager::getInstance();
        $eventName = $hlname.$handler;
        $eventManager->unRegisterEventHandler(" ", $eventName, "alexburov.exportimport", "\Alexburov\Exportimport\Helper", $handler);
        return $eventName;
    }

Все работает в модуле !!!

Answer 1

[Илья]

Обработчика событий добавить в module/include.php, а сам модуль подключать в php_interface/init.php