Esta biblioteca permite que os desenvolvedores recuperem facilmente detalhes de feriados bancários no Reino Unido. Os feriados podem ser recuperados para Inglaterra e País de Gales, Escócia e Irlanda do Norte. As informações sobre esses feriados podem ser opcionalmente restritas por mês ou data.
Para instalar, basta executar o seguinte comando do compositor.
composer require rapidwebltd/php-uk-bank-holidays
Lembre-se de incluir o arquivo vendor/autoload.php
se sua estrutura não fizer isso para você.
A recuperação de feriados bancários para uma data específica pode ser feita da seguinte maneira. Por padrão, isso trará de volta os feriados da Inglaterra e do País de Gales.
use RapidWeb UkBankHolidays Factories UkBankHolidayFactory ;
$ holidays = UkBankHolidayFactory:: getByDate ( 2017 , 01 , 2 );
var_dump ( $ holidays );
Todos os métodos UkBankHolidayFactory
retornarão uma matriz de objetos UkBankHoliday
. O snippet a seguir mostra um objeto de exemplo para o feriado do Dia de Ano Novo de 2017, que ocorre no dia 2 de janeiro 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 contém um título para o feriado, a data em que ocorre e notas fornecidas pelo governo sobre o feriado, se disponíveis. Todos estes são acessíveis ao público.
Se desejar recuperar feriados bancários da Escócia ou da Irlanda do Norte, utilize o quarto argumento opcional, como segue.
$ 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 );
Você pode usar esta biblioteca para recuperar todos os feriados ou, alternativamente, feriados restritos por mês ou data. Isso é feito facilmente usando os métodos getAll
, getByMonth
e getByDate
respectivamente.
Veja os exemplos a seguir.
$ allHolidays = UkBankHolidayFactory:: getAll ();
$ januaryHolidays = UkBankHolidayFactory:: getByMonth ( 2017 , 01 );
$ newYearsHolidays = UkBankHolidayFactory:: getByDate ( 2017 , 01 , 2 );
Todos esses métodos aceitam um argumento opcional adicional para especificar o local dos feriados que você deseja recuperar. Para obter mais detalhes, consulte a seção de restrição de localização acima.