Carbon::isMutable

Returns true if the current class/instance is mutable.

Carbon::__construct

Create a new Carbon instance.

Please see the testing aids section (specifically static::setTestNow()) for more on the possibility of this constructor returning a test instance.

Carbon::__serialize

Returns the values to dump on serialize() called on.

Only used by PHP >= 7.4.

Carbon::__unserialize

Set locale if specified on unserialize() called.

Only used by PHP >= 7.4.

Carbon::__wakeup

Set locale if specified on unserialize() called.

Only used by PHP < 7.4.

Carbon::__set_state

The __set_state handler.

Carbon::createFromImmutable

See PHP documentation for DateTime::createFromImmutable

Carbon::createFromInterface

See PHP documentation for DateTime::createFromInterface

Carbon::createFromFormat

Create a Carbon instance from a specific format.

Carbon::getLastErrors

{@inheritdoc}

Carbon::format

Returns the formatted date string on success or FALSE on failure.

Carbon::modify

Calls \DateTime::modify if mutable or \DateTimeImmutable::modify else.

Carbon::add

Add given units or interval to the current instance.

Examples:

$date->add('hour', 3)

$date->add(15, 'days')

$date->add(CarbonInterval::days(4))

Carbon::sub

Subtract given units or interval to the current instance.

Examples:

$date->sub('hour', 3)

$date->sub(15, 'days')

$date->sub(CarbonInterval::days(4))

Carbon::getTimezone

Get the TimeZone associated with the Carbon instance (as CarbonTimeZone).

Carbon::setTimezone

Set the instance's timezone from a string or object.

Carbon::getOffset

See PHP documentation for DateTime::getOffset

Carbon::setTime

Resets the current time of the DateTime object to a different time.

Carbon::setDate

Set the date with gregorian year, month and day numbers.

Carbon::setISODate

Set a date according to the ISO 8601 standard - using weeks and day offsets rather than specific dates.

Carbon::setTimestamp

Set the instance's timestamp.

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::getTimestamp

See PHP documentation for DateTime::getTimestamp

Carbon::diff

@alias diffAsCarbonInterval

Get the difference as a DateInterval instance. Return relative interval (negative if $absolute flag is not set to true and the given date is before current one).

Carbon::copy

Get a copy of the instance.

Carbon::clone

@alias copy

Get a copy of the instance.

Carbon::avoidMutation

Clone the current instance if it's mutable.

This method is convenient to ensure you don't mutate the initial object but avoid to make a useless copy of it if it's already immutable.

Carbon::nowWithSameTz

Returns a present instance in the same timezone.

Carbon::carbonize

Return the Carbon instance passed through, a now instance in the same timezone if null given or parse the input if string given.

Carbon::__get

Get a part of the Carbon object.

Carbon::get

Get a part of the Carbon object.

Carbon::__isset

Check if an attribute exists on the object

Carbon::__set

Set a part of the Carbon object

Carbon::set

Set a part of the Carbon object.

Carbon::getTranslatedDayName

Get the translation of the current week day name (with context for languages with multiple forms).

Carbon::getTranslatedShortDayName

Get the translation of the current short week day name (with context for languages with multiple forms).

Carbon::getTranslatedMinDayName

Get the translation of the current abbreviated week day name (with context for languages with multiple forms).

Carbon::getTranslatedMonthName

Get the translation of the current month day name (with context for languages with multiple forms).

Carbon::getTranslatedShortMonthName

Get the translation of the current short month day name (with context for languages with multiple forms).

Carbon::dayOfYear

Get/set the day of year.

Carbon::weekday

Get/set the weekday from 0 (Sunday) to 6 (Saturday).

Carbon::isoWeekday

Get/set the ISO weekday from 1 (Monday) to 7 (Sunday).

Carbon::getDaysFromStartOfWeek

Return the number of days since the start of the week (using the current locale or the first parameter if explicitly given).

Carbon::setDaysFromStartOfWeek

Set the day (keeping the current time) to the start of the week + the number of days passed as the first parameter. First day of week is driven by the locale unless explicitly set with the second parameter.

Carbon::setUnitNoOverflow

Set any unit to a new value without overflowing current other unit given.

Carbon::addUnitNoOverflow

Add any unit to a new value without overflowing current other unit given.

Carbon::subUnitNoOverflow

Subtract any unit to a new value without overflowing current other unit given.

Carbon::utcOffset

Returns the minutes offset to UTC if no arguments passed, else set the timezone with given minutes shift passed.

Carbon::setDateTime

Set the date and time all together.

Carbon::setTimeFromTimeString

Set the time by time string.

Carbon::timezone

@alias setTimezone

Carbon::tz

Set the timezone or returns the timezone name if no arguments passed.

Carbon::shiftTimezone

Set the instance's timezone from a string or object and add/subtract the offset difference.

Carbon::utc

Set the instance's timezone to UTC.

Carbon::setDateFrom

Set the year, month, and date for this instance to that of the passed instance.

Carbon::setTimeFrom

Set the hour, minute, second and microseconds for this instance to that of the passed instance.

Carbon::setDateTimeFrom

Set the date and time for this instance to that of the passed instance.

Carbon::getDays

Get the days of the week.

Carbon::getWeekStartsAt

Get the first day of week.

Carbon::getWeekEndsAt

Get the last day of week.

Carbon::getWeekendDays

Get weekend days

Carbon::hasRelativeKeywords

Determine if a time string will produce a relative date.

Carbon::getIsoFormats

Returns list of locale formats for ISO formatting.

Carbon::getCalendarFormats

Returns list of calendar formats for ISO formatting.

Carbon::getIsoUnits

Returns list of locale units for ISO formatting.

Carbon::getPaddedUnit

Returns a unit of the instance padded with 0 by default or any other string if specified.

Carbon::ordinal

Return a property with its ordinal.

Carbon::meridiem

Return the meridiem of the current time in the current locale.

Carbon::getAltNumber

Returns the alternative number for a given date property if available in the current locale.

Carbon::isoFormat

Format in the current language using ISO replacement patterns.

Carbon::getFormatsToIsoReplacements

List of replacements from date() format to isoFormat().

Carbon::translatedFormat

