ngekoding/php-hari-libur

一个用于检查印度尼西亚公共假期的库

v2.0.0 2023-04-04 03:03 UTC

This package is auto-updated.

Last update: 2024-09-04 06:06:52 UTC


README

一个简单的库,用于帮助检查印度尼西亚的公共假期。

该库引用了https://publicholidays.co.id的数据源,但与此网站无任何关联。如果已经下载了公共假期数据,则可以在离线状态下使用此库。

安装

composer require ngekoding/php-hari-libur

使用示例

<?php
require 'vendor/autoload.php';

use Ngekoding\PhpHariLibur\Holiday;

$holiday = new Holiday('2020');

$date = '2020-01-01';
$isHoliday = $holiday->check($date);

echo $date.': '.$isHoliday; // Output: 2020-01-01: true

配置和函数

new Holiday($year, $local = FALSE, $defaultSunday = TRUE)

Holiday 构造函数有三个参数,$year 用于指定年份,$local 用于指定是否使用本地数据源,最后是 $defaultSunday 用于指定是否将星期日作为默认的公共假期。只有 $year 是必须填写的。

check($date, $bool = TRUE)

用于检查给定日期是否是公共假期的方法。我们可以指定返回布尔值(TRUE/FALSE)还是对象,格式如下

{
  "status": TRUE,
  "result": {
    "date": "2020-01-01",
    "description": "Hari libur awal tahun"
  }
}

addDefaultDay($day, $description)

用于根据星期名称(印度尼西亚格式)添加默认公共假期。例如,将星期二设为默认公共假期。

addDefaultDate($dateStart, $dateEnd = NULL, $description)

用于根据日期或日期范围(格式 Y-m-d)添加默认公共假期。例如,将2020年1月10日设为默认公共假期。

getHolidays()

用于获取所有公共假期(包括国家法定假日和默认日期)。

getDefaultDays()

用于获取所有根据名称定义的公共假期数据。

getDefaultDates()

用于获取所有已定义的公共假期数据。

许可证

MIT