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



Плагин позволяет выводит следующие поздравления:

1. Залогиненому пользователю, у которого сегодня день рождения.
Данное поздравление является персональным и его видит только сам именниник

2. Пользователям, у которых сегодня ДР.
Плагин формирует список пользователей у которых сегодня ДР и показывает его всем пользователям (кроме самих именниников). Список формируется на основе параметра дружбы и рейтинга. Для каждого пользователя может быть сформирован уникальный список поздравлянтов.

3. Пользователи, у которых завтра ДР.
Плагин формирует список пользователей у которых завтра ДР и показывает его всем пользователям (кроме самих именниников). Список формируется на основе параметра дружбы и рейтинга. Для каждого пользователя может быть сформирован уникальный список поздравлянтов.

4. Всем пользователям с праздником, который указан в конфиге.

Для всех поздравлений можно задавать набор случайных поздравлений.

Тексты поздравлений задаются в файле classes/lib/congratulation._language_.php, где _language_. — текущий выбранный язык. По умолчанию с плагином идет classes/lib/congratulation.russian.php с некоторыми заданными поздравлениями.

Праздники указываются в стандартном конфигурационным файле config/config.php. В файле есть пример задания своего праздника.

Отдельно стоит сказать об алгоритме выбора пользователей, которые будут отображены в списке тех, кого поздравляем (для ДР). Список юбиляров сортируется по рейтингу, при этом если именниник является другом пользователя, то рейтинг для сортировки будет умножен на заданный коэффециент. Так же можно «отрезать» не друзей с рейтингом, ниже заданного.
Таким образом в список юбиляров попадают либо наиболее популярные пользователи сайта, либо друзья пользователя, который просматривает сайт в данный момент.

Обновление 1.1.0 — «Теперь и с письмами»

В плагин добавлена возможность отправлять письма именниникам.

Шаблоны писем и их заголовки можно самостоятельно задавать в конфигурационном файле classes/lib/letters._language_.php (где _language_. — текущий выбранный язык). В файле содержится список заголовков и шаблонов для каждго пола, а так же секция с обшими поздравлениями common:

	'common' => array(
			'subjects'	=> array(
				'С днем рождения!',
				'Поздравляем от имени сайта!'			
			),
			'templates' => array(
				'birthday_common.tpl'
			)			
	)

Для пользователей с неопределенным полом (other) — в основном конфиге плагина можно запретить или разрешить использование мужских поздравлений:

$config['birthday_letter_other_as_man'] = false;

Шаблон письма для конктретного пользователя выбирается случайным образом из объединения множества шаблонов для пола и секции common.

Сами шаблоны писем должны распологать в дирректории plugins/congratulation/templates/skin/default/notify/_language_/ (где _language_. — текущий выбранный язык). В конфиге имя конфигурационного файла указывается относительно именно этой директории.
В шаблон передается объект oUser, который содержит поздравляемого пользователя.

Плагин позволяет фильтровать поздравляемых пользователей по минимальному рейтингу и по минимальному числу дней с момента регистрации:

$config['birthday_filters'] = array(
	'min_rating' => 0,
	'min_days_registered' => 0		
);

Отправку писем осуществляет скрипт plugins/congratulation/cron/sendCongratulation.php. Его нужно прописать в cron на нужно время. Скрипт НЕ отслеживает кому поздравление было отправлено, а кому — нет. Поэтому запускать его нужно только ОДИН раз в сутки.

В момент отправки также вызывается хук send_congratulation с параметром oUser, который содержит поздравляемого пользователя. Это сделано для аккуратного самостоятельного расширения дейсвтвий по поздравлению пользователя.