Format as ->format() do (using date replacements patterns from https://php.net/manual/en/function.date.php) but translate words whenever possible (months, day names, etc.) using the current locale.

Carbon::getOffsetString

Returns the offset hour and minute formatted with +/- and a given separator (":" by default). For example, if the time zone is 9 hours 30 minutes, you'll get "+09:30", with "@@" as first argument, "+09@@30", with "" as first argument, "+0930". Negative offset will return something like "-12:00".

Carbon::setUnit

Set specified unit to new given value.

Carbon::singularUnit

Returns standardized singular of a given singular/plural unit name (in English).

Carbon::pluralUnit

Returns standardized plural of a given singular/plural unit name (in English).

Carbon::sleep

Carbon::startOfDay

Resets the time to 00:00:00 start of day

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfDay();

Carbon::endOfDay

Resets the time to 23:59:59.999999 end of day

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfDay();

Carbon::startOfMonth

Resets the date to the first day of the month and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfMonth();

Carbon::endOfMonth

Resets the date to end of the month and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfMonth();

Carbon::startOfQuarter

Resets the date to the first day of the quarter and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfQuarter();

Carbon::endOfQuarter

Resets the date to end of the quarter and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfQuarter();

Carbon::startOfYear

Resets the date to the first day of the year and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfYear();

Carbon::endOfYear

Resets the date to end of the year and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfYear();

Carbon::startOfDecade

Resets the date to the first day of the decade and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfDecade();

Carbon::endOfDecade

Resets the date to end of the decade and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfDecade();

Carbon::startOfCentury

Resets the date to the first day of the century and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfCentury();

Carbon::endOfCentury

Resets the date to end of the century and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfCentury();

Carbon::startOfMillennium

Resets the date to the first day of the millennium and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfMillennium();

Carbon::endOfMillennium

Resets the date to end of the millennium and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfMillennium();

Carbon::startOfWeek

Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfWeek() . "\n";
echo Carbon::parse('2018-07-25 12:45:16')->locale('ar')->startOfWeek() . "\n";
echo Carbon::parse('2018-07-25 12:45:16')->startOfWeek(Carbon::SUNDAY) . "\n";

Carbon::endOfWeek

Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59.999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfWeek() . "\n";
echo Carbon::parse('2018-07-25 12:45:16')->locale('ar')->endOfWeek() . "\n";
echo Carbon::parse('2018-07-25 12:45:16')->endOfWeek(Carbon::SATURDAY) . "\n";

Carbon::startOfHour

Modify to start of current hour, minutes and seconds become 0

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfHour();

Carbon::endOfHour

Modify to end of current hour, minutes and seconds become 59

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfHour();

Carbon::startOfMinute

Modify to start of current minute, seconds become 0

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->startOfMinute();

Carbon::endOfMinute

Modify to end of current minute, seconds become 59

Examples:

echo Carbon::parse('2018-07-25 12:45:16')->endOfMinute();

Carbon::startOfSecond

Modify to start of current second, microseconds become 0

Examples:

echo Carbon::parse('2018-07-25 12:45:16.334455')
  ->startOfSecond()
  ->format('H:i:s.u');

Carbon::endOfSecond

Modify to end of current second, microseconds become 999999

Examples:

echo Carbon::parse('2018-07-25 12:45:16.334455')
  ->endOfSecond()
  ->format('H:i:s.u');

Carbon::startOf

Modify to start of current given unit.

Examples:

echo Carbon::parse('2018-07-25 12:45:16.334455')
  ->startOf('month')
  ->endOf('week', Carbon::FRIDAY);

Carbon::endOf

Modify to end of current given unit.

Examples:

echo Carbon::parse('2018-07-25 12:45:16.334455')
  ->startOf('month')
  ->endOf('week', Carbon::FRIDAY);

Carbon::eq

Determines if the instance is equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->eq('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->eq(Carbon::parse('2018-07-25 12:45:16')); // true
Carbon::parse('2018-07-25 12:45:16')->eq('2018-07-25 12:45:17'); // false

Carbon::equalTo

Determines if the instance is equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->equalTo('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->equalTo(Carbon::parse('2018-07-25 12:45:16')); // true
Carbon::parse('2018-07-25 12:45:16')->equalTo('2018-07-25 12:45:17'); // false

Carbon::ne

Determines if the instance is not equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->ne('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->ne(Carbon::parse('2018-07-25 12:45:16')); // false
Carbon::parse('2018-07-25 12:45:16')->ne('2018-07-25 12:45:17'); // true

Carbon::notEqualTo

Determines if the instance is not equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->notEqualTo('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->notEqualTo(Carbon::parse('2018-07-25 12:45:16')); // false
Carbon::parse('2018-07-25 12:45:16')->notEqualTo('2018-07-25 12:45:17'); // true

Carbon::gt

Determines if the instance is greater (after) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:15'); // true
Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:17'); // false

Carbon::greaterThan

Determines if the instance is greater (after) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:15'); // true
Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:17'); // false

Carbon::isAfter

Determines if the instance is greater (after) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:15'); // true
Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:17'); // false

Carbon::gte

Determines if the instance is greater (after) than or equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:15'); // true
Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:17'); // false

Carbon::greaterThanOrEqualTo

Determines if the instance is greater (after) than or equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:15'); // true
Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:17'); // false

Carbon::lt

Determines if the instance is less (before) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:15'); // false
Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:17'); // true

Carbon::lessThan

Determines if the instance is less (before) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:15'); // false
Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:17'); // true

Carbon::isBefore

Determines if the instance is less (before) than another

Examples:

Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:15'); // false
Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:16'); // false
Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:17'); // true

Carbon::lte

Determines if the instance is less (before) or equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:15'); // false
Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:17'); // true

Carbon::lessThanOrEqualTo

Determines if the instance is less (before) or equal to another

Examples:

Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:15'); // false
Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:16'); // true
Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:17'); // true

Carbon::between

Determines if the instance is between two others.

The third argument allow you to specify if bounds are included or not (true by default) but for when you including/excluding bounds may produce different results in your application, we recommend to use the explicit methods ->betweenIncluded() or ->betweenExcluded() instead.

Examples:

Carbon::parse('2018-07-25')->between('2018-07-14', '2018-08-01'); // true
Carbon::parse('2018-07-25')->between('2018-08-01', '2018-08-20'); // false
Carbon::parse('2018-07-25')->between('2018-07-25', '2018-08-01'); // true
Carbon::parse('2018-07-25')->between('2018-07-25', '2018-08-01', false); // false

Carbon::betweenIncluded

Determines if the instance is between two others, bounds included.

Examples:

Carbon::parse('2018-07-25')->betweenIncluded('2018-07-14', '2018-08-01'); // true
Carbon::parse('2018-07-25')->betweenIncluded('2018-08-01', '2018-08-20'); // false
Carbon::parse('2018-07-25')->betweenIncluded('2018-07-25', '2018-08-01'); // true

Carbon::betweenExcluded

Determines if the instance is between two others, bounds excluded.

Examples:

Carbon::parse('2018-07-25')->betweenExcluded('2018-07-14', '2018-08-01'); // true
Carbon::parse('2018-07-25')->betweenExcluded('2018-08-01', '2018-08-20'); // false
Carbon::parse('2018-07-25')->betweenExcluded('2018-07-25', '2018-08-01'); // false

Carbon::isBetween

Determines if the instance is between two others

Examples:

Carbon::parse('2018-07-25')->isBetween('2018-07-14', '2018-08-01'); // true
Carbon::parse('2018-07-25')->isBetween('2018-08-01', '2018-08-20'); // false
Carbon::parse('2018-07-25')->isBetween('2018-07-25', '2018-08-01'); // true
Carbon::parse('2018-07-25')->isBetween('2018-07-25', '2018-08-01', false); // false

Carbon::isWeekday

Determines if the instance is a weekday.

Examples:

Carbon::parse('2019-07-14')->isWeekday(); // false
Carbon::parse('2019-07-15')->isWeekday(); // true

Carbon::isWeekend

Determines if the instance is a weekend day.

Examples:

Carbon::parse('2019-07-14')->isWeekend(); // true
Carbon::parse('2019-07-15')->isWeekend(); // false

Carbon::isYesterday

Determines if the instance is yesterday.

Examples:

Carbon::yesterday()->isYesterday(); // true
Carbon::tomorrow()->isYesterday(); // false

Carbon::isToday

Determines if the instance is today.

Examples:

Carbon::today()->isToday(); // true
Carbon::tomorrow()->isToday(); // false

Carbon::isTomorrow

Determines if the instance is tomorrow.

Examples:

Carbon::tomorrow()->isTomorrow(); // true
Carbon::yesterday()->isTomorrow(); // false

Carbon::isFuture

Determines if the instance is in the future, ie. greater (after) than now.

Examples:

Carbon::now()->addHours(5)->isFuture(); // true
Carbon::now()->subHours(5)->isFuture(); // false

Carbon::isPast

Determines if the instance is in the past, ie. less (before) than now.

Examples:

Carbon::now()->subHours(5)->isPast(); // true
Carbon::now()->addHours(5)->isPast(); // false

Carbon::isLeapYear

Determines if the instance is a leap year.

Examples:

Carbon::parse('2020-01-01')->isLeapYear(); // true
Carbon::parse('2019-01-01')->isLeapYear(); // false

Carbon::isLongYear

Determines if the instance is a long year (using calendar year).

⚠️ This method completely ignores month and day to use the numeric year number, it's not correct if the exact date matters. For instance as `2019-12-30` is already in the first week of the 2020 year, if you want to know from this date if ISO week year 2020 is a long year, use `isLongIsoYear` instead.

Examples:

Carbon::create(2015)->isLongYear(); // true
Carbon::create(2016)->isLongYear(); // false

Carbon::isLongIsoYear

Determines if the instance is a long year (using ISO 8601 year).

Examples:

Carbon::parse('2015-01-01')->isLongIsoYear(); // true
Carbon::parse('2016-01-01')->isLongIsoYear(); // true
Carbon::parse('2016-01-03')->isLongIsoYear(); // false
Carbon::parse('2019-12-29')->isLongIsoYear(); // false
Carbon::parse('2019-12-30')->isLongIsoYear(); // true

Carbon::isSameAs

Compares the formatted values of the two dates.

Examples:

Carbon::parse('2019-06-13')->isSameAs('Y-d', Carbon::parse('2019-12-13')); // true
Carbon::parse('2019-06-13')->isSameAs('Y-d', Carbon::parse('2019-06-14')); // false

Carbon::isSameUnit

Determines if the instance is in the current unit given.

Examples:

Carbon::parse('2019-01-13')->isSameUnit('year', Carbon::parse('2019-12-25')); // true
Carbon::parse('2018-12-13')->isSameUnit('year', Carbon::parse('2019-12-25')); // false

Carbon::isCurrentUnit

Determines if the instance is in the current unit given.

Examples:

Carbon::now()->isCurrentUnit('hour'); // true
Carbon::now()->subHours(2)->isCurrentUnit('hour'); // false

Carbon::isSameQuarter

Checks if the passed in date is in the same quarter as the instance quarter (and year if needed).

Examples:

Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2019-03-01')); // true
Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2019-04-01')); // false
Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2018-03-01')); // false
Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2018-03-01'), false); // true

Carbon::isSameMonth

Checks if the passed in date is in the same month as the instance´s month.

Examples:

Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2019-01-01')); // true
Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2019-02-01')); // false
Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2018-01-01')); // false
Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2018-01-01'), false); // true

Carbon::isDayOfWeek

Checks if this day is a specific day of the week.

Examples:

Carbon::parse('2019-07-17')->isDayOfWeek(Carbon::WEDNESDAY); // true
Carbon::parse('2019-07-17')->isDayOfWeek(Carbon::FRIDAY); // false
Carbon::parse('2019-07-17')->isDayOfWeek('Wednesday'); // true
Carbon::parse('2019-07-17')->isDayOfWeek('Friday'); // false

Carbon::isBirthday

Check if its the birthday. Compares the date/month values of the two dates.

Examples:

Carbon::now()->subYears(5)->isBirthday(); // true
Carbon::now()->subYears(5)->subDay()->isBirthday(); // false
Carbon::parse('2019-06-05')->isBirthday(Carbon::parse('2001-06-05')); // true
Carbon::parse('2019-06-05')->isBirthday(Carbon::parse('2001-06-06')); // false

Carbon::isLastOfMonth

Check if today is the last day of the Month

Examples:

Carbon::parse('2019-02-28')->isLastOfMonth(); // true
Carbon::parse('2019-03-28')->isLastOfMonth(); // false
Carbon::parse('2019-03-30')->isLastOfMonth(); // false
Carbon::parse('2019-03-31')->isLastOfMonth(); // true
Carbon::parse('2019-04-30')->isLastOfMonth(); // true

Carbon::isStartOfDay

Check if the instance is start of day / midnight.

Examples:

Carbon::parse('2019-02-28 00:00:00')->isStartOfDay(); // true
Carbon::parse('2019-02-28 00:00:00.999999')->isStartOfDay(); // true
Carbon::parse('2019-02-28 00:00:01')->isStartOfDay(); // false
Carbon::parse('2019-02-28 00:00:00.000000')->isStartOfDay(true); // true
Carbon::parse('2019-02-28 00:00:00.000012')->isStartOfDay(true); // false

Carbon::isEndOfDay

Check if the instance is end of day.

Examples:

Carbon::parse('2019-02-28 23:59:59.999999')->isEndOfDay(); // true
Carbon::parse('2019-02-28 23:59:59.123456')->isEndOfDay(); // true
Carbon::parse('2019-02-28 23:59:59')->isEndOfDay(); // true
Carbon::parse('2019-02-28 23:59:58.999999')->isEndOfDay(); // false
Carbon::parse('2019-02-28 23:59:59.999999')->isEndOfDay(true); // true
Carbon::parse('2019-02-28 23:59:59.123456')->isEndOfDay(true); // false
Carbon::parse('2019-02-28 23:59:59')->isEndOfDay(true); // false

Carbon::isMidnight

Check if the instance is start of day / midnight.

Examples:

Carbon::parse('2019-02-28 00:00:00')->isMidnight(); // true
Carbon::parse('2019-02-28 00:00:00.999999')->isMidnight(); // true
Carbon::parse('2019-02-28 00:00:01')->isMidnight(); // false

Carbon::isMidday

Check if the instance is midday.

Examples:

Carbon::parse('2019-02-28 11:59:59.999999')->isMidday(); // false
Carbon::parse('2019-02-28 12:00:00')->isMidday(); // true
Carbon::parse('2019-02-28 12:00:00.999999')->isMidday(); // true
Carbon::parse('2019-02-28 12:00:01')->isMidday(); // false

Carbon::hasFormat

Checks if the (date)time string is in a given format.

Examples:

Carbon::hasFormat('11:12:45', 'h:i:s'); // true
Carbon::hasFormat('13:12:45', 'h:i:s'); // false

Carbon::hasFormatWithModifiers

Checks if the (date)time string is in a given format.

Examples:

Carbon::hasFormatWithModifiers('31/08/2015', 'd#m#Y'); // true
Carbon::hasFormatWithModifiers('31/08/2015', 'm#d#Y'); // false

Carbon::canBeCreatedFromFormat

Checks if the (date)time string is in a given format and valid to create a new instance.

Examples:

Carbon::canBeCreatedFromFormat('11:12:45', 'h:i:s'); // true
Carbon::canBeCreatedFromFormat('13:12:45', 'h:i:s'); // false

Carbon::is

Returns true if the current date matches the given string.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2018')); // false
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019-06')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('06-02')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019-06-02')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('Sunday')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('June')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23:45')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23:00')); // false
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12h')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 15:23:45')->is('3pm')); // true
\Carbon\Doc\Generate\var_dump(Carbon::parse('2019-06-02 15:23:45')->is('3am')); // false

