cludy-me / holiday
cludy-me/holiday provides a simple class to get holidays for a specified country
Requires
- php: >=7.0
- ext-calendar: *
Requires (Dev)
- phpunit/phpunit: ^5.7 || ^6.0 || ^7.0
README
cludy-me/holiday is a small library to check if a specified date is a holiday in a specific country. It also tells you if the given date is a nation wide holiday or just a holiday in some states.
Currently supported countries
- 🇦🇹 AT Austria
- 🇧🇷 BR Brazil
- 🇩🇪 DE Germany
- 🇩🇰 DK Denmark
- 🇪🇪 EE Estonia
- 🇫🇷 FR France
- 🇭🇺 HU Hungary
- 🇮🇹 IT Italy
- 🇱🇹 LT Lithuania
- 🇱🇺 LU Luxembourg
- 🇱🇻 LV Latvia
- 🇳🇴 NO Norway
- 🇵🇱 PL Poland
- 🇵🇹 PT Portugal
- 🇷🇴 RO Romania
- 🇸🇪 SE Sweden
Your country is not supported?
cludy-me/holiday is open source. If you use this library it would be great to get some support for currently not implemented countries which you are familiar with. Pull requests will be reviewed and merged fast.
To create a new Provider please see the ProviderInterface interface.
Requirements
OpenDroplet/holiday requires php >= 5.5.
Installation
The easiest way to install this library is through composer. Just add the following lines to your composer.json file:
{
"require": {
"cludy-me/holiday": "~3.0.0"
}
}
Another way would be to download this library and configure the autoloading yourself. This library relies on a PSR-4 compatible autoloader for automatic class loading.
Usage
To check for holidays just instantiate the Util class and call the getHoliday method.
$util = new \OpenDroplet\Holiday\Util('LT'); $holiday = $util->getHoliday('2014-01-01');
or
$holiday = \OpenDroplet\Holiday\Util::make('LT')->getHoliday('2014-01-01');
If you just need to know if there is a holiday on your date there is a isHoliday method, too.
If you just need to know if there is a weekend on your date there is a isWeekend method, too.
If you just need to know if there is a business day on your date there is a isBusinessDay method, too.
If you need to know all holidays for a specific country:
$holidays = \OpenDroplet\Holiday\Util::make('LT')->getHolidays('2014');
Running Tests
Run a php composer.phar install command in the base directory to install the phpunit dependency. After that you can simply call php vendor/bin/phpunit to run the test suite.
To run specific test class call php vendor/bin/phpunit --filter TestClassName