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.
Checkdomain/Holiday requires php >= 5.3.
The easiest way to install this library is through composer. Just add the following lines to your composer.json file:
{
"require": {
"checkdomain/holiday": "dev-master"
}
}
Another way would be to download this library and configure the autoloading yourself. This library relies on a PSR-0 compatible autoloader for automatic class loading.
To check for holidays just instantiate the Util class and call the getHoliday
method.
$util = new \Checkdomain\Holiday\Util();
$holiday = $util->getHoliday('01.01.2014', 'DE');
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.
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.
Run a php composer.phar install
command in the base directory to install the phpunit
dependency. After that you can simply call vendor/bin/phpunit tests/
to run the test suite.