Carbon::isStartOfTime

Returns true if the date was created using CarbonImmutable::startOfTime()

Carbon::isEndOfTime

Returns true if the date was created using CarbonImmutable::endOfTime()

Carbon::rawFormat

See php.net/manual/en/datetime.format.php

Carbon::__toString

Format the instance as a string using the set format

Examples:

echo Carbon::now(); // Carbon instances can be cast to string

Carbon::toDateString

Format the instance as date

Examples:

echo Carbon::now()->toDateString();

Carbon::toFormattedDateString

Format the instance as a readable date

Examples:

echo Carbon::now()->toFormattedDateString();

Carbon::toFormattedDayDateString

Format the instance with the day, and a readable date

Examples:

echo Carbon::now()->toFormattedDayDateString();

Carbon::toTimeString

Format the instance as time

Examples:

echo Carbon::now()->toTimeString();

Carbon::toDateTimeString

Format the instance as date and time

Examples:

echo Carbon::now()->toDateTimeString();

Carbon::getTimeFormatByPrecision

Return a format from H:i to H:i:s.u according to given unit precision.

Carbon::toDateTimeLocalString

Format the instance as date and time T-separated with no timezone

Examples:

echo Carbon::now()->toDateTimeLocalString();
echo "\n";
echo Carbon::now()->toDateTimeLocalString('minute'); // You can specify precision among: minute, second, millisecond and microsecond

