README

此库允许开发者轻松检索英国银行假日详情。可以检索英格兰和威尔士、苏格兰以及北爱尔兰的假日信息。这些假日的相关信息可以根据月份或日期进行限制。

安装

要安装，只需运行以下composer命令。

composer require rapidwebltd/php-uk-bank-holidays

请记住，如果你的框架没有为你这样做，请包含vendor/autoload.php文件。

使用方法

检索特定日期的银行假日可以按以下方式完成。默认情况下，这将返回英格兰和威尔士的假日。

use RapidWeb\UkBankHolidays\Factories\UkBankHolidayFactory;

$holidays = UkBankHolidayFactory::getByDate(2017, 01, 2);

var_dump($holidays);

UKBankHoliday对象

所有UkBankHolidayFactory方法都将返回一个UkBankHoliday对象的数组。以下代码示例展示了2017年新年银行假日的示例对象，该假日在2017年1月2日。

array(1) {
  [0]=>
  object(RapidWeb\UkBankHolidays\Objects\UkBankHoliday)#46 (4) {
    ["title"]=>
    string(16) "New Year’s Day"
    ["date"]=>
    string(10) "2017-01-02"
    ["notes"]=>
    string(14) "Substitute day"
  }
}

此对象包含假日的标题、发生日期以及有关假日的政府提供的备注（如果有的话）。所有这些都是公开可访问的。

位置限制

如果您想检索苏格兰或北爱尔兰的银行假日，请使用第四个可选参数，如下所示。

$englandWalesHolidays = UkBankHolidayFactory::getByDate(2017, 01, 2, 'england-and-wales');
$scotlandHolidays = UkBankHolidayFactory::getByDate(2017, 01, 2, 'scotland');
$northernIrelandHolidays = UkBankHolidayFactory::getByDate(2017, 01, 2, 'northern-ireland');

$allHolidays = array_merge($englandWalesHolidays, $scotlandHolidays, $northernIrelandHolidays);

基于日期的限制

您可以使用此库检索所有假日，或者使用getAll、getByMonth和getByDate方法分别检索按月份或日期限制的假日。

请参阅以下示例。

$allHolidays = UkBankHolidayFactory::getAll();
$januaryHolidays = UkBankHolidayFactory::getByMonth(2017, 01);
$newYearsHolidays = UkBankHolidayFactory::getByDate(2017, 01, 2);

这些方法都接受一个额外的可选参数，用于指定您要检索假日的位置。有关更多详细信息，请参阅上述位置限制部分。