README

判断日本的休日和节假日，获取节假日名称

packagist

https://packagist.org.cn/packages/kanagama/holidays

使用方法

使用composer安装

# install の場合
composer require kanagama/holidays

# update の場合
composer update -w kanagama/holidays

只需在想要使用的类中使用use即可

use Kanagama\Holidays\Holidays;

方法列表

checkPublicHoliday(int $year, int $month, int $day): bool

如果指定日是节假日则返回true

$holidays = new Holidays();
// true （春分の日）
$holiday = $holidays->checkPublicHoliday(2023, 3, 21);

getPublicHolidayName(int $year, int $month, int $day): ?string

返回指定日的节假日名称。如果指定日不是节假日则返回null。

$holidays = new Holidays();
// 春分の日
$holidayName = $holidays->getPublicHolidayName(2023, 3, 21);

checkHoliday(int $year, int $month, int $day): bool

如果指定日是节假日或周末则返回true。

$holidays = new Holidays();
// true （土曜）
$holiday = $holidays->checkHoliday(2023, 3, 19);

checkDayBeforePublicHoliday(int $year, int $month, int $day): bool

如果指定日是节假日前一天则返回true。

$holidays = new Holidays();
// true （翌日が春分の日）
$holiday = $holidays->checkDayBeforePublicHoliday(2023, 3, 20);

checkDayAfterPublicHoliday(int $year, int $month, int $day): bool

如果指定日是节假日后一天则返回true。

$holidays = new Holidays();
// true （前日が春分の日）
$holiday = $holidays->checkDayAfterPublicHoliday(2023, 3, 22);

addPublicHoliday(int $year, int $month, int $day, string $holidayName): void

将指定日设置为自定义节假日。如果已设置为节假日，则将覆盖。

$holidays = new Holidays();
$holidays->addPublicHoliday(2023, 3, 20, '設立記念日');

※其他函数也会同样判断指定日是否为节假日。getPublicHolidayName()也可以获取名称。

所有方法都可以静态调用

# example
$result = Holidays::checkPublicHoliday(2023, 3, 21);
$result = Holidays::getPublicHolidayName(2023, 3, 21);
$result = Holidays::checkHoliday(2023, 3, 21);
$result = Holidays::checkDayBeforePublicHoliday(2023, 3, 21);
$result = Holidays::checkDayAfterPublicHoliday(2023, 3, 21);
$result = Holidays::addPublicHoliday(2023, 3, 20, '設立記念日');

开发

make test-build

构建测试容器

make test

启动各个PHP版本的容器以执行测试

make development-build

构建开发容器

make development

启动开发容器