Carbon::toDayDateTimeString

Format the instance with day, date and time

Examples:

echo Carbon::now()->toDayDateTimeString();

Carbon::toAtomString

Format the instance as ATOM

Examples:

echo Carbon::now()->toAtomString();

Carbon::toCookieString

Format the instance as COOKIE

Examples:

echo Carbon::now()->toCookieString();

Carbon::toIso8601String

Format the instance as ISO8601

Examples:

echo Carbon::now()->toIso8601String();

Carbon::toRfc822String

Format the instance as RFC822

Examples:

echo Carbon::now()->toRfc822String();

Carbon::toIso8601ZuluString

Convert the instance to UTC and return as Zulu ISO8601

Examples:

echo Carbon::now()->toIso8601ZuluString();

Carbon::toRfc850String

Format the instance as RFC850

Examples:

echo Carbon::now()->toRfc850String();

Carbon::toRfc1036String

Format the instance as RFC1036

Examples:

echo Carbon::now()->toRfc1036String();

Carbon::toRfc1123String

Format the instance as RFC1123

Examples:

echo Carbon::now()->toRfc1123String();

Carbon::toRfc2822String

Format the instance as RFC2822

Examples:

echo Carbon::now()->toRfc2822String();

Carbon::toRfc3339String

Format the instance as RFC3339.

Examples:

echo Carbon::now()->toRfc3339String() . "\n";
echo Carbon::now()->toRfc3339String(true) . "\n";

Carbon::toRssString

Format the instance as RSS

Examples:

echo Carbon::now()->toRssString();

Carbon::toW3cString

Format the instance as W3C

Examples:

echo Carbon::now()->toW3cString();

Carbon::toRfc7231String

Format the instance as RFC7231

Examples:

echo Carbon::now()->toRfc7231String();

Carbon::toArray

Get default array representation.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::now()->toArray());

Carbon::toObject

Get default object representation.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::now()->toObject());

Carbon::toString

Returns english human-readable complete date string.

Examples:

echo Carbon::now()->toString();

Carbon::toISOString

Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z, if $keepOffset truthy, offset will be kept: 1977-04-22T01:00:00-05:00).

Examples:

echo Carbon::now('America/Toronto')->toISOString() . "\n";
echo Carbon::now('America/Toronto')->toISOString(true) . "\n";

Carbon::toJSON

Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z) with UTC timezone.

Examples:

echo Carbon::now('America/Toronto')->toJSON();

Carbon::toDateTime

Return native DateTime PHP object matching the current instance.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::now()->toDateTime());

Carbon::toDateTimeImmutable

Return native toDateTimeImmutable PHP object matching the current instance.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::now()->toDateTimeImmutable());

Carbon::toDate

@alias toDateTime

Return native DateTime PHP object matching the current instance.

Examples:

