Carbon mixin to handle business days
Carbon mixin to handle business days
Professionally supported nesbot/carbon is now available
composer require cmixin/business-day
First load the mixin in some global bootstrap place of your app:
// You can select one of our official list $baseList = 'us-national'; // or region such as 'us-il'// You can add/remove days (optional): $additionalHolidays = [ 'independence-day' => null, // Even if it's holiday, you can force it to null to make your business open 'boss-birthday' => '09-26', // Close the office on September 26th // you can also use slash if you prefer day first '26/09' (September 26th too) 'julian-christmas' => '= julian 12-25', // We support many calendars such as the Julian calendar // We support expressions 'special-easter' => '= Tuesday before easter', 'last-monday' => '= last Monday of October', 'conditional' => '= 02-25 if Tuesday then next Friday', // We support conditions // And we support closures: 'very-special' => function ($year) { if ($year === 2020) { return '01-15'; }
return '02-15'; },
];
// You can optionally specify some days that are worked even if on weekend $extraWorkDays = [ 'moving-office' => '2021-01-17', // year specific 'yearly-meeting' => '01-25', // or any year rather it's weekend or not ];
BusinessDay::enable('Carbon\Carbon', $baseList, $additionalHolidays, $extraWorkDays); // Or if you use Laravel: // BusinessDay::enable('Illuminate\Support\Carbon', $baseList, $additionalHolidays);
// And you can even enable multiple classes at once: BusinessDay::enable([ 'Carbon\Carbon', 'Carbon\CarbonImmutable', ], $baseList, $additionalHolidays);
Business days methods are now available on any Carbon instance used anywhere later.
You can also just enable methods on Carbon then set region/holidays later: ```php <?php
use Cmixin\BusinessDay;
BusinessDay::enable('Carbon\Carbon'); // Or if you use Laravel: // BusinessDay::enable('Illuminate\Support\Carbon'); ```
You can set different holidays lists for different regions (to handle different countries, enterprises, etc.)
We provide 356 regional holidays lists of 143 countries that work out of the box in src/Cmixin/Holidays.
And you can easily customize them and add your own lists.
A holidays list file is a PHP file that return an array, each item of the array represent a holiday of the year.
It can be a fixed date such as
'12-25'for Christmas, a expression starting with
=like
'third Monday of January'or a closure that will calculate the date for the given year.
Expressions support any format the PHP
DateTimeconstructor supports such as:
second Wednesday of July
03-01 - 3 days
And we add a lot of syntaxical sugar:
= easter 3(Easter + 3 days)
= Friday before 01-01(before/after)
= 01-01 if Saturday then next Monday and if Sunday,Monday then next Tuesday(multiple conditions)
= 01-01 if weekend then next Monday(weekend = Saturday or Sunday)
= 01-01 substitute(substitute = shift the day to the next day that is not Saturday, Sunday or an other holiday, it means if you have both
01-01 substituteand
01-02 substitute, you're sure to get the 2 holidays not during the weekend in the right order no matter the days it falls)
= orthodox -2(2 days before Orthodox Easter)
= julian 12-25(Julian calendar)
= 02-05 on Mondayholiday only if this is a Monday.
= 02-05 not on Mondaynot an holiday if this is a Monday.
= 02-05 on even yearseven years only.
= 02-05 on every 5 years since 1999if year is 1999, 2004, 2009, 2014, etc.
To select the set of holidays of a region, use:
php Carbon::parse('2000-12-25 00:00:00')->isHoliday(); // false Carbon::setHolidaysRegion('us'); Carbon::parse('2000-12-25 00:00:00')->isHoliday(); // true Carbon::getHolidaysRegion(); // 'us-national' (national is the default region of a country code)
This will select our national preset for USA (only holidays common to all states).
Before selecting a region the list of holidays is empty so
isHolidaywill return
falsefor any date.
Get the holiday dates list for a given year:
Carbon::setHolidaysRegion('us');foreach (Carbon::getYearHolidays(2020) as $id => $holiday) { echo $holiday->getHolidayName().': '.$holiday->format('l, F j, Y')."\n"; }
// If Carbon::getYearHolidays() is called without argument, current year is used instead.
It will output:
New Year: Wednesday, January 1, 2020 Martin Luther King Jr. Day: Monday, January 20, 2020 Washington’s Birthday: Monday, February 17, 2020 Memorial Day: Monday, May 25, 2020 Independence Day: Monday, July 6, 2020 Labor Day: Monday, September 7, 2020 Columbus Day: Monday, October 12, 2020 Day of the veterans: Wednesday, November 11, 2020 Thanksgiving: Thursday, November 26, 2020 Christmas: Friday, December 25, 2020
This method allow you to get the holiday list for a given region passed in argument, if no argument given the list for the current selected region is returned.
Carbon::getHolidays('us'); // raw us-national holidays list Carbon::setHolidaysRegion('fr'); Carbon::getHolidays(); // raw fr-national holidays list
It's how you can set your own holidays lists:
Carbon::setHolidays('us-il', array_merge( Carbon::getHolidays('us-national'), [ // Presidents' Day 'presidents-day' => '= third monday of february', // can be a datetime expression // Columbus Day 'columbus-day' => function ($year) { // can be a closure $date = new DateTime("second monday of october $year");return $date->format('d/m'); }, // Day after Thanksgiving 'thanksgiving-next-day' => '= fourth thursday of november $year +1 day', // '$year' will be replaced by current year ]
)); Carbon::setHolidays('my-enterprise', array_merge( Carbon::getHolidays('us-is'), [ // Lincoln's Birthday 'lincolns-birthday' => '= 02-12 substitute', // substitute will shift the holiday until it does not fall on Saturday, Sunday or an other holiday 'company-closed-day' => '= 04-05 if friday then previous wednesday', // custom rules can be applied with if/then (if can be followed by a day name or "weekend") ] )); // Then when you select my-enterprise, all us-national, // us-il and my-enterprise days are enabled Carbon::setHolidaysRegion('my-enterprise');
You can also pass deep array to
setHolidaysto set in the same call holidays dates and either observed flags, names (in different languages) or both:
php Carbon::setHolidays('my-enterprise', [ 'lincolns-birthday' => [ 'date' => '12/02', 'observed' => true, 'name' => [ 'en' => "Lincoln's Birthday", 'fr' => 'Anniversaire du Président Lincoln', ], ], ]);
While setHolidays replace the whole holidays list for a given region, addHolidays append holidays to the current list.
Carbon::addHolidays('my-list', [ 'poney' => '20/01', 'swimmingpool' => '21/01', ]); Carbon::addHolidays('my-list', [ 'boss-birthday' => '10/02', 'boss-birthday-next-day' => '11/02', ]); Carbon::getHolidays('my-list') // contains 20/01, 21/01, 10/02 and 11/02
As for
setHolidays,
addHolidayshandle deep arrays using date, observed and name keys.
Reset all holidays and region previously set.
Returns
trueif the date (Carbon instance) is a holiday (in the list of the selected region),
falseelse.
Carbon::setHolidaysRegion('us-national'); Carbon::parse('2018-01-15')->isHoliday() // true for 2018 Carbon::parse('2018-01-21')->isHoliday() // false for 2018 Carbon::parse('2019-01-15')->isHoliday() // false for 2019 Carbon::parse('2019-01-21')->isHoliday() // true for 2019 Carbon::isHoliday() // true if today is a holiday
Same as
isHolidaybut returns a string id for the given holiday, so you can target specific holidays.
Carbon::setHolidaysRegion('us-national'); Carbon::parse('2018-12-25')->getHolidayId() // "christmas" Carbon::parse('2018-01-15')->getHolidayId() // "mlk-day" // Returns false if the day is not a holiday Carbon::parse('2018-01-21')->getHolidayId() // false$nextWeekHoliday = Carbon::today()->addWeek()->getHolidayId(); if ($nextWeekHoliday === 'easter' or $nextWeekHoliday === 'christmas') { echo 'Time to get chocolates.'; }
Returns the name of the holiday in the current locale (or English by default) or false if the day is not a holiday.
Carbon::setHolidaysRegion('fr-national'); Carbon::parse('2018-12-25')->getHolidayName() // "Christmas" Carbon::parse('2018-12-25')->getHolidayName('fr') // "Noël"Carbon::setLocale('nl'); Carbon::parse('2018-01-15')->getHolidayName() // "Eerste Kerstdag"
// If the name is not translated in business-day Carbon::setLocale('de'); Carbon::parse('2018-01-15')->getHolidayName() // "Christmas"
// With Carbon 2, you can use local locale: Carbon::parse('2018-01-15')->locale('sl')->getHolidayName() // "Božič"
Note: be aware, region has no effect to the holiday language name since some regions have multiple languages. So to get french names of the french holidays, you need both
Carbon::setHolidaysRegion('fr-national')and
Carbon::setLocale('fr_FR'), the first for the holiday calendar, the second for the language.
Wanna rename a holiday name in a particular language? No problem:
Carbon::parse('2018-12-25')->getHolidayName() // "Christmas" Carbon::setHolidayName('christmas', 'en', 'Christmas Day'); Carbon::parse('2018-12-25')->getHolidayName() // "Christmas Day"
It also allows you to name an additional holiday you added manually and you can specify multiple languages using array:
BusinessDay::enable('Carbon\Carbon', 'us-national', [ 'company-creation' => '05-15', ]);Carbon::setHolidayName('company-creation', [ 'en' => 'The Day The Company Was Created', 'fr' => "Le jour de la création de l'Entreprise", ]);
Returns
trueif the date (Carbon instance) is nor a week-end day neither a holiday,
falseelse. Week-end days can be configured (see Carbon documentation weekend section).
Carbon::setHolidaysRegion('us-national'); Carbon::parse('2018-01-15')->isBusinessDay() // false for 2018 (Martin Luther King Jr. Day, sleep) Carbon::parse('2018-01-21')->isBusinessDay() // false for 2018 (sunday is week-end by default, sleep) Carbon::parse('2019-01-15')->isBusinessDay() // true for 2019 (tuesday, nothing special, go to work) Carbon::parse('2019-01-21')->isBusinessDay() // false for 2019 (Martin Luther King Jr. Day, sleep) Carbon::isBusinessDay() // true if today is a business day
Add days to the date (Carbon instance) to jump to the next business day (skipping holidays and week-ends).
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-12')->nextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-13')->nextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-15')->nextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-16')->nextBusinessDay()->format('Y-m-d'); // 2018-01-17 echo Carbon::parse('2018-01-12 12:30:00')->nextBusinessDay()->format('Y-m-d H:i'); // 2018-01-16 12:30 (time is kept) // If you don't want to keep the time, just use ->startOfDay() echo Carbon::nextBusinessDay()->format('Y-m-d'); // returns the next business day date after today (midnight)
Sub days to the date (Carbon instance) to jump to the previous business day (skipping holidays and week-ends).
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-12')->previousBusinessDay()->format('Y-m-d'); // 2018-01-11 echo Carbon::parse('2018-01-13')->previousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-15')->previousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-16')->previousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-15 12:30:00')->previousBusinessDay()->format('Y-m-d H:i'); // 2018-01-12 12:30 (time is kept) // If you don't want to keep the time, just use ->startOfDay() echo Carbon::previousBusinessDay()->format('Y-m-d'); // returns the previous business day date before today (midnight)
Returns the current date (Carbon instance) if it's a business day, else add days to jump to the next business day (skipping holidays and week-ends).
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-12')->currentOrNextBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-13')->currentOrNextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-15')->currentOrNextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-16')->currentOrNextBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-13 12:30:00')->currentOrNextBusinessDay()->format('Y-m-d H:i'); // 2018-01-16 12:30 (time is kept) // If you don't want to keep the time, just use ->startOfDay() echo Carbon::currentOrNextBusinessDay() // equivalent to Carbon::today()->currentOrNextBusinessDay()
Returns the current date (Carbon instance) if it's a business day, else sub days to jump to the previous business day (skipping holidays and week-ends).
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-12')->currentOrPreviousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-13')->currentOrPreviousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-15')->currentOrPreviousBusinessDay()->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-16')->currentOrPreviousBusinessDay()->format('Y-m-d'); // 2018-01-16 echo Carbon::parse('2018-01-13 12:30:00')->currentOrPreviousBusinessDay()->format('Y-m-d H:i'); // 2018-01-16 12:30 (time is kept) // If you don't want to keep the time, just use ->startOfDay() echo Carbon::currentOrPreviousBusinessDay() // equivalent to Carbon::today()->currentOrPreviousBusinessDay()
Add days to the date (Carbon instance) skipping holidays and week-ends.
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-10')->addBusinessDays(4)->format('Y-m-d'); // 2018-01-17 echo Carbon::parse('2018-01-13')->addBusinessDays()->format('Y-m-d'); // 2018-01-16 add 1 business day by default echo Carbon::addBusinessDays(6)->format('Y-m-d'); // returns the date 6 business days after today (midnight)
Alias addBusinessDays.
Sub days to the date (Carbon instance) skipping holidays and week-ends.
php Carbon::setHolidaysRegion('us-national'); echo Carbon::parse('2018-01-17')->subBusinessDays(4)->format('Y-m-d'); // 2018-01-12 echo Carbon::parse('2018-01-15')->subBusinessDays()->format('Y-m-d'); // 2018-01-12 sub 1 business day by default echo Carbon::subBusinessDays(5)->format('Y-m-d'); // returns the date 5 business days date before today (midnight)
Alias subBusinessDays.
You can define isolated zones that can observe different holidays lists. By default the zone is
"default".
Carbon::setHolidaysRegion('us-national');Carbon::setObservedHolidaysZone('Nevada-subsidiary-company'); Carbon::observeAllHolidays(); Carbon::unobserveHoliday('independence-day');
Carbon::setObservedHolidaysZone('Illinois-subsidiary-company'); Carbon::observeAllHolidays(); Carbon::unobserveHolidays(['labor-day', 'mlk-day']);
Carbon::setObservedHolidaysZone('Nevada-subsidiary-company'); Carbon::parse('2018-01-15')->isObservedHoliday(); // true Carbon::parse('2018-07-04')->isObservedHoliday(); // false Carbon::parse('2018-09-03')->isObservedHoliday(); // true
Carbon::setObservedHolidaysZone('Illinois-subsidiary-company'); Carbon::parse('2018-01-15')->isObservedHoliday(); // false Carbon::parse('2018-07-04')->isObservedHoliday(); // true Carbon::parse('2018-09-03')->isObservedHoliday(); // false
Get the current zone used for observed holidays.
Carbon::getObservedHolidaysZone(); // "Illinois-subsidiary-company"
Return true if the current day is an observed holiday (holiday as per the holidays list in use and if it's observed as per the current zone).
Carbon::setHolidaysRegion('fr-national'); Carbon::parse('2018-01-15')->isHoliday(); // true // By default no holiday is observed Carbon::parse('2018-01-15')->isObservedHoliday(); // false // Then you can observe a list of holidays Carbon::unobserveHolidays(['christmas', 'new-year']); Carbon::parse('2018-01-15')->isObservedHoliday(); // true // Observed holidays are kept if you change the holidays region: Carbon::setHolidaysRegion('us-national'); Carbon::parse('2018-01-15')->isObservedHoliday(); // true // So you can observe holidays that are not in the current region with no restriction // You can check observance by ID: Carbon::isObservedHoliday('christmas'); // false Carbon::isObservedHoliday('labor-day'); // true Carbon::isObservedHoliday(); // check if today is an observed holiday
Observe holidays. You can have multiple set of observed days using
setObservedHolidaysZone.
Carbon::observeHoliday(['christmas', 'new-year']); Carbon::observeHoliday('easter');
Alias of
observeHoliday.
Carbon::observeHolidays(['christmas', 'new-year']); Carbon::observeHolidays('easter');
Set holidays as not observed. You can have multiple set of observed days using
setObservedHolidaysZone.
Carbon::unobserveHoliday(['christmas', 'new-year']); Carbon::unobserveHoliday('easter');
Alias of
unobserveHoliday.
Carbon::unobserveHolidays(['christmas', 'new-year']); Carbon::unobserveHolidays('easter');
Remove any previous settings for observed days in the current zone, then make every holidays as observed by default.
// Observe every holidays except Easter Carbon::observeAllHolidays(); Carbon::unobserveHoliday('easter');
Remove any previous settings for observed days in the current zone, then make every holidays as not observed by default.
// Observe only Easter Carbon::unobserveAllHolidays(); Carbon::observeHoliday('easter');
Get the number of open days between 2 dates.
$openDays = Carbon::diffInBusinessDays('December 25'); // If only one date, [now] is used as the second dateecho "You have to work $openDays days until Christmas.\n";
$days = Carbon::parse('2019-06-10')->diffInBusinessDays(Carbon::parse('2019-06-18')->endOfDay());
echo "If you ask to leave from 2019-06-10 to 2019-06-18, it will cost to you $days days of paid vacation.\n"; // Note the ->endOfDay() to include the last day of the range
⚠️ Behavior is different for Carbon 2 and 3:
Get the number of open days in the current/given month.
echo Carbon::getBusinessDaysInMonth(); // Open days count in the current month echo Carbon::getBusinessDaysInMonth('2019-06'); // Open days count in June 2019 echo Carbon::parse('2019-06-10')->getBusinessDaysInMonth(); // Can be called from an instance
Get an array of Carbon objects for each open day in the current/given month.
print_r(Carbon::getMonthBusinessDays()); // All open days in the current month print_r(Carbon::getMonthBusinessDays('2019-06')); // Open days in June 2019 print_r(Carbon::parse('2019-06-10')->getMonthBusinessDays()); // Can be called from an instance
Extra work days are days that are worked even if it's during the week-end (so
isBusinessDay()returns
truefor those days). They allow to handle compensation days used in some countries and some business exceptions.
isExtraWorkdayreturns
trueif the current day is one for them,
falseelse.
Carbon::setHolidaysRegion('cn-national');Carbon::parse('2021-02-07')->isExtraWorkday(); // true
isExtraWorkdayis equivalent to
isHolidaybut for the extra working days list (the
withoutconfig entry).
Get the ID of the current extra work day, or
falseif it's not an extra workday.
getExtraWorkdayIdis equivalent to
getHolidayIdbut for the extra working days list.
Get the list of the extra workdays of a given region (current region if not specified).
getExtraWorkdaysis equivalent to
getHolidaysbut for the extra working days list.
Set the list of the extra workdays of a given region.
setExtraWorkdaysis equivalent to
setHolidaysbut for the extra working days list.
Add an extra workday to the list of a given region.
addExtraWorkdayis equivalent to
addHolidaybut for the extra working days list.
Customize the way to determine if a date is a business day or not.
// Global way Carbon::setBusinessDayChecker(function (CarbonInterface $date) { // As an example, you can customize it so // every first Wednesday of month is always worked even if it's an holiday: if ($date->isWednesday() && $date->copy()->subWeek()->month !== $date->month) { return true; }return $date->isExtraWorkday() || ($date->isWeekday() && !$date->isHoliday());
});
// Single object config (prior to global) $date = Carbon::parse('2020-12-03'); $date->setBusinessDayChecker($someFunction);
If not set or set to
null, the default calculation is:
php $date->isExtraWorkday() or ($date->isWeekday() and !$date->isHoliday())
Customize the way to determine if a date is a holiday and which one it is.
// Global way Carbon::setHolidayGetter(function (string $region, CarbonInterface $self, callable $fallback) { [$country, $state] = explode('-', $region); $date = $self->format('Y-m-d');// Assuming the API you use does not support dates after 2040, you can fallback to the default internal data if ($self->year > 2040) { return $fallback(); } $holidayData = file_get_contents("https://someholidaysapi.com/holidays/?country=$country&state=$state&date=$date"); return $holidayData ? $holidayData['name'] // The function should return a unique string (like a name or an ID) : false; // or false if the day is not a holiday
});
// Single object config (prior to global) $date = Carbon::parse('2020-12-03'); $date->setHolidayGetter($someFunction);
Customize the way to determine if a date is an extra work day and which one it is.
It's equivalent to
setHolidayGetterbut for extra work days.
Set an array of data for a given holiday ID.
Carbon::setHolidayDataById('christmas', [ 'info' => 'It may be cold in USA', ]);
Set an array of data for current holiday (does nothing if the current day is not a holiday).
Carbon::parse('2020-12-25')->setHolidayData([ 'info' => 'It may be cold in USA', ]);
Get stored array of data for a given holiday ID.
Carbon::getHolidayDataById('christmas')
Get stored array of data for current holiday (
nullif the current day is not a holiday).
Carbon::parse('2020-12-25')->getHolidayData()
To enable business-day globally in Laravel, set default holidays settings in the config file config/carbon.php (create this file if it does not exist yet):
[ 'region' => 'us', 'with' => [ 'boss-birthday' => '09-26', 'last-monday' => '= last Monday of October', ], // extra work days (even if in the weekend) 'without' => [ 'exceptional-work-day' => '2021-01-03', ], ], ];
When you set an holidays region, it does not change the timezone, so if January 1st is an holiday,
->isHoliday()returns
truefrom
Carbon::parse('2010-01-01 00:00:00.000000)to
Carbon::parse('2010-01-01 23:59:59.999999)no matter the timezone you set for those
Carboninstance.
If you want to know if it's holiday or business day in somewhere else in the world, you have to convert it:
php Carbon::parse('2010-01-01 02:30', 'Europe/Paris')->setTimezone('America/Toronto')->isHoliday() // false Carbon::parse('2010-01-01 12:30', 'Europe/Paris')->setTimezone('America/Toronto')->isHoliday() // true
The scope of this library is to provide business date and time utilities to Carbon, if you think of a feature in this scope, feel free to submit a pull-request.
We will also happily merge any holidays file matching an official country, state or region holidays list.
Based on the work of Christopher "rmblstrp", see Carbon PR #706