hansott/holidays

Returns the holidays for a country

Holidays

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Returns the holidays for a country., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require hansott/holidays, <sub>(*4)</sub>

## Supported countries and locales

* Belgium (BEL)
    * be-nl

Your country and/or locale not in the list? Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Usage

``` php
use HansOtt\Holiday\Factory;
use HansOtt\Holiday\Calendar\Year;

$factory = Factory::create();
$calendar = $factory->getCalendar('BEL');
$translator = $factory->getTranslator('BEL', 'nl-be');

$year = Year::current();
// or $year = new Year(2016);
$holidays = $calendar->getHolidays($year);
foreach ($holidays as $holiday) {
    $name = $translator->getName($holiday); // string
    $startsAt = $holiday->beginsAt(); // DateTimeImmutable
    $endsAt = $holiday->endsAt(); // DateTimeImmutable
    $formattedTime = $startsAt->format('l j F Y'); // string
    echo sprintf('%s -> %s', $name, $formattedTime) . PHP_EOL;
}

Output:, <sub>(*5)</sub>

Nieuwjaar -> Friday 1 January 2016
Paasmaandag -> Monday 28 March 2016
Feest Van De Arbeid -> Sunday 1 May 2016
Onze Lieve Heer Hemelvaart -> Monday 11 April 2016
Pinkstermaandag -> Wednesday 18 May 2016
Nationale Feestdag -> Thursday 21 July 2016
Onze Lieve Vrouw Hemelvaart -> Monday 15 August 2016
Allerheiligen -> Tuesday 1 November 2016
Wapenstilstand -> Friday 11 November 2016
Kerstmis -> Sunday 25 December 2016

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*6)</sub>

Testing

bash $ composer test, <sub>(*7)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*8)</sub>

Security

If you discover any security related issues, please email hansott at hotmail be instead of using the issue tracker., <sub>(*9)</sub>

Credits

• Hans Ott
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>