\Carbon\Doc\Generate\var_dump(Carbon::now()->toDate());

Carbon::toPeriod

Create a iterable CarbonPeriod object from current date to a given end date (and optional interval).

Carbon::range

Create a iterable CarbonPeriod object from current date to a given end date (and optional interval).

Carbon::resetToStringFormat

Reset the format used to the default when type juggling a Carbon instance to a string

Carbon::__clone

Update constructedObjectId on cloned.

Carbon::instance

Create a Carbon instance from a DateTime one.

Carbon::rawParse

Create a carbon instance from a string.

This is an alias for the constructor that allows better fluent syntax as it allows you to do Carbon::parse('Monday next week')->fn() rather than (new Carbon('Monday next week'))->fn().

Carbon::parse

Create a carbon instance from a string.

This is an alias for the constructor that allows better fluent syntax as it allows you to do Carbon::parse('Monday next week')->fn() rather than (new Carbon('Monday next week'))->fn().

Carbon::parseFromLocale

Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).

Carbon::now

Get a Carbon instance for the current date and time.

Carbon::today

Create a Carbon instance for today.

Carbon::tomorrow

Create a Carbon instance for tomorrow.

Carbon::yesterday

Create a Carbon instance for yesterday.

Carbon::create

Create a new Carbon instance from a specific date and time.

If any of $year, $month or $day are set to null their now() values will be used.

If $hour is null it will be set to its now() value and the default values for $minute and $second will be their now() values.

If $hour is not null then the default values for $minute and $second will be 0.

Carbon::createSafe

Create a new safe Carbon instance from a specific date and time.

If any of $year, $month or $day are set to null their now() values will be used.

If $hour is null it will be set to its now() value and the default values for $minute and $second will be their now() values.

If $hour is not null then the default values for $minute and $second will be 0.

If one of the set values is not valid, an InvalidDateException will be thrown.

Carbon::createStrict

Create a new Carbon instance from a specific date and time using strict validation.

Carbon::createFromDate

Create a Carbon instance from just a date. The time portion is set to now.

Carbon::createMidnightDate

Create a Carbon instance from just a date. The time portion is set to midnight.

Carbon::createFromTime

Create a Carbon instance from just a time. The date portion is set to today.

Carbon::createFromTimeString

Create a Carbon instance from a time string. The date portion is set to today.

Carbon::rawCreateFromFormat

Create a Carbon instance from a specific format.

Carbon::createFromIsoFormat

Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).

Carbon::createFromLocaleFormat

Create a Carbon instance from a specific format and a string in a given language.

Carbon::createFromLocaleIsoFormat

Create a Carbon instance from a specific ISO format and a string in a given language.

Carbon::make

Make a Carbon instance from given variable if possible.

Always return a new instance. Parse only strings and only these likely to be dates (skip intervals and recurrences). Throw an exception for invalid format, but otherwise return null.

Carbon::getClock

Carbon::diffAsDateInterval

Get the difference as a DateInterval instance. Return relative interval (negative if $absolute flag is not set to true and the given date is before current one).

Carbon::diffAsCarbonInterval

Get the difference as a CarbonInterval instance. Return relative interval (negative if $absolute flag is not set to true and the given date is before current one).

Carbon::diffInUnit

@param Unit|string $unit microsecond, millisecond, second, minute, hour, day, week, month, quarter, year, century, millennium

Carbon::diffInYears

Get the difference in years

Carbon::diffInQuarters

Get the difference in quarters.

Carbon::diffInMonths

Get the difference in months.

Carbon::diffInWeeks

Get the difference in weeks.

Carbon::diffInDays

Get the difference in days.

Carbon::diffInDaysFiltered

Get the difference in days using a filter closure.

Carbon::diffInHoursFiltered

Get the difference in hours using a filter closure.

Carbon::diffFiltered

Get the difference by the given interval using a filter closure.

Carbon::diffInWeekdays

Get the difference in weekdays.

Carbon::diffInWeekendDays

Get the difference in weekend days using a filter.

Carbon::diffInHours

Get the difference in hours.

Carbon::diffInMinutes

Get the difference in minutes.

Carbon::diffInSeconds

Get the difference in seconds.

Carbon::diffInMicroseconds

Get the difference in microseconds.

Carbon::diffInMilliseconds

Get the difference in milliseconds.

Carbon::secondsSinceMidnight

The number of seconds since midnight.

Carbon::secondsUntilEndOfDay

The number of seconds until 23:59:59.

Carbon::diffForHumans

Get the difference in a human readable format in the current locale from current instance to an other instance given (or now if null given).

Examples:

echo Carbon::tomorrow()->diffForHumans() . "\n";
echo Carbon::tomorrow()->diffForHumans(['parts' => 2]) . "\n";
echo Carbon::tomorrow()->diffForHumans(['parts' => 3, 'join' => true]) . "\n";
echo Carbon::tomorrow()->diffForHumans(Carbon::yesterday()) . "\n";
echo Carbon::tomorrow()->diffForHumans(Carbon::yesterday(), ['short' => true]) . "\n";

Carbon::from

@alias diffForHumans

Get the difference in a human readable format in the current locale from current instance to an other instance given (or now if null given).

Carbon::since

@alias diffForHumans

Get the difference in a human readable format in the current locale from current instance to an other instance given (or now if null given).

Carbon::to

Get the difference in a human readable format in the current locale from an other instance given (or now if null given) to current instance.

When comparing a value in the past to default now: 1 hour from now 5 months from now

When comparing a value in the future to default now: 1 hour ago 5 months ago

When comparing a value in the past to another value: 1 hour after 5 months after

When comparing a value in the future to another value: 1 hour before 5 months before

Carbon::until

@alias to

Get the difference in a human readable format in the current locale from an other instance given (or now if null given) to current instance.

Carbon::fromNow

Get the difference in a human readable format in the current locale from current instance to now.

Carbon::toNow

Get the difference in a human readable format in the current locale from an other instance given to now

Carbon::ago

Get the difference in a human readable format in the current locale from an other instance given to now

Carbon::timespan

Get the difference in a human-readable format in the current locale from current instance to another instance given (or now if null given).

Carbon::calendar

Returns either day of week + time (e.g. "Last Friday at 3:30 PM") if reference time is within 7 days, or a calendar date (e.g. "10/29/2017") otherwise.

Language, date and time formats will change according to the current locale.

Carbon::macro

Register a custom macro.

Pass null macro to remove it.

Examples:

$userSettings = [
  'locale' => 'pt',
  'timezone' => 'America/Sao_Paulo',
];
Carbon::macro('userFormat', function () use ($userSettings) {
  return $this->copy()->locale($userSettings['locale'])->tz($userSettings['timezone'])->calendar();
});
echo Carbon::yesterday()->hours(11)->userFormat();

