topaz/holidays

Fetches Google calendar public holidays

v1.01 2021-08-16 23:32 UTC

Requires

• ext-json: *
• symfony/dotenv: ^5.3

Requires (Dev)

• phpunit/phpunit: ^9
• roave/security-advisories: dev-latest

MIT

• Temitope Olotin

README

This package uses the Google Calendar API to fetch public holidays. The data always comes with 3 years data; the previous year, the current year and next year.

How to use

• composer require topaz/holidays
• Register for an API key on Google console https://phpcoder.tech/get-list-of-holidays-using-google-calendar-api/
• Add your key [GOOGLE_CALENDAR_API_KEY] to your .env file
• Import LazHoliday\PublicHoliday

Sample Usage

<?php
require_once 'vendor/autoload.php';

use LazHoliday\PublicHoliday;

try {
    $holiday = new PublicHoliday();
    var_dump($holiday->fetch('usa')->getDataForYear(2021));
} catch (Exception $e) {
    var_dump($e->getMessage());
}

Available methods

• fetch(string $country): PublicHoliday - Get all the calendar data when a country is passed
• getData(): array - Return all the 3 years calendar data with some info
• getItems(): array - Return all the 3 years calendar data
• getDataForYear(int $year): array - Filter holiday data by year
• getSummary(): array - Get the summary and dates of the holidays

Country codes

https://gist.github.com/seanblanchfield/4df78d73c85b149133615c7953894076

License

This project uses the MIT License feel free to contribute.