base on Calculate which days you don't have to work! # Calculate public holidays for a country [](https://packagist.org/packages/spatie/holidays) [](https://github.com/spatie/holidays/actions/workflows/run-tests.yml) [](https://packagist.org/packages/spatie/holidays) This package can calculate public holidays for a country. ```php use Spatie\Holidays\Holidays; // returns an array of Belgian holidays // for the current year $holidays = Holidays::for('be')->get(); ``` ## Support us [<img src="https://github-ads.s3.eu-central-1.amazonaws.com/holidays.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/holidays) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). ## Installation You can install the package via composer: ```bash composer require spatie/holidays ``` ## Supported countries We support the countries listed in [this directory](https://github.com/spatie/holidays/tree/main/src/Countries). If you want to add a country, please create a pull request. ## Usage You can get all holidays for a country by using the `get` method. ```php use Spatie\Holidays\Holidays; use Spatie\Holidays\Countries\Belgium; // returns an array of Belgian holidays // for the current year $holidays = Holidays::for(Belgium::make())->get(); ``` Alternatively, you could also pass an [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) code to the `for` method. In case of region based holidays, these will not be included. Use a country class instead. ```php use Spatie\Holidays\Holidays; // returns an array of Belgian holidays // for the current year $holidays = Holidays::for('be')->get(); ``` ### Getting holidays for a specific year You can also pass a specific year. ```php use Spatie\Holidays\Holidays; $holidays = Holidays::for(country: 'be', year: 2024)->get(); ``` ### Getting holidays between two dates You can also get all holidays between two dates (inclusive). ```php use Spatie\Holidays\Holidays; $holidays = Holidays::for('be')->getInRange('2023-06-01', '2024-05-31'); ``` ### Getting holidays in a specific language ```php $holidays = Holidays::for(country: 'be', locale: 'fr')->get(); ``` If the locale is not supported for a country, an exception will be thrown. ### Determining if a date is a holiday If you need to see if a date is a holiday, you can use the `isHoliday` method. ```php use Spatie\Holidays\Holidays; Holidays::for('be')->isHoliday('2024-01-01'); // true ``` ### Getting the name of a holiday If you need the name of the holiday, you can use the `getName` method. ```php use Spatie\Holidays\Holidays; Holidays::for('be')->getName('2024-01-01'); // Nieuwjaar ``` ### Determining whether a country is supported To verify whether a country is supported, you can use the `has` method. ```php use Spatie\Holidays\Holidays; Holidays::has('be'); // true Holidays::has('unknown'); // false ``` ## Contributing This is a community driven package. If you find any errors, please create a pull request with the fix, or at least open an issue. ## Adding a new country 1. Create a new class in the `Countries` directory. It should extend the `Country` class. 2. Add a test for the new country in the `tests` directory. 3. Run the tests so a snapshot gets created. 4. Verify the result in the newly created snapshot is correct. 5. If the country has multiple languages, add a file in the `lang/` directory. In case your country has specific rules for calculating holidays, for example region specific holidays, you can pass this to the constructor of your country class. ```php $holidays = Holidays::for(Germany::make('DE-BW'))->get(); ``` The value, `DE-BW`, will be passed to the region parameter of the constructor of a country. ```php class Germany extends Country { protected function __construct( protected ?string $region = null, ) { } protected function allHolidays(int $year): array { // Here you can use $this->region (or other variables) to calculate holidays } ``` Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for more details. ## Testing ```bash composer test ``` ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Security Vulnerabilities Please review [our security policy](../../security/policy) on how to report security vulnerabilities. ## Credits - [Niels Vanpachtenbeke](https://github.com/Nielsvanpach) - [Freek Van der Herten](https://github.com/freekmurze) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ", Assign "at most 3 tags" to the expected json: {"id":"7063","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"