From In-Portal Developers Guide

Revision as of 16:19, 28 February 2009

Unit Configs
Статьи в этой категории
Unit Configuration File Registration of Unit Classes Defining Database, Virtual and Calculated Fields Formatters Hooks Regular Events Using "TitlePresets" Option

В K4 существует механизм, позволяющий выполнять требуемые события в системе на регулярной основе. Т.е. вызывать указанное событие раз в N секунд. Есть 2 способа вызова (когда их вызывает система) данных событий:

• из скрипта "tools/cron.php";
• до или после показывания содержания страницы пользователю.

У каждого из этих способов есть свои плюсы и минусы, зная которые можно вернее принять решение о том, какой из них использовать. Переключаться можно способом вызова регулярных событий можно используя опцию UseCronForRegularEvent в конфигурации сайта.

С использованием cron

Неоспоримым плюсом при использовании cron является то, что пользователи, заходящие на сайт не будут ждать выполнения долгих регулярных событий. Этот способ хорошо подходит для случаев, когда результат работы регулярного события не сразу можно увидеть на сайте. Хорошим примером этому может служить регулярное событие, которое обновляет рейтинг пользователей. Пользователей на сайте может быть много, а пересчёт их рейтинга при заходе других пользователей на сайт может занять значительное время. В результате увеличится время, требуемое для показывания странички пользователю и он просто может уйти с сайта не дождавшись результата. Если для обработки регулярных событий использовать cron, то этой проблемы не будет.

Длй настройки cron на сайте требуется добавить следующую команду в файл crontab (используя команду "crontab -e") текущего пользователя:

wget http://server_address/tools/cron.php -O /dev/null > /dev/null 2>&1

• server_address - это путь, который используется для захода на сайт из браузера (напр. "alex.prod.intechnic.lv/test_project").

В этом случае регулярные события не будут выполняться при заходе на сайт, а будут выполняться при вызове файла "tools/cron.php" (брать из In-Portal).

Без использования cron

Если cron не используется или его не представляется возможным включить на сайте, то можно воспользоваться способом вызова регулярных событий по умолчанию. Данных способ сильно уступает ранее описанному, но не требует никакой дополнительной настройки сайта и доступен каждому. В более поздних версия K4 можно ставить after hook на события:

• adm:OnStartup - для выполнения событий до показывания страницы (с версии 4.0.0);
• adm:OnBeforeShutdown - для выполнения событий после показывания страницы (с версии 4.2.1).

Если требуется, чтобы событие выполнялось всегда (в случае с регулярными событиями оно выполняется раз в N секунд), то рекомендуется использовать этот подход.

Пример

Для того, чтобы добавить новое регулярное событие его надо сначала написать, а потом в его unit config в опции RegularEvents добавить новый ключ:

'RegularEvents' => Array (
	'membership_expiration' => Array ('EventName' => 'OnCheckExpiredMembership', 'RunInterval' => 1800, 'Type' => reAFTER),
),

Название ключа должно быть уникальным среди всех зарегистрированных в системе регулярных событий.