LaraHolidays

• Installation
• Usage
  • IsWorkDay
  • IsWeekendDay
  • IsHolidayDay
  • GetPreviousWorkDay
  • GetNextWorkDay
  • AdjustToPreviousWorkDayTest
  • AdjustToNextWorkDayTest
• Testing
• Contributing
• Security
• Credits
• License

This package is a helper package to work with workdays, weekends and holidays. It uses:

• Carbon to work with dates
• Yasumi for holidays

Installation

Via Composer

composer require tyler36/lara-holidays

Usage

This package extends Carbon to provide several useful features.

IsWorkDay

• This checks to see if the day is considered a 'work day'. Default is Monday => Friday

Carbon::parse('2022-08-01')->isWorkDay()
// -> True (Monday)

Carbon::parse('2022-08-06')->isWorkDay()
// -> False (Saturaday)

IsWeekendDay

• This checks to see if the day is considered a 'weekend day'. Default is Saturday, Sunday

Carbon::parse('2022-08-01')->isWorkDay()
// -> False (Monday)

Carbon::parse('2022-08-06')->isWorkDay()
// -> True (Saturaday)

IsHolidayDay

• This checks if the day is considered a holiday.
• Holidays are determined by the Yasumi package.
• Holidays are determined by locale which can be set in the config file. Default is 'Japan'

Carbon::parse('2022-01-01')->isHoliday()
// -> True

Carbon::parse('2022-12-25')->isHoliday()
// -> False (Default local is Japan)

LaraHolidays::setLocale('USA');
Carbon::parse('2022-12-25')->isHoliday()
// -> True

GetPreviousWorkDay

• This returns a date that is the first previous workday.

// Given '2022-08-06' (Saturaday)
Carbon::parse('2022-08-06')->getPreviousWorkDay()
// 2022-08-05 (Friday)

GetNextWorkDay

• This returns a date that is the next workday.

// Given 2022-08-05 (Friday)
Carbon::parse('2022-08-05')->getPreviousWorkDay()
// '2022-08-08' (Monday)

AdjustToPreviousWorkDayTest

• Similar to "GetPreviousWorkDay", but also skips holidays. IE. Previous workday, not a weekend or holiday.

AdjustToNextWorkDayTest

• Similar to "GetNextWorkDay", but also skips holidays. IE. Next workday, not a weekend or holiday.

Testing

phpunit

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author@email.com instead of using the issue tracker.

Credits

• [Tyler36]

License

MIT. Please see the license file for more information.