checkdomain / holiday
Checkdomain/Holiday provides a simple class to get holidays for a specified country
Installs: 338 742
Dependents: 2
Suggesters: 0
Security: 0
Stars: 49
Watchers: 7
Forks: 26
Open Issues: 1
Requires
- php: >=5.6
- ext-calendar: *
Requires (Dev)
- phpunit/phpunit: ^5.7 || ^6.0 || ^7.0
README
Checkdomain/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
- ๐ง๐ช BE Belgium
- ๐ง๐ท 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
- ๐ซ๐ท RE Rรฉunion
- ๐ท๐ด RO Romania
- ๐ธ๐ช SE Sweden
Your country is not supported?
checkdomain 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
Checkdomain/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": { "checkdomain/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 \Checkdomain\Holiday\Util(); $holiday = $util->getHoliday('DE', '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 need to know all holidays for a specific country you can instantiate one of the included providers yourself and call the getHolidaysByYear
method. All providers must follow the ProviderInterface
interface.
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