Carbon::resetMacros

Remove all macros and generic macros.

Carbon::genericMacro

Register a custom macro.

Carbon::hasMacro

Checks if macro is registered globally.

Carbon::getMacro

Get the raw callable macro registered globally for a given name.

Carbon::hasLocalMacro

Checks if macro is registered globally or locally.

Carbon::getLocalMacro

Get the raw callable macro registered globally or locally for a given name.

Carbon::mixin

Mix another object into the class.

Examples:

Carbon::mixin(new class {
  public function addMoon() {
    return function () {
      return $this->addDays(30);
    };
  }
  public function subMoon() {
    return function () {
      return $this->subDays(30);
    };
  }
});
$fullMoon = Carbon::create('2018-12-22');
$nextFullMoon = $fullMoon->addMoon();
$blackMoon = Carbon::create('2019-01-06');
$previousBlackMoon = $blackMoon->subMoon();
echo "$nextFullMoon\n";
echo "$previousBlackMoon\n";

Carbon::getMidDayAt

get midday/noon hour

Carbon::midDay

Modify to midday, default to self::$midDayAt

Carbon::next

Modify to the next occurrence of a given modifier such as a day of the week. If no modifier is provided, modify to the next occurrence of the current day of the week. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::nextWeekday

Go forward to the next weekday.

Carbon::previousWeekday

Go backward to the previous weekday.

Carbon::nextWeekendDay

Go forward to the next weekend day.

Carbon::previousWeekendDay

Go backward to the previous weekend day.

Carbon::previous

Modify to the previous occurrence of a given modifier such as a day of the week. If no dayOfWeek is provided, modify to the previous occurrence of the current day of the week. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::firstOfMonth

Modify to the first occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the first day of the current month. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::lastOfMonth

Modify to the last occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the last day of the current month. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::nthOfMonth

Modify to the given occurrence of a given day of the week in the current month. If the calculated occurrence is outside the scope of the current month, then return false and no modifications are made. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::firstOfQuarter

Modify to the first occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the first day of the current quarter. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::lastOfQuarter

Modify to the last occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the last day of the current quarter. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::nthOfQuarter

Modify to the given occurrence of a given day of the week in the current quarter. If the calculated occurrence is outside the scope of the current quarter, then return false and no modifications are made. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::firstOfYear

Modify to the first occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the first day of the current year. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::lastOfYear

Modify to the last occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the last day of the current year. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::nthOfYear

Modify to the given occurrence of a given day of the week in the current year. If the calculated occurrence is outside the scope of the current year, then return false and no modifications are made. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.

Carbon::average

Modify the current instance to the average of a given instance (default now) and the current instance (second-precision).

Carbon::closest

Get the closest date from the instance (second-precision).

Carbon::farthest

Get the farthest date from the instance (second-precision).

Carbon::min

Get the minimum instance between a given instance (default now) and the current instance.

Carbon::minimum

Get the minimum instance between a given instance (default now) and the current instance.

Carbon::max

Get the maximum instance between a given instance (default now) and the current instance.

Carbon::maximum

Get the maximum instance between a given instance (default now) and the current instance.

Carbon::change

Similar to native modify() method of DateTime but can handle more grammars.

Examples:

echo Carbon::now()->change('next 2pm');

Carbon::isImmutable

Returns true if the current class/instance is immutable.

Carbon::toMutable

Return a mutable copy of the instance.

Carbon::toImmutable

Return a immutable copy of the instance.

Carbon::cast

Cast the current instance into the given class.

Carbon::settings

Set specific options. - strictMode: true|false|null - monthOverflow: true|false|null - yearOverflow: true|false|null - humanDiffOptions: int|null - toStringFormat: string|Closure|null - toJsonFormat: string|Closure|null - locale: string|null - timezone: \DateTimeZone|string|int|null - macros: array|null - genericMacros: array|null

Carbon::getSettings

Returns current local settings.

Carbon::__debugInfo

Show truthy properties on \Carbon\Doc\Generate\var_dump().

Carbon::isStrictModeEnabled

Returns true if the strict mode is globally in use, false else. (It can be overridden in specific instances.)

Carbon::shouldOverflowMonths

Get the month overflow global behavior (can be overridden in specific instances).

Carbon::shouldOverflowYears

Get the month overflow global behavior (can be overridden in specific instances).

Carbon::hasLocalTranslator

Return true if the current instance has its own translator.

Carbon::getLocalTranslator

Get the translator of the current instance or the default if none set.

Carbon::setLocalTranslator

Set the translator for the current instance.

Carbon::getTranslationMessageWith

Returns raw translation message for a given key.

Carbon::getTranslationMessage

Returns raw translation message for a given key.

Carbon::translateWith

Translate using translation string or callback available.

Carbon::translate

Translate using translation string or callback available.

Carbon::translateNumber

Returns the alternative number for a given integer if available in the current locale.

Carbon::translateTimeString

Translate a time string from a locale to an other.

Carbon::translateTimeStringTo

Translate a time string from the current locale (`$date->locale()`) to an other.

Carbon::locale

Get/set the locale for the current instance.

Carbon::getLocale

Get the current translator locale.

Carbon::setLocale

Set the current translator locale and indicate if the source locale file exists. Pass 'auto' as locale to use the closest language to the current LC_TIME locale.

Carbon::setFallbackLocale

Set the fallback locale.

Carbon::getFallbackLocale

Get the fallback locale.

Carbon::executeWithLocale

Set the current locale to the given, execute the passed function, reset the locale to previous one, then return the result of the closure (or null if the closure was void).

Carbon::localeHasShortUnits

Returns true if the given locale is internally supported and has short-units support. Support is considered enabled if either year, day or hour has a short variant translated.

Carbon::localeHasDiffSyntax

Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after). Support is considered enabled if the 4 sentences are translated in the given locale.

Carbon::localeHasDiffOneDayWords

Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow). Support is considered enabled if the 3 words are translated in the given locale.

Carbon::localeHasDiffTwoDayWords

Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow). Support is considered enabled if the 2 words are translated in the given locale.

Carbon::localeHasPeriodSyntax

Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X). Support is considered enabled if the 4 sentences are translated in the given locale.

Carbon::getAvailableLocales

Returns the list of internally available locales and already loaded custom locales. (It will ignore custom translator dynamic loading.)

Carbon::getAvailableLocalesInfo

Returns list of Language object for each available locale. This object allow you to get the ISO name, native name, region and variant of the locale.

