octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Introduction

Yasumi (Japanese for 'Holiday'「休み」) is the easy PHP library that helps you retrieve the dates and names of holidays and other special celebrations from various countries/states. It is calculation and rule driven avoiding the need of a comprehensive database.

Many services exist that can provide holiday information, however are either not entirely free or only offer limited information. In addition, no exhaustive PHP library exists today covering a wide range of holidays and countries. PEAR's Date_Holidays library was a similar attempt, however it hasn't been updated for a long time.

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Highlights

The goal of Yasumi is to be powerful while remaining lightweight, by utilizing PHP native classes wherever possible. Yasumi's calculation is provider-based (i.e. by country/state), making it easy to add new holiday providers that calculate holidays.

• Pure PHP
• Straightforward API
• Framework-agnostic
• Use of Providers to easily extend and expand new Holidays
• Common Holiday Providers
• Accounts for the date/time when holidays have been officially established and/or abolished
• Filters enabling to easily select certain holiday types (Official, Observed, Bank, Seasonal or Other)
• Global Translations
• Time zone aware
• Implements ArrayIterator to easily process a provider's holidays
• Fully documented
• Fully unit tested
• Composer ready, PSR-12 and PSR-4 compliant

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Documentation

Yasumi’s documentation is available on https://www.yasumi.dev. You will find all the necessary information how to install Yasumi and also recipes how you can use Yasumi in your project.

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Blog

Checkout the blog section on documentation site regularly for latest updates. Keeping you informed about any news, releases, etc. in a handy blog post format!

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Contributing

Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on GitHub :) Create Github Issues for bugs and new features and comment on the ones you are interested in.

If you enjoy what I am making, an extra cup of coffee is very much appreciated :). Your support helps me to put more time into Open-Source Software projects like this.

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">License

Yasumi is open-source software licensed under the MIT License (MIT). Please see LICENSE for more information.

OPEN ISSUES

RELEASES