README

日本の休日・祝日判定・祝日の名称を取得

packagist

https://packagist.org/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

開発用コンテナを起動

kanagama / holidays

Maintainers

Details