このライブラリを使用すると、開発者は英国の銀行休業日の詳細を簡単に取得できます。イングランドとウェールズ、スコットランド、北アイルランドの祝日を検索できます。これらの休日に関する情報は、必要に応じて月または日付によって制限できます。
インストールするには、次の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 );
すべてのUkBankHolidayFactory
メソッドは、 UkBankHoliday
オブジェクトの配列を返します。次のスニペットは、2017 年 1 月 2 日に発生する 2017 年の元旦の祝日のオブジェクトの例を示しています。
array ( 1 ) {
[ 0 ]=>
object(RapidWebUkBankHolidaysObjectsUkBankHoliday) #46 (4) {
[ " title " ]=>
string( 16 ) " New Year’s Day "
[ " date " ]=>
string( 10 ) " 2017-01-02 "
[ " notes " ]=>
string( 14 ) " Substitute day "
}
}
このオブジェクトには、休日のタイトル、その日付、および可能な場合は休日に関する政府提供のメモが含まれます。これらはすべて一般に公開されています。
スコットランドまたは北アイルランドから祝日を取得したい場合は、次のように 4 番目のオプションの引数を使用します。
$ 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 );
これらのメソッドはすべて、取得する休日の場所を指定するための追加のオプション引数を受け入れます。詳細については、上記の場所制限のセクションを参照してください。