Esta biblioteca permite a los desarrolladores recuperar fácilmente los detalles de los días festivos del Reino Unido. Se pueden recuperar los días festivos de Inglaterra y Gales, Escocia e Irlanda del Norte. La información sobre estos días festivos se puede restringir opcionalmente por mes o fecha.
Para instalar, simplemente ejecute el siguiente comando del compositor.
composer require rapidwebltd/php-uk-bank-holidays
Recuerde incluir el archivo vendor/autoload.php
si su marco no lo hace por usted.
La recuperación de días festivos para una fecha específica se puede realizar de la siguiente manera. De forma predeterminada, esto traerá vacaciones de Inglaterra y Gales.
use RapidWeb UkBankHolidays Factories UkBankHolidayFactory ;
$ holidays = UkBankHolidayFactory:: getByDate ( 2017 , 01 , 2 );
var_dump ( $ holidays );
Todos los métodos UkBankHolidayFactory
devolverán una matriz de objetos UkBankHoliday
. El siguiente fragmento muestra un objeto de ejemplo para el feriado bancario del día de Año Nuevo de 2017, que ocurre el 2 de enero de 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 "
}
}
Este objeto contiene un título para el feriado, la fecha en que ocurre y notas proporcionadas por el gobierno sobre el feriado, si están disponibles. Todos estos son de acceso público.
Si desea recuperar los días festivos de Escocia o Irlanda del Norte, utilice el cuarto argumento opcional, como se indica a continuación.
$ 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 );
Puede utilizar esta biblioteca para recuperar todos los días festivos o, alternativamente, los días festivos restringidos por mes o fecha. Esto se hace fácilmente usando los métodos getAll
, getByMonth
y getByDate
respectivamente.
Vea los siguientes ejemplos.
$ allHolidays = UkBankHolidayFactory:: getAll ();
$ januaryHolidays = UkBankHolidayFactory:: getByMonth ( 2017 , 01 );
$ newYearsHolidays = UkBankHolidayFactory:: getByDate ( 2017 , 01 , 2 );
Todos estos métodos aceptan un argumento opcional adicional para especificar la ubicación de los días festivos que desea recuperar. Para obtener más detalles, consulte la sección de restricción de ubicación anterior.