/yasumi

Yasumi is an easy PHP Library for calculating national holidays

Primary LanguagePHPOtherNOASSERTION

Logo

GitHub Release Total Downloads Software License Build Status StyleCI Scrutinizer Code Quality

Important!

Yasumi version 2.0 has been released with support for PHP 7 only. As of January 2019 support for PHP 5 has ended.

For the previous code base (1.8.0) a separate support branch has been created that will only receive the most critical bug fixes (for those still using PHP 5). Please note that although v1.8.x works both in PHP 5 and PHP 7, the code base hasn't been upgraded to PHP 7.

It is highly recommended to upgrade to PHP7 and Yasumi v2.0.0 to enjoy the latest changes and improvements. More information can be found on the blog here: Yasumi Release v2

Introduction

Yasumi (Japanese for 'Holiday'「休み」) is an easy PHP library to help you calculate the dates and names of holidays and other special celebrations from various countries/states. Many services exist on the internet that provide holidays, however are either not free or offer only limited information. In addition, no complete PHP library seems to exist today that covers a wide range of holidays and countries, except maybe PEAR's Date_Holidays which unfortunately hasn't been updated for a long time.

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) so it's easy to add new holiday providers that calculate holidays. The methods of Yasumi can be used to get a holiday's date and name in various languages.

Documentation

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

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!

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.

Buy Me A Coffee

License

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