Download the PHP package reinbier/laravel-holiday without Composer
On this page you can find all versions of the php package reinbier/laravel-holiday. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download reinbier/laravel-holiday
More information about reinbier/laravel-holiday
Files in reinbier/laravel-holiday
Package laravel-holiday
Short Description Holidays in Laravel, the right way.
License MIT
Homepage https://github.com/reinbier/laravel-holiday
Informations about the package laravel-holiday
Custom holidays in Laravel
This package helps by providing a Holiday model in your project with all the holidays for a specific year.
By storing them in the database and automatically injected into Carbon via the
BusinessDay
package, you can simply see if a given Carbon instance
represents a holiday, via $carbon->isHoliday()
.
The benefits of the model are that you can easily add your own holidays. On top of that, the package can generate holidays for the current locale.
Use cases
An example would be when you want to show your store's opening hours. When echoing your opening hours for each day, you can check whether the given date is a holiday and say that you're closed this day.
Installation
You can install the package via composer:
You should publish and run the migrations:
Optionally, you can publish the config file with:
This is the contents of the published config file:
Usage
To generate local holidays for the current and next year, execute the command.
Subsequently, you could schedule this command to run yearly so your table will always hold data when working with the Holiday model.
To do that, place the following line into your Console/Kernel.php 'schedule' method:
Using the Facade
The LaravelHoliday
Facade gets automatically registered in the service container.
The facade is a singleton and will hold the current year's Holiday model.
It will set global holidays throughout your application so that you can check
any date for whether it's treated as a holiday according to your model.
The facade also provides you with a couple of methods:
Future holidays
If you don't want to be limited to only the current year's holidays, you can
fetch all future holidays as well using the helper method on the facade: getFutureHolidays()
.
Enable holidays in Carbon
The package can automatically apply your stored holidays to Carbon instances,
so that, whenever you need to check a date to be a holiday, you can
call ->isHoliday()
on that Carbon instance.
This setting is disabled by default. To enable this, set the value in the config holiday.php
.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-holiday with dependencies
cmixin/business-day Version ^1.16
illuminate/contracts Version ^9.0|^10.0|^11.0
spatie/laravel-package-tools Version ^1.14.0