README

Contao 扩展：BirthdayLister

提供列出成员生日（过去、现在、即将到来）的模块。

安装

通过 composer 安装扩展： cliffparnitzky/birthday-lister。

如果您想手动安装，请在此处下载最新版本：https://github.com/cliffparnitzky/BirthdayLister/releases

跟踪器

https://github.com/cliffparnitzky/BirthdayLister/issues

兼容性

• 最低 Contao 版本：>= 3.2.0
• 最高 Contao 版本：< 3.6.0

依赖关系

此扩展依赖于以下扩展

• [friends-of-contao/contao-associategroups]

截图

CSS 类

• birthday_is_today : 标记生日在今天的项目
• member_is_inactive : 标记成员不活跃的项目
• birthday : 标记包含出生日期的列表项中的 span
• name : 标记包含姓名（名和姓）的列表项中的 span
• age : 标记包含年龄的列表项中的 span
• first, last : 标记第一个和最后一个列表项
• even, odd : 标记每个列表项为偶数或奇数

钩子

birthdayListerModifyBirthdayChildren

"birthdayListerModifyBirthdayChildren" 钩子在修改生日儿童列表时被触发。因此，可以进行自定义排序或删除生日儿童。它传递 $arrBirthdayChildren（生日儿童的数组），$modulConfig（模块配置以获取用户定义），它期望返回一个生日儿童的数组。

// config.php

$GLOBALS['TL_HOOKS']['birthdayListerModifyBirthdayChildren'][]   = array('MyClass', 'myModification');

// MyClass.php

class MyClass
{
	public function myModification($arrBirthdayChildren, $modulConfig)
	{
		if ($modulConfig->birthdayListPeriod == 'mySpecialPeriod')
		{
			// do custom modification here
		}
		return $arrBirthdayChildren;
	}
}

birthdayListerCheckBirthdayInPeriod

当检查生日是否在定义的期间内时，会触发 "birthdayListerCheckBirthdayInPeriod" 钩子。因此，可以添加自定义期间或进行自定义检查。它传递 $birthdayInPeriod（当前决定生日是否在期间），$modulConfig（模块配置以获取用户定义），$birthday（规范化到当前年份的出生日期），$birthdayChild（成员的数据库对象）。它期望返回一个布尔值（生日是否在期间）。

// config.php

$GLOBALS['TL_HOOKS']['birthdayListerCheckBirthdayInPeriod'][]   = array('MyClass', 'myPeriodCheck');

// MyClass.php

class MyClass
{
	public function myPeriodCheck($birthdayInPeriod, $modulConfig, $birthday, $birthdayChild)
	{
		if ($modulConfig->birthdayListPeriod == 'mySpecialPeriod')
		{
			// do custom checking here
		}
		return $birthdayInPeriod;
	}
}