holidayapi / holidayapi-php
Official PHP library for Holiday API
4.0.0
2023-11-06 18:43 UTC
Requires
- php: >=8.0
- ext-curl: *
- ext-json: *
Requires (Dev)
- phpunit/phpunit: ^9.0
README
Official PHP library for Holiday API providing quick and easy access to holiday information from applications written in PHP.
Documentation
Full documentation of the Holiday API endpoints is available here.
Installation
composer require holidayapi/holidayapi-php
Usage
<?php $key = 'Insert your API key here'; $holiday_api = new \HolidayAPI\Client(['key' => $key]); try { // Fetch supported countries and subdivisions $countries = $holiday_api->countries(); // Fetch supported languages $languages = $holiday_api->languages(); // Fetch holidays with minimum parameters $holidays = $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, ]); var_dump($countries, $languages, $holidays); } catch (Exception $e) { var_dump($e); }
Examples
Countries
Fetch all supported countries
<?php $holiday_api->countries();
Fetch only countries with public holidays
<?php $holiday_api->countries([ 'public' => true, ]);
Fetch a supported country by code
<?php $holiday_api->countries([ 'country' => 'NO', ]);
Search for countries by code or name
<?php $holiday_api->countries([ 'search' => 'united', ]);
Languages
Fetch all supported languages
<?php $holiday_api->languages();
Fetch a supported language by code
<?php $holiday_api->languages([ 'language' => 'es', ]);
Search for languages by code or name
<?php $holiday_api->languages([ 'search' => 'Chinese', ]);
Holidays
Fetch holidays for a specific year
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, ]);
Fetch holidays for a specific month
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'month' => 7, ]);
Fetch holidays for a specific day
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'month' => 7, 'day' => 4, ]);
Fetch upcoming holidays based on a specific date
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'month' => 7, 'day' => 4, 'upcoming' => true, ]);
Fetch previous holidays based on a specific date
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'month' => 7, 'day' => 4, 'previous' => true, ]);
Fetch only public holidays
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'public' => true, ]);
Fetch holidays for a specific subdivision
<?php $holiday_api->holidays([ 'country' => 'GB-ENG', 'year' => 2019, ]);
Include subdivision holidays with countrywide holidays
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'subdivisions' => true, ]);
Search for a holiday by name
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'search' => 'New Year', ]);
Translate holidays to another language
<?php $holiday_api->holidays([ 'country' => 'US', 'year' => 2019, 'language' => 'zh', // Chinese (Simplified) ]);
Fetch holidays for multiple countries
<?php $holiday_api->holidays([ 'country' => 'US,GB,NZ', 'year' => 2019, ]); $holiday_api->holidays([ 'country' => ['US', 'GB', 'NZ'], 'year' => 2019, ]);
Workday
Fetch workday 7 business days after a date
<?php $holiday_api->workday([ 'country' => 'US', 'start' => '2019-07-01', 'days' => 7, ]);
Workdays
Fetch number of workdays between two dates
<?php $holiday_api->workdays([ 'country' => 'US', 'start' => '2019-07-01', 'end' => '2019-07-10', ]);