Как создать агента в своём модуле?

Question

[Иван Фотьев]

Здравствуйте. Я разрабатываю модуль и мне необходимо во время установки модуля создать агент. Для создания агента использую CAgent::AddAgent() в данный метод нужно передать класс и функцию, которую будут запускать агент. Где необходимо расположить их в структуре модуля?

Answer 1

[Андрей Николаев]

А в чем собственно вопрос? Делайте как по документации

1) При установки модуля добавляем агент:

\CAgent::AddAgent( "\\Your\\Module\\SuperClass::superAgent();", "your.module", "N", 10 * 24 * 3600, "", "Y");

где
"\\Your\\Module\\SuperClass::superAgent();" - код php который должен выполняться (точка с запятой в конце строго!!!)
"your.module" - название вашего модуля
"N" - периодичность
10 * 24 * 3600 = периодичность запуска
'' - первая дата проверки (оставлять пустой)
"Y" - активность агента

2) При удалении - очищаем агенты
\CAgent::RemoveModuleAgents("your.module");
3) Если файлы располагаются по канонам d7 ( /your.module/lib/superclass.php ), то ничего больше делать не нужно, если старый - то нужно прописать в include.php автолоадер для вашего класса с агентом

Comments

[irchik15]

помогите, пожалуйста, разобраться
пишу
prntscr.com/hgwlfj
в include.php prntscr.com/hgwlq9
класс prntscr.com/hgwmu5
а при установке модуля пишет
Fatal error: Call to undefined function MinPrice() in /home/bitrix/ext_www/bitrix.smsdesign.com.ua/bitrix/modules/main/classes/mysql/agent.php(161) : eval()'d code on line 1

причем, когда вставляла класс сразу в include.php без CModule::AddAutoloadClasses после установки модуля агент создавался, но повторно не запускался

[Андрей Николаев]

irchik15, Вы немного не поняли. Агент - статичная функция, которая исполняется и возвращает либо пустую строку (ничего, false), либо саму себя (строка), которая будет выполнена через eval().

Т.е. файл /modules/sms.shop/classes/smsshop.php:

class SmsShop
{
	public static function minPrice()
	{
		
		// Какие-то полезные действия

		return "";

		// Если нужно вызвать функция еще раз, 
		// т.е. не разовый агент, а постоянный
		// return "SmsShop::minPrice();"
	}
}

И соответственно агент у Вас должен быть не MinPrice();, а SmsShop::minPrice(); (обращаю внимание на запятые).

Но я бы использовал новый синтаксис (d7), если это позволяет.
В таком случае Вы смогли бы давать понятные имена.

Например: для модуля на d7, сам агент \Sms\Shop\Agent::checkMinPrice(); (где в данном случае Sms - код vendor'а, Shop - название модуля, Agent название класса), должен был бы иметь пустой include.php, и лишь файл /modules/sms.shop/lib/agent.php, отформатированный по правилу:

namespace Sms\Shop;

class Agent
{
	public static function minPrice()
	{
		
		// Какие-то полезные действия

		return "";

		// Если нужно вызвать функция еще раз, 
		// т.е. не разовый агент, а постоянный
		// return "\\Sms\\Shop\\Agent::minPrice();"
	}
}

Примечание: у агентов есть ограничения, помните об этом.

Answer 2

[Александр Филиппенко]

Не важно по сути. Проверьте только чтобы функция - агент была доступна при подключении модуля.

Answer 3

[Алексей Емельянов]

Где необходимо расположить их в структуре модуля?

Как минимум в include.php.

Comments

[Иван Фотьев]

Если расположить в include.php функция будет запускаться на каждом хите. А мне нужно один раз в неделю.

[Ильдар Гизетдинов]

Иван Фотьев, расположение функции не означает что она будет вызвана при хите. Вот если её там вызвать - тогда да

[Алексей Емельянов]

Иван Фотьев,

Если расположить в include.php функция будет

доступна при подключении вашего модуля.