Carbon::getHumanDiffOptions

Return default humanDiff() options (merged flags as integer).

Carbon::setTranslator

Set the default translator instance to use.

Carbon::getTranslator

Initialize the default translator instance if necessary.

Carbon::roundUnit

Round the current instance at the given unit with given precision if specified and the given function.

Carbon::floorUnit

Truncate the current instance at the given unit with given precision if specified.

Carbon::ceilUnit

Ceil the current instance at the given unit with given precision if specified.

Carbon::round

Round the current instance second with given precision if specified.

Carbon::floor

Round the current instance second with given precision if specified.

Carbon::ceil

Ceil the current instance second with given precision if specified.

Carbon::roundWeek

Round the current instance week.

Carbon::floorWeek

Truncate the current instance week.

Carbon::ceilWeek

Ceil the current instance week.

Carbon::serialize

Return a serialized string of the instance.

Carbon::fromSerialized

Create an instance from a serialized string.

Carbon::__sleep

Returns the list of properties to dump on serialize() called on.

Only used by PHP < 7.4.

Carbon::jsonSerialize

Prepare the object for JSON serialization.

Carbon::cleanupDumpProperties

Cleanup properties attached to the public scope of DateTime when a dump of the date is requested. foreach ($date as $_) {} serializer($date) var_export($date) get_object_vars($date)

Carbon::setTestNow

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions: - A call to the static now() method, ex. Carbon::now() - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null) - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now') - When a string containing the desired time is passed to Carbon::parse().

Note the timezone parameter was left out of the examples above and has no affect as the mock value will be returned regardless of its value.

Only the moment is mocked with setTestNow(), the timezone will still be the one passed as parameter of date_default_timezone_get() as a fallback (see setTestNowAndTimezone()).

To clear the test instance call this method using the default parameter of null.

/!\ Use this method for unit tests only.

Carbon::setTestNowAndTimezone

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions: - A call to the static now() method, ex. Carbon::now() - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null) - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now') - When a string containing the desired time is passed to Carbon::parse().

It will also align default timezone (e.g. call date_default_timezone_set()) with the second argument or if null, with the timezone of the given date object.

To clear the test instance call this method using the default parameter of null.

/!\ Use this method for unit tests only.

Carbon::withTestNow

Temporarily sets a static date to be used within the callback. Using setTestNow to set the date, executing the callback, then clearing the test instance.

/!\ Use this method for unit tests only.

Carbon::getTestNow

Get the Carbon instance (real or mock) to be returned when a "now" instance is created.

Carbon::hasTestNow

Determine if there is a valid test instance set. A valid test instance is anything that is not null.

Carbon::createFromTimestamp

Create a Carbon instance from a timestamp and set the timezone (UTC by default).

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::createFromTimestampUTC

Create a Carbon instance from a timestamp keeping the timezone to UTC.

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::createFromTimestampMsUTC

Create a Carbon instance from a timestamp in milliseconds.

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::createFromTimestampMs

Create a Carbon instance from a timestamp in milliseconds.

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::timestamp

Set the instance's timestamp.

Timestamp input can be given as int, float or a string containing one or more numbers.

Carbon::getPreciseTimestamp

Returns a timestamp rounded with the given precision (6 by default).

Examples:

getPreciseTimestamp()   1532087464437474 (microsecond maximum precision)

getPreciseTimestamp(6)  1532087464437474

getPreciseTimestamp(5)  153208746443747  (1/100000 second precision)

getPreciseTimestamp(4)  15320874644375   (1/10000 second precision)

getPreciseTimestamp(3)  1532087464437    (millisecond precision)

getPreciseTimestamp(2)  153208746444     (1/100 second precision)

getPreciseTimestamp(1)  15320874644      (1/10 second precision)

getPreciseTimestamp(0)  1532087464       (second precision)

getPreciseTimestamp(-1) 153208746        (10 second precision)

getPreciseTimestamp(-2) 15320875         (100 second precision)

Carbon::valueOf

Returns the milliseconds timestamps used amongst other by Date javascript objects.

Carbon::getTimestampMs

Returns the timestamp with millisecond precision.

Carbon::unix

@alias getTimestamp

Returns the UNIX timestamp for the current date.

Carbon::addUTCUnit

Add seconds to the instance using timestamp. Positive $value travels forward while negative $value travels into the past.

Carbon::subUTCUnit

Subtract seconds to the instance using timestamp. Positive $value travels into the past while negative $value travels forward.

Carbon::isModifiableUnit

Returns true if a property can be changed via setter.

Carbon::rawAdd

Call native PHP DateTime/DateTimeImmutable add() method.

Carbon::addUnit

Add given units to the current instance.

Carbon::subUnit

Subtract given units to the current instance.

Carbon::rawSub

Call native PHP DateTime/DateTimeImmutable sub() method.

Carbon::subtract

Subtract given units or interval to the current instance.

Carbon::isoWeekYear

Set/get the week number of year using given first day of week and first day of year included in the first week. Or use ISO format if no settings given.

Carbon::weekYear

Set/get the week number of year using given first day of week and first day of year included in the first week. Or use US format if no settings given (Sunday / Jan 6).

Carbon::isoWeeksInYear

Get the number of weeks of the current week-year using given first day of week and first day of year included in the first week. Or use ISO format if no settings given.

Carbon::weeksInYear

Get the number of weeks of the current week-year using given first day of week and first day of year included in the first week. Or use US format if no settings given (Sunday / Jan 6).

Carbon::week

Get/set the week number using given first day of week and first day of year included in the first week. Or use US format if no settings given (Sunday / Jan 6).

Carbon::isoWeek

Get/set the week number using given first day of week and first day of year included in the first week. Or use ISO format if no settings given.

Carbon::normalizeDay

Returns day English name in lower case.

Carbon::convertOpeningHours

Returns an OpeningHours instance (the one given if already an instance of OpeningHours, or else create a new one from array definition given).

Carbon::enable

Carbon::setOpeningHours

Set the opening hours for the class/instance.

Carbon::resetOpeningHours

Reset the opening hours for the class/instance.

Carbon::getOpeningHours

Get the opening hours of the class/instance.

Carbon::safeCallOnOpeningHours

Call a method on the OpeningHours of the current instance.

Carbon::getCalleeAsMethod

Get a closure to be executed on OpeningHours on the current instance (or now if called globally) that should return a date, then convert it into a Carbon/sub-class instance.

Carbon::getMethodLoopOnHoliday

Loop on the current instance (or now if called statically) with a given method until it's not a holiday.

Carbon::getTernaryMethod

Get a method that return current date-time if $testMethod applied on it return true, else return the result of $method called on it.

Carbon::addBusinessDays

Add a given number of business days to the current date.

Carbon::addBusinessDay

Add a given number of business days to the current date.

Carbon::subBusinessDays

Add a given number of business days to the current date.

Carbon::subtractBusinessDays

Add a given number of business days to the current date.

Carbon::subBusinessDay

Add a given number of business days to the current date.

Carbon::subtractBusinessDay

Add a given number of business days to the current date.

Carbon::diffInBusinessDays

Returns the difference between 2 dates in business days.

Carbon::getBusinessDaysInMonth

Get the number of business days in the current month.

Carbon::getMonthBusinessDays

Get list of date objects for each business day in the current month.

Carbon::setBusinessDayChecker

Checks the date to see if it is a business day (neither a weekend day nor a holiday).

Carbon::isBusinessDay

Checks the date to see if it is a business day (extra workday or neither a weekend day nor a holiday).

Carbon::nextBusinessDay

Sets the date to the next business day (neither a weekend day nor a holiday).

Carbon::currentOrNextBusinessDay

Sets the date to the current or next business day (neither a weekend day nor a holiday).

Carbon::previousBusinessDay

Sets the date to the next business day (neither a weekend day nor a holiday).

Carbon::currentOrPreviousBusinessDay

Sets the date to the current or next business day (neither a weekend day nor a holiday).

Carbon::setObservedHolidaysZone

Set the selected zone for observed holidays. So next observe methods will be saved and considered in this given custom zone.

Carbon::getObservedHolidaysZone

Get the selected zone for observed holidays.

Carbon::setHolidayObserveStatus

Set a holiday as observed/unobserved in the selected zone.

Carbon::getObserveHolidayMethod

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::observeHoliday

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::unobserveHoliday

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::observeHolidays

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::unobserveHolidays

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::observeAllHolidays

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::unobserveAllHolidays

Set a holiday as observed/unobserved in the selected zone (can take array of holidays).

Carbon::checkObservedHoliday

Check if a given holiday ID is observed in the selected zone.

Carbon::isObservedHoliday

Checks the date to see if it is a holiday observed in the selected zone.

Carbon::setHolidayGetter

Set the strategy to get the holiday ID from a date object.

Carbon::setExtraWorkdayGetter

Set the strategy to get the extra workday ID from a date object.

Carbon::getDBDayId

Get the identifier of the current holiday or false if it's not a holiday.

Carbon::getHolidayId

Get the identifier of the current holiday or false if it's not a holiday.

Carbon::isHoliday

Checks the date to see if it is a holiday.

Carbon::getExtraWorkdayId

Get the identifier of the current special workday or false if it's not a special workday.

Carbon::isExtraWorkday

Checks the date to see if it is a holiday.

Carbon::getHolidayNamesDictionary

Get the holidays in the given language.

Carbon::getHolidayName

Get the name of the current holiday (using the locale given in parameter or the current date locale) or false if it's not a holiday.

Carbon::getYearHolidays

Get the holidays dates for a given year (current year if no parameter given).

Carbon::getYearHolidaysNextFunction

Get a next() callback to call to iterate over holidays of a year.

Carbon::standardizeHolidaysRegion

Return a standardized region name.

Carbon::getHolidaysAvailableRegions

Get the current holidays region.

Carbon::setHolidaysRegion

Set the holidays region (see src/Cmixin/Holidays for examples).

Carbon::getHolidaysRegion

Get the current holidays region.

Carbon::getBDDaysList

Get the holidays for the current region selected.

Carbon::getHolidays

Get the holidays for the current region selected.

Carbon::setHolidays

Set the holidays list.

Carbon::getExtraWorkdays

Get the holidays for the current region selected.

Carbon::setExtraWorkdays

Set the holidays list.

Carbon::resetHolidays

Reset the holidays list.

Carbon::initializeHolidaysRegion

Carbon::pushToBDList

Push a day into a given list list of a region.

Carbon::pushHoliday

Push a holiday to the holidays list of a region.

Carbon::pushWorkday

Push a workday to the workdays list of a region.

Carbon::setHolidayName

Set/change the name of holiday by ID for a given language (or a list of languages).

Carbon::addHoliday

Add a holiday to the holidays list of a region and optionally init its ID, name and observed state.

Carbon::addExtraWorkday

Add a workday to the workdays list of a region and optionally init its ID and name.

Carbon::unpackHoliday

Unpack a holiday array definition.

Carbon::checkHoliday

Check a holiday definition and unpack it if it's an array.

Carbon::addHolidays

Add a holiday to the holidays list of a region and optionally init their IDs, names and observed states (if provided as array-definitions).

Carbon::isDateTimeInstance

Return true if the given value is a DateTime or DateTimeInterface.

Carbon::swapDateTimeParam

Store a first variable as Carbon instance into the second variable if the first one is a date.

Carbon::skipMissingCalendarExtensionException

@codeCoverageIgnore

Carbon::shouldRaiseMissingCalendarExtensionException

Carbon::getHolidayDataById

Get stored data set for the a given holiday ID.

Carbon::setHolidayDataById

Set stored data set for the a given holiday ID.

Carbon::getHolidayData

Get stored data set for the current holiday or null if it's not a holiday.

Carbon::setHolidayData

Set stored data set for the current holiday, does nothing if it's not a holiday.

Carbon::setMaxIteration

Set the maximum of loop turns to run before throwing an exception where trying to add or subtract open/closed time.

Carbon::getMaxIteration

Get the maximum of loop turns to run before throwing an exception where trying to add or subtract open/closed time.

Carbon::applyBusinessInterval

Shift current time with a given interval taking into account only open time (if $open is true) or only closed time (if $open is false).

Carbon::addBusinessInterval

Add the given interval taking into account only open time (if $open is true) or only closed time (if $open is false).

Carbon::subBusinessInterval

Add the given interval taking into account only open time (if $open is true) or only closed time (if $open is false).

Carbon::addOpenTime

Add the given interval taking into account only open time.

Carbon::subOpenTime

Subtract the given interval taking into account only open time.

Carbon::addClosedTime

Add the given interval taking into account only closed time.

Carbon::subClosedTime

Subtract the given interval taking into account only closed time.

Carbon::addOpenMinutes

Add the given number of minutes taking into account only open time.

Carbon::subOpenMinutes

Subtract the given number of minutes taking into account only open time.

Carbon::addClosedMinutes

Add the given number of minutes taking into account only closed time.

Carbon::subClosedMinutes

Subtract the given number of minutes taking into account only closed time.

Carbon::addOpenHours

Add the given number of hours taking into account only open time.