Date

Date · Type

A Date is a single moment in time, down to the second. You get one from mash.date, from a file’s modified, from a field that holds a date, or from an event. It has a long list of methods, and the generated list below is complete. This page shows how they fit together.

How it works

Read the parts as properties. year, month, day, hour, minute, second, dayOfWeek (0 is Sunday), dayOfYear, weekOfYear, quarter, daysInMonth and timestamp (seconds since 1970).

Change it with add and sub. addDays, addWeeks, addMonths, addYears, addHours, addMinutes and their sub twins. Each one changes the date itself and returns it, so calls chain: d.copy().addMonths(1).startOfMonth(). Add a negative number to go back.

Jump with startOf and endOf. startOfDay, startOfWeek, startOfMonth, startOfYear, and the matching endOf methods. next("friday") and previous("monday") move to a named day. setDate(y, m, d) and setTime(h, i, s) set parts directly.

Compare with <, > and ==, or by name. lt, gt, eq, between(a, b), isSameDay(other), isPast(), isFuture(), isWeekend(), isTuesday() and so on.

Measure with diffIn.... diffInDays, diffInHours, diffInMinutes and friends. They return a number, often with a fraction, and they’re signed.

Write with format or isoFormat. format uses PHP’s letters (Y year, m month, d day, H:i time, D and l day names, j day without a leading zero, M and F month names). isoFormat uses the letter style from moment.js (dddd D MMMM YYYY). toDateString() gives 2026-11-03 and toIso8601String() gives the full timestamp with its offset. diffForHumans() says “6 hours ago”, relative to now.

Common tasks

Step through the next few working days:

set d to mash.date.parse("2026-11-03")
set i to 0
while i is less than 4
    d.addWeekday()
    printline d.format("D j M")
    increment i by 1
end

Wed 4 Nov
Thu 5 Nov
Fri 6 Nov
Mon 9 Nov

Find the first and last day of a month:

set d to mash.date.parse("2026-02-14")
printline d.copy().startOfMonth().format("Y-m-d")
printline d.copy().endOfMonth().format("Y-m-d")

2026-02-01
2026-02-28

Measure the gap between two dates:

set a to mash.date.parse("2026-11-03 14:05:00")
set b to mash.date.parse("2026-11-03 18:35:00")
printline a.diffInHours(b)
printline b.diffInHours(a)
printline b.diffInHours(a, true)

4.5
-4.5
4.5

Change the time of day and print it several ways:

set d to mash.date.parse("2026-11-03 14:05:09")
d.setTime(9, 0)
printline d.format("H:i:s")
printline d.isoFormat("dddd D MMMM")
printline d.toDateString()

09:00:00
Tuesday 3 November
2026-11-03

Watch out for

• Dates change in place. d.addDays(30) moves d and returns the same date. Use copy() first, or clone(d), when you need the original too. Plain assignment (set later to start) doesn’t copy.
• diffInDays(other) is signed: positive when other is later. Pass true as the second argument for the plain distance.
• addMonth can overflow. From 31 January it lands in March. addMonthNoOverflow stops at the end of February.
• dayOfWeek starts at Sunday = 0. Name the day (isMonday()) when you can.
• Two dates with different times aren’t ==. To ask “same day”, use isSameDay, or compare toDateString() values.
• Time zones. format shows the date in its own time zone. Add P to show the offset.

See also

mash.date, and Talking to the outside world for the first look at dates.

Properties

Name	Type	Description
age	int
centuriesInMillennium	int
century	int
centuryOfMillennium	int
day	int
dayName	string
dayOfCentury	int
dayOfDecade	int
dayOfMillennium	int
dayOfMonth	int
dayOfQuarter	int
dayOfWeek	int
dayOfWeekIso	int
dayOfYear	int
daysInCentury	int
daysInDecade	int
daysInMillennium	int
daysInMonth	int
daysInQuarter	int
daysInWeek	int
daysInYear	int
decade	int
decadeOfCentury	int
decadeOfMillennium	int
decadesInCentury	int
decadesInMillennium	int
dst	bool
englishDayOfWeek	string
englishMonth	string
firstWeekDay	int
hour	int
hourOfCentury	int
hourOfDay	int
hourOfDecade	int
hourOfMillennium	int
hourOfMonth	int
hourOfQuarter	int
hourOfWeek	int
hourOfYear	int
hoursInCentury	int
hoursInDay	int
hoursInDecade	int
hoursInMillennium	int
hoursInMonth	int
hoursInQuarter	int
hoursInWeek	int
hoursInYear	int
isoWeek	int
isoWeekYear	int
isoWeeksInYear	int
lastWeekDay	int
latinMeridiem	string
latinUpperMeridiem	string
local	bool
locale	string
localeDayOfWeek	string
localeMonth	string
meridiem	string
micro	int
microsecond	int
microsecondOfCentury	int
microsecondOfDay	int
microsecondOfDecade	int
microsecondOfHour	int
microsecondOfMillennium	int
microsecondOfMillisecond	int
microsecondOfMinute	int
microsecondOfMonth	int
microsecondOfQuarter	int
microsecondOfSecond	int
microsecondOfWeek	int
microsecondOfYear	int
microsecondsInCentury	int
microsecondsInDay	int
microsecondsInDecade	int
microsecondsInHour	int
microsecondsInMillennium	int
microsecondsInMillisecond	int
microsecondsInMinute	int
microsecondsInMonth	int
microsecondsInQuarter	int
microsecondsInSecond	int
microsecondsInWeek	int
microsecondsInYear	int
millennium	int
milli	int
millisecond	int
millisecondOfCentury	int
millisecondOfDay	int
millisecondOfDecade	int
millisecondOfHour	int
millisecondOfMillennium	int
millisecondOfMinute	int
millisecondOfMonth	int
millisecondOfQuarter	int
millisecondOfSecond	int
millisecondOfWeek	int
millisecondOfYear	int
milliseconds	int
millisecondsInCentury	int
millisecondsInDay	int
millisecondsInDecade	int
millisecondsInHour	int
millisecondsInMillennium	int
millisecondsInMinute	int
millisecondsInMonth	int
millisecondsInQuarter	int
millisecondsInSecond	int
millisecondsInWeek	int
millisecondsInYear	int
minDayName	string
minute	int
minuteOfCentury	int
minuteOfDay	int
minuteOfDecade	int
minuteOfHour	int
minuteOfMillennium	int
minuteOfMonth	int
minuteOfQuarter	int
minuteOfWeek	int
minuteOfYear	int
minutesInCentury	int
minutesInDay	int
minutesInDecade	int
minutesInHour	int
minutesInMillennium	int
minutesInMonth	int
minutesInQuarter	int
minutesInWeek	int
minutesInYear	int
month	int
monthName	string
monthOfCentury	int
monthOfDecade	int
monthOfMillennium	int
monthOfQuarter	int
monthOfYear	int
monthsInCentury	int
monthsInDecade	int
monthsInMillennium	int
monthsInQuarter	int
monthsInYear	int
noZeroHour	int
offset	int
offsetHours	int
offsetMinutes	int
quarter	int
quarterOfCentury	int
quarterOfDecade	int
quarterOfMillennium	int
quarterOfYear	int
quartersInCentury	int
quartersInDecade	int
quartersInMillennium	int
quartersInYear	int
second	int
secondOfCentury	int
secondOfDay	int
secondOfDecade	int
secondOfHour	int
secondOfMillennium	int
secondOfMinute	int
secondOfMonth	int
secondOfQuarter	int
secondOfWeek	int
secondOfYear	int
secondsInCentury	int
secondsInDay	int
secondsInDecade	int
secondsInHour	int
secondsInMillennium	int
secondsInMinute	int
secondsInMonth	int
secondsInQuarter	int
secondsInWeek	int
secondsInYear	int
shortDayName	string
shortEnglishDayOfWeek	string
shortEnglishMonth	string
shortLocaleDayOfWeek	string
shortLocaleMonth	string
shortMonthName	string
timestamp	int	float
timezone	CarbonTimeZone
timezoneAbbreviatedName	string
timezoneName	string
tz	CarbonTimeZone
tzAbbrName	string
tzName	string
upperMeridiem	string
utc	bool
week	int
weekNumberInMonth	int
weekOfCentury	int
weekOfDecade	int
weekOfMillennium	int
weekOfMonth	int
weekOfQuarter	int
weekOfYear	int
weekYear	int
weeksInCentury	int
weeksInDecade	int
weeksInMillennium	int
weeksInMonth	int
weeksInQuarter	int
weeksInYear	int
year	int
yearIso	int
yearOfCentury	int
yearOfDecade	int
yearOfMillennium	int
yearsInCentury	int
yearsInDecade	int
yearsInMillennium	int

Methods

add

Changes the value

date.add(unit: mixed, value?: mixed = 1, overflow?: bool) → Date

Add given units or interval to the current instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

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

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

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

addCenturies

Changes the value

date.addCenturies(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturiesNoOverflow

Changes the value

date.addCenturiesNoOverflow(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturiesWithNoOverflow

Changes the value

date.addCenturiesWithNoOverflow(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturiesWithOverflow

Changes the value

date.addCenturiesWithOverflow(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturiesWithoutOverflow

Changes the value

date.addCenturiesWithoutOverflow(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCentury

Changes the value

date.addCentury() → Date

Add one century to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturyNoOverflow

Changes the value

date.addCenturyNoOverflow() → Date

Add one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturyWithNoOverflow

Changes the value

date.addCenturyWithNoOverflow() → Date

Add one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturyWithOverflow

Changes the value

date.addCenturyWithOverflow() → Date

Add one century to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addCenturyWithoutOverflow

Changes the value

date.addCenturyWithoutOverflow() → Date

Add one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDay

Changes the value

date.addDay() → Date

Add one day to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addDays

Changes the value

date.addDays(value?: int|float) → Date

Add days (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecade

Changes the value

date.addDecade() → Date

Add one decade to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadeNoOverflow

Changes the value

date.addDecadeNoOverflow() → Date

Add one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadeWithNoOverflow

Changes the value

date.addDecadeWithNoOverflow() → Date

Add one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadeWithOverflow

Changes the value

date.addDecadeWithOverflow() → Date

Add one decade to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadeWithoutOverflow

Changes the value

date.addDecadeWithoutOverflow() → Date

Add one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecades

Changes the value

date.addDecades(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadesNoOverflow

Changes the value

date.addDecadesNoOverflow(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadesWithNoOverflow

Changes the value

date.addDecadesWithNoOverflow(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadesWithOverflow

Changes the value

date.addDecadesWithOverflow(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addDecadesWithoutOverflow

Changes the value

date.addDecadesWithoutOverflow(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addHour

Changes the value

date.addHour() → Date

Add one hour to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addHours

Changes the value

date.addHours(value?: int|float) → Date

Add hours (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMicro

Changes the value

date.addMicro() → Date

Add one microsecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMicros

Changes the value

date.addMicros(value?: int|float) → Date

Add microseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMicrosecond

Changes the value

date.addMicrosecond() → Date

Add one microsecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMicroseconds

Changes the value

date.addMicroseconds(value?: int|float) → Date

Add microseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillennia

Changes the value

date.addMillennia(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniaNoOverflow

Changes the value

date.addMillenniaNoOverflow(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniaWithNoOverflow

Changes the value

date.addMillenniaWithNoOverflow(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniaWithOverflow

Changes the value

date.addMillenniaWithOverflow(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniaWithoutOverflow

Changes the value

date.addMillenniaWithoutOverflow(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillennium

Changes the value

date.addMillennium() → Date

Add one millennium to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniumNoOverflow

Changes the value

date.addMillenniumNoOverflow() → Date

Add one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniumWithNoOverflow

Changes the value

date.addMillenniumWithNoOverflow() → Date

Add one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniumWithOverflow

Changes the value

date.addMillenniumWithOverflow() → Date

Add one millennium to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillenniumWithoutOverflow

Changes the value

date.addMillenniumWithoutOverflow() → Date

Add one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMilli

Changes the value

date.addMilli() → Date

Add one millisecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillis

Changes the value

date.addMillis(value?: int|float) → Date

Add milliseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMillisecond

Changes the value

date.addMillisecond() → Date

Add one millisecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMilliseconds

Changes the value

date.addMilliseconds(value?: int|float) → Date

Add milliseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMinute

Changes the value

date.addMinute() → Date

Add one minute to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMinutes

Changes the value

date.addMinutes(value?: int|float) → Date

Add minutes (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonth

Changes the value

date.addMonth() → Date

Add one month to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthNoOverflow

Changes the value

date.addMonthNoOverflow() → Date

Add one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthWithNoOverflow

Changes the value

date.addMonthWithNoOverflow() → Date

Add one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthWithOverflow

Changes the value

date.addMonthWithOverflow() → Date

Add one month to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthWithoutOverflow

Changes the value

date.addMonthWithoutOverflow() → Date

Add one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonths

Changes the value

date.addMonths(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthsNoOverflow

Changes the value

date.addMonthsNoOverflow(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthsWithNoOverflow

Changes the value

date.addMonthsWithNoOverflow(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthsWithOverflow

Changes the value

date.addMonthsWithOverflow(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addMonthsWithoutOverflow

Changes the value

date.addMonthsWithoutOverflow(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarter

Changes the value

date.addQuarter() → Date

Add one quarter to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarterNoOverflow

Changes the value

date.addQuarterNoOverflow() → Date

Add one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarterWithNoOverflow

Changes the value

date.addQuarterWithNoOverflow() → Date

Add one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarterWithOverflow

Changes the value

date.addQuarterWithOverflow() → Date

Add one quarter to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarterWithoutOverflow

Changes the value

date.addQuarterWithoutOverflow() → Date

Add one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuarters

Changes the value

date.addQuarters(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuartersNoOverflow

Changes the value

date.addQuartersNoOverflow(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuartersWithNoOverflow

Changes the value

date.addQuartersWithNoOverflow(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuartersWithOverflow

Changes the value

date.addQuartersWithOverflow(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addQuartersWithoutOverflow

Changes the value

date.addQuartersWithoutOverflow(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addRealUnit

Changes the value

date.addRealUnit(unit: string, value?: int = 1) → Date

Changes this date in place and returns it. Use date.copy() first to keep the original.

addSecond

Changes the value

date.addSecond() → Date

Add one second to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addSeconds

Changes the value

date.addSeconds(value?: int|float) → Date

Add seconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCCenturies

Changes the value

date.addUTCCenturies(value?: int|float) → Date

Add centuries (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCCentury

Changes the value

date.addUTCCentury() → Date

Add one century to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCDay

Changes the value

date.addUTCDay() → Date

Add one day to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCDays

Changes the value

date.addUTCDays(value?: int|float) → Date

Add days (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCDecade

Changes the value

date.addUTCDecade() → Date

Add one decade to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCDecades

Changes the value

date.addUTCDecades(value?: int|float) → Date

Add decades (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCHour

Changes the value

date.addUTCHour() → Date

Add one hour to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCHours

Changes the value

date.addUTCHours(value?: int|float) → Date

Add hours (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMicro

Changes the value

date.addUTCMicro() → Date

Add one microsecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMicros

Changes the value

date.addUTCMicros(value?: int|float) → Date

Add microseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMicrosecond

Changes the value

date.addUTCMicrosecond() → Date

Add one microsecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMicroseconds

Changes the value

date.addUTCMicroseconds(value?: int|float) → Date

Add microseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMillennia

Changes the value

date.addUTCMillennia(value?: int|float) → Date

Add millennia (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMillennium

Changes the value

date.addUTCMillennium() → Date

Add one millennium to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMilli

Changes the value

date.addUTCMilli() → Date

Add one millisecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMillis

Changes the value

date.addUTCMillis(value?: int|float) → Date

Add milliseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMillisecond

Changes the value

date.addUTCMillisecond() → Date

Add one millisecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMilliseconds

Changes the value

date.addUTCMilliseconds(value?: int|float) → Date

Add milliseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMinute

Changes the value

date.addUTCMinute() → Date

Add one minute to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMinutes

Changes the value

date.addUTCMinutes(value?: int|float) → Date

Add minutes (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMonth

Changes the value

date.addUTCMonth() → Date

Add one month to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCMonths

Changes the value

date.addUTCMonths(value?: int|float) → Date

Add months (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCQuarter

Changes the value

date.addUTCQuarter() → Date

Add one quarter to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCQuarters

Changes the value

date.addUTCQuarters(value?: int|float) → Date

Add quarters (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCSecond

Changes the value

date.addUTCSecond() → Date

Add one second to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCSeconds

Changes the value

date.addUTCSeconds(value?: int|float) → Date

Add seconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCUnit

Changes the value

date.addUTCUnit(unit: string, value?: int = 1) → Date

Add seconds to the instance using timestamp. Positive $value travels forward while negative $value travels into the past. Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCWeek

Changes the value

date.addUTCWeek() → Date

Add one week to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCWeeks

Changes the value

date.addUTCWeeks(value?: int|float) → Date

Add weeks (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCYear

Changes the value

date.addUTCYear() → Date

Add one year to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUTCYears

Changes the value

date.addUTCYears(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

addUnit

Changes the value

date.addUnit(unit: Unit, value?: mixed = 1, overflow?: bool) → Date

Add given units to the current instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

addUnitNoOverflow

Changes the value

date.addUnitNoOverflow(valueUnit: string, value: int, overflowUnit: string) → Date

Add any unit to a new value without overflowing current other unit given. Changes this date in place and returns it. Use date.copy() first to keep the original.

addWeek

Changes the value

date.addWeek() → Date

Add one week to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addWeekday

Changes the value

date.addWeekday() → Date

Add one weekday to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addWeekdays

Changes the value

date.addWeekdays(value?: int|float) → Date

Add weekdays (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addWeeks

Changes the value

date.addWeeks(value?: int|float) → Date

Add weeks (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addYear

Changes the value

date.addYear() → Date

Add one year to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearNoOverflow

Changes the value

date.addYearNoOverflow() → Date

Add one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearWithNoOverflow

Changes the value

date.addYearWithNoOverflow() → Date

Add one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearWithOverflow

Changes the value

date.addYearWithOverflow() → Date

Add one year to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearWithoutOverflow

Changes the value

date.addYearWithoutOverflow() → Date

Add one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYears

Changes the value

date.addYears(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearsNoOverflow

Changes the value

date.addYearsNoOverflow(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearsWithNoOverflow

Changes the value

date.addYearsWithNoOverflow(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearsWithOverflow

Changes the value

date.addYearsWithOverflow(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

addYearsWithoutOverflow

Changes the value

date.addYearsWithoutOverflow(value?: int|float) → Date

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

ago

date.ago(syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

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

average

date.average(date?: Date) → Date

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

avoidMutation

date.avoidMutation() → Date

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.

between

date.between(date1: DateTimeInterface, date2: DateTimeInterface, equal?: bool = true) → bool

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.

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

betweenExcluded

date.betweenExcluded(date1: DateTimeInterface, date2: DateTimeInterface) → bool

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

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

betweenIncluded

date.betweenIncluded(date1: DateTimeInterface, date2: DateTimeInterface) → bool

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

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

calendar

date.calendar(referenceTime?: mixed, formats?: array = []) → string

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.

carbonize

date.carbonize(date?: Date) → Date

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

ceil

Changes the value

date.ceil(precision?: DateInterval = 1) → Date

Ceil the current instance second with given precision if specified. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilCenturies

Changes the value

date.ceilCenturies(precision?: float) → Date

Ceil the current instance century with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilCentury

Changes the value

date.ceilCentury(precision?: float) → Date

Ceil the current instance century with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilDay

Changes the value

date.ceilDay(precision?: float) → Date

Ceil the current instance day with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilDays

Changes the value

date.ceilDays(precision?: float) → Date

Ceil the current instance day with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilDecade

Changes the value

date.ceilDecade(precision?: float) → Date

Ceil the current instance decade with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilDecades

Changes the value

date.ceilDecades(precision?: float) → Date

Ceil the current instance decade with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilHour

Changes the value

date.ceilHour(precision?: float) → Date

Ceil the current instance hour with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilHours

Changes the value

date.ceilHours(precision?: float) → Date

Ceil the current instance hour with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMicrosecond

Changes the value

date.ceilMicrosecond(precision?: float) → Date

Ceil the current instance microsecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMicroseconds

Changes the value

date.ceilMicroseconds(precision?: float) → Date

Ceil the current instance microsecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMillennia

Changes the value

date.ceilMillennia(precision?: float) → Date

Ceil the current instance millennium with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMillennium

Changes the value

date.ceilMillennium(precision?: float) → Date

Ceil the current instance millennium with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMillisecond

Changes the value

date.ceilMillisecond(precision?: float) → Date

Ceil the current instance millisecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMilliseconds

Changes the value

date.ceilMilliseconds(precision?: float) → Date

Ceil the current instance millisecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMinute

Changes the value

date.ceilMinute(precision?: float) → Date

Ceil the current instance minute with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMinutes

Changes the value

date.ceilMinutes(precision?: float) → Date

Ceil the current instance minute with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMonth

Changes the value

date.ceilMonth(precision?: float) → Date

Ceil the current instance month with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilMonths

Changes the value

date.ceilMonths(precision?: float) → Date

Ceil the current instance month with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilQuarter

Changes the value

date.ceilQuarter(precision?: float) → Date

Ceil the current instance quarter with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilQuarters

Changes the value

date.ceilQuarters(precision?: float) → Date

Ceil the current instance quarter with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilSecond

Changes the value

date.ceilSecond(precision?: float) → Date

Ceil the current instance second with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilSeconds

Changes the value

date.ceilSeconds(precision?: float) → Date

Ceil the current instance second with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilUnit

Changes the value

date.ceilUnit(unit: string, precision?: DateInterval = 1) → Date

Ceil the current instance at the given unit with given precision if specified. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilWeek

Changes the value

date.ceilWeek(weekStartsAt?: WeekDay) → Date

Ceil the current instance week. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilYear

Changes the value

date.ceilYear(precision?: float) → Date

Ceil the current instance year with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

ceilYears

Changes the value

date.ceilYears(precision?: float) → Date

Ceil the current instance year with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

centuriesInMillennium

date.centuriesInMillennium() → int

Return the number of centuries contained in the current millennium

centuriesUntil

date.centuriesUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each century or every X centuries if a factor is given.

centuryOfMillennium

date.centuryOfMillennium(century?: ?int) → int|static

Return the value of the century starting from the beginning of the current millennium when called with no parameters, change the current century when called with an integer value

change

date.change(modifier: string) → Date

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

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

cleanupDumpProperties

date.cleanupDumpProperties() → Date

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)

clone

date.clone() → Date

No description yet.

closest

date.closest(date1: mixed, date2: Date) → Date

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

copy

date.copy() → Date

Get a copy of the instance.

day

Changes the value

date.day(value: int) → Date

Set current instance day to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

dayOfCentury

date.dayOfCentury(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current century when called with no parameters, change the current day when called with an integer value

dayOfDecade

date.dayOfDecade(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current decade when called with no parameters, change the current day when called with an integer value

dayOfMillennium

date.dayOfMillennium(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current millennium when called with no parameters, change the current day when called with an integer value

dayOfMonth

date.dayOfMonth(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current month when called with no parameters, change the current day when called with an integer value

dayOfQuarter

date.dayOfQuarter(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current quarter when called with no parameters, change the current day when called with an integer value

dayOfWeek

date.dayOfWeek(day?: ?int) → int|static

Return the value of the day starting from the beginning of the current week when called with no parameters, change the current day when called with an integer value

dayOfYear

date.dayOfYear(value?: int) → Date

Get/set the day of year.

days

date.days(value: int) → Date

Set current instance day to the given value.

daysInCentury

date.daysInCentury() → int

Return the number of days contained in the current century

daysInDecade

date.daysInDecade() → int

Return the number of days contained in the current decade

daysInMillennium

date.daysInMillennium() → int

Return the number of days contained in the current millennium

daysInMonth

date.daysInMonth() → int

Return the number of days contained in the current month

daysInQuarter

date.daysInQuarter() → int

Return the number of days contained in the current quarter

daysInWeek

date.daysInWeek() → int

Return the number of days contained in the current week

daysInYear

date.daysInYear() → int

Return the number of days contained in the current year

daysUntil

date.daysUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each day or every X days if a factor is given.

decadeOfCentury

date.decadeOfCentury(decade?: ?int) → int|static

Return the value of the decade starting from the beginning of the current century when called with no parameters, change the current decade when called with an integer value

decadeOfMillennium

date.decadeOfMillennium(decade?: ?int) → int|static

Return the value of the decade starting from the beginning of the current millennium when called with no parameters, change the current decade when called with an integer value

decadesInCentury

date.decadesInCentury() → int

Return the number of decades contained in the current century

decadesInMillennium

date.decadesInMillennium() → int

Return the number of decades contained in the current millennium

decadesUntil

date.decadesUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each decade or every X decades if a factor is given.

diff

date.diff(date?: mixed, absolute?: bool = false, skip?: array = []) → CarbonInterval

No description yet.

diffAsCarbonInterval

date.diffAsCarbonInterval(date?: mixed, absolute?: bool = false, skip?: array = []) → CarbonInterval

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).

diffAsDateInterval

date.diffAsDateInterval(date?: mixed, absolute?: bool = false) → DateInterval

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).

diffFiltered

date.diffFiltered(ci: CarbonInterval, callback: Block, date?: mixed, absolute?: bool = false) → int

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

diffForHumans

date.diffForHumans(other?: mixed, syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

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).

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”;

diffInDays

date.diffInDays(date?: mixed, absolute?: bool = false, utc?: bool = false) → float

Get the difference in days.

diffInDaysFiltered

date.diffInDaysFiltered(callback: Block, date?: mixed, absolute?: bool = false) → int

Get the difference in days using a filter closure.

diffInHours

date.diffInHours(date?: mixed, absolute?: bool = false) → float

Get the difference in hours.

diffInHoursFiltered

date.diffInHoursFiltered(callback: Block, date?: mixed, absolute?: bool = false) → int

Get the difference in hours using a filter closure.

diffInMicroseconds

date.diffInMicroseconds(date?: mixed, absolute?: bool = false) → float

Get the difference in microseconds.

diffInMilliseconds

date.diffInMilliseconds(date?: mixed, absolute?: bool = false) → float

Get the difference in milliseconds.

diffInMinutes

date.diffInMinutes(date?: mixed, absolute?: bool = false) → float

Get the difference in minutes.

diffInMonths

date.diffInMonths(date?: mixed, absolute?: bool = false, utc?: bool = false) → float

Get the difference in months.

diffInQuarters

date.diffInQuarters(date?: mixed, absolute?: bool = false, utc?: bool = false) → float

Get the difference in quarters.

diffInSeconds

date.diffInSeconds(date?: mixed, absolute?: bool = false) → float

Get the difference in seconds.

diffInUTCCenturies

date.diffInUTCCenturies(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of centuries.

diffInUTCDays

date.diffInUTCDays(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of days.

diffInUTCDecades

date.diffInUTCDecades(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of decades.

diffInUTCHours

date.diffInUTCHours(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of hours.

diffInUTCMicros

date.diffInUTCMicros(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of microseconds.

diffInUTCMicroseconds

date.diffInUTCMicroseconds(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of microseconds.

diffInUTCMillennia

date.diffInUTCMillennia(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of millennia.

diffInUTCMillis

date.diffInUTCMillis(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of milliseconds.

diffInUTCMilliseconds

date.diffInUTCMilliseconds(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of milliseconds.

diffInUTCMinutes

date.diffInUTCMinutes(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of minutes.

diffInUTCMonths

date.diffInUTCMonths(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of months.

diffInUTCQuarters

date.diffInUTCQuarters(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of quarters.

diffInUTCSeconds

date.diffInUTCSeconds(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of seconds.

diffInUTCWeeks

date.diffInUTCWeeks(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of weeks.

diffInUTCYears

date.diffInUTCYears(date: DateTimeInterface|string|null, absolute?: bool) → float

Convert current and given date in UTC timezone and return a floating number of years.

diffInUnit

date.diffInUnit(unit: Unit, date?: mixed, absolute?: bool = false, utc?: bool = false) → float

No description yet.

diffInWeekdays

date.diffInWeekdays(date?: mixed, absolute?: bool = false) → int

Get the difference in weekdays.

diffInWeekendDays

date.diffInWeekendDays(date?: mixed, absolute?: bool = false) → int

Get the difference in weekend days using a filter.

diffInWeeks

date.diffInWeeks(date?: mixed, absolute?: bool = false, utc?: bool = false) → float

Get the difference in weeks.

diffInYears

date.diffInYears(date?: mixed, absolute?: bool = false, utc?: bool = false) → float

Get the difference in years

endOf

Changes the value

date.endOf(unit: Unit, params?: mixed) → Date

Modify to end of current given unit. Changes this date in place and returns it. Use date.copy() first to keep the original.

echo Carbon::parse(‘2018-07-25 12:45:16.334455’) ->startOf(Unit::Month) ->endOf(Unit::Week, Carbon::FRIDAY);

endOfCentury

Changes the value

date.endOfCentury() → Date

Resets the date to end of the century and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfDay

Changes the value

date.endOfDay() → Date

Resets the time to 23:59:59.999999 end of day Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfDecade

Changes the value

date.endOfDecade() → Date

Resets the date to end of the decade and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfHour

Changes the value

date.endOfHour() → Date

Modify to end of current hour, minutes and seconds become 59 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfMillennium

Changes the value

date.endOfMillennium() → Date

Resets the date to end of the millennium and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfMillisecond

Changes the value

date.endOfMillisecond() → Date

Modify to end of current millisecond, microseconds such as 12345 become 123999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfMinute

Changes the value

date.endOfMinute() → Date

Modify to end of current minute, seconds become 59 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfMonth

Changes the value

date.endOfMonth() → Date

Resets the date to end of the month and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfQuarter

Changes the value

date.endOfQuarter() → Date

Resets the date to end of the quarter and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfSecond

Changes the value

date.endOfSecond() → Date

Modify to end of current second, microseconds become 999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

endOfWeek

Changes the value

date.endOfWeek(weekEndsAt?: WeekDay) → Date

Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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”;

endOfYear

Changes the value

date.endOfYear() → Date

Resets the date to end of the year and time to 23:59:59.999999 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

eq

date.eq(date: DateTimeInterface) → bool

Determines if the instance is equal to another

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

equalTo

date.equalTo(date: DateTimeInterface) → bool

Determines if the instance is equal to another

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

farthest

date.farthest(date1: mixed, date2: Date) → Date

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

firstOfMonth

date.firstOfMonth(dayOfWeek?: int) → Date

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.

firstOfQuarter

date.firstOfQuarter(dayOfWeek?: int) → Date

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.

firstOfYear

date.firstOfYear(dayOfWeek?: int) → Date

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.

floor

Changes the value

date.floor(precision?: DateInterval = 1) → Date

Round the current instance second with given precision if specified. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorCenturies

Changes the value

date.floorCenturies(precision?: float) → Date

Truncate the current instance century with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorCentury

Changes the value

date.floorCentury(precision?: float) → Date

Truncate the current instance century with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorDay

Changes the value

date.floorDay(precision?: float) → Date

Truncate the current instance day with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorDays

Changes the value

date.floorDays(precision?: float) → Date

Truncate the current instance day with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorDecade

Changes the value

date.floorDecade(precision?: float) → Date

Truncate the current instance decade with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorDecades

Changes the value

date.floorDecades(precision?: float) → Date

Truncate the current instance decade with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorHour

Changes the value

date.floorHour(precision?: float) → Date

Truncate the current instance hour with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorHours

Changes the value

date.floorHours(precision?: float) → Date

Truncate the current instance hour with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMicrosecond

Changes the value

date.floorMicrosecond(precision?: float) → Date

Truncate the current instance microsecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMicroseconds

Changes the value

date.floorMicroseconds(precision?: float) → Date

Truncate the current instance microsecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMillennia

Changes the value

date.floorMillennia(precision?: float) → Date

Truncate the current instance millennium with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMillennium

Changes the value

date.floorMillennium(precision?: float) → Date

Truncate the current instance millennium with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMillisecond

Changes the value

date.floorMillisecond(precision?: float) → Date

Truncate the current instance millisecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMilliseconds

Changes the value

date.floorMilliseconds(precision?: float) → Date

Truncate the current instance millisecond with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMinute

Changes the value

date.floorMinute(precision?: float) → Date

Truncate the current instance minute with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMinutes

Changes the value

date.floorMinutes(precision?: float) → Date

Truncate the current instance minute with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMonth

Changes the value

date.floorMonth(precision?: float) → Date

Truncate the current instance month with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorMonths

Changes the value

date.floorMonths(precision?: float) → Date

Truncate the current instance month with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorQuarter

Changes the value

date.floorQuarter(precision?: float) → Date

Truncate the current instance quarter with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorQuarters

Changes the value

date.floorQuarters(precision?: float) → Date

Truncate the current instance quarter with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorSecond

Changes the value

date.floorSecond(precision?: float) → Date

Truncate the current instance second with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorSeconds

Changes the value

date.floorSeconds(precision?: float) → Date

Truncate the current instance second with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorUnit

Changes the value

date.floorUnit(unit: string, precision?: DateInterval = 1) → Date

Truncate the current instance at the given unit with given precision if specified. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorWeek

Changes the value

date.floorWeek(weekStartsAt?: WeekDay) → Date

Truncate the current instance week. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorYear

Changes the value

date.floorYear(precision?: float) → Date

Truncate the current instance year with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

floorYears

Changes the value

date.floorYears(precision?: float) → Date

Truncate the current instance year with given precision. Changes this date in place and returns it. Use date.copy() first to keep the original.

format

date.format(format: string) → string

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

from

date.from(other?: mixed, syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

No description yet.

fromNow

date.fromNow(syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

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

get

date.get(name: Unit) → string|int|bool|DateTimeZone

Get a part of the Carbon object.

getAltNumber

date.getAltNumber(key: string) → string

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

getCalendarFormats

date.getCalendarFormats(locale?: string) → array

Returns list of calendar formats for ISO formatting.

getClock

date.getClock() → WrapperClock

No description yet.

getDaysFromStartOfWeek

date.getDaysFromStartOfWeek(weekStartsAt?: WeekDay) → int

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

getIsoFormats

date.getIsoFormats(locale?: string) → array

Returns list of locale formats for ISO formatting.

getMicrosecond

date.getMicrosecond() → int

No description yet.

getOffset

date.getOffset()

No description yet.

getOffsetString

date.getOffsetString(separator?: string = ":") → string

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”.

getPaddedUnit

date.getPaddedUnit(unit: mixed, length?: mixed = 2, padString?: mixed = "0", padType?: int = 0) → string

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

getPreciseTimestamp

date.getPreciseTimestamp(precision?: int = 6) → float

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

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)

getSettings

date.getSettings() → array

Returns current local settings.

getTimestamp

date.getTimestamp()

No description yet.

getTimestampMs

date.getTimestampMs() → int

Returns the timestamp with millisecond precision.

getTimezone

date.getTimezone() → CarbonTimeZone

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

getTranslatedDayName

date.getTranslatedDayName(context?: string, keySuffix?: string = "", defaultValue?: string) → string

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

getTranslatedMinDayName

date.getTranslatedMinDayName(context?: string) → string

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

getTranslatedMonthName

date.getTranslatedMonthName(context?: string, keySuffix?: string = "", defaultValue?: string) → string

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

getTranslatedShortDayName

date.getTranslatedShortDayName(context?: string) → string

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

getTranslatedShortMonthName

date.getTranslatedShortMonthName(context?: string) → string

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

getTranslationMessage

date.getTranslationMessage(key: string, locale?: string, default?: string, translator?: TranslatorInterface) → string

Returns raw translation message for a given key.

greaterThan

date.greaterThan(date: DateTimeInterface) → bool

Determines if the instance is greater (after) than another

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

greaterThanOrEqualTo

date.greaterThanOrEqualTo(date: DateTimeInterface) → bool

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

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

gt

date.gt(date: DateTimeInterface) → bool

Determines if the instance is greater (after) than another

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

gte

date.gte(date: DateTimeInterface) → bool

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

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

hasLocalMacro

date.hasLocalMacro(name: string) → bool

Checks if macro is registered globally or locally.

hasLocalTranslator

date.hasLocalTranslator() → bool

Return true if the current instance has its own translator.

hour

Changes the value

date.hour(value: int) → Date

Set current instance hour to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

hourOfCentury

date.hourOfCentury(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current century when called with no parameters, change the current hour when called with an integer value

hourOfDay

date.hourOfDay(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current day when called with no parameters, change the current hour when called with an integer value

hourOfDecade

date.hourOfDecade(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current decade when called with no parameters, change the current hour when called with an integer value

hourOfMillennium

date.hourOfMillennium(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current millennium when called with no parameters, change the current hour when called with an integer value

hourOfMonth

date.hourOfMonth(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current month when called with no parameters, change the current hour when called with an integer value

hourOfQuarter

date.hourOfQuarter(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current quarter when called with no parameters, change the current hour when called with an integer value

hourOfWeek

date.hourOfWeek(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current week when called with no parameters, change the current hour when called with an integer value

hourOfYear

date.hourOfYear(hour?: ?int) → int|static

Return the value of the hour starting from the beginning of the current year when called with no parameters, change the current hour when called with an integer value

hours

date.hours(value: int) → Date

Set current instance hour to the given value.

hoursInCentury

date.hoursInCentury() → int

Return the number of hours contained in the current century

hoursInDay

date.hoursInDay() → int

Return the number of hours contained in the current day

hoursInDecade

date.hoursInDecade() → int

Return the number of hours contained in the current decade

hoursInMillennium

date.hoursInMillennium() → int

Return the number of hours contained in the current millennium

hoursInMonth

date.hoursInMonth() → int

Return the number of hours contained in the current month

hoursInQuarter

date.hoursInQuarter() → int

Return the number of hours contained in the current quarter

hoursInWeek

date.hoursInWeek() → int

Return the number of hours contained in the current week

hoursInYear

date.hoursInYear() → int

Return the number of hours contained in the current year

hoursUntil

date.hoursUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each hour or every X hours if a factor is given.

is

date.is(tester: WeekDay) → bool

Returns true if the current date matches the given string.

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

isAfter

date.isAfter(date: DateTimeInterface) → bool

Determines if the instance is greater (after) than another

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

isBefore

date.isBefore(date: DateTimeInterface) → bool

Determines if the instance is less (before) than another

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

isBetween

date.isBetween(date1: DateTimeInterface, date2: DateTimeInterface, equal?: bool = true) → bool

Determines if the instance is between two others

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

isBirthday

date.isBirthday(date?: DateTimeInterface) → bool

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

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

isCurrentCentury

date.isCurrentCentury() → bool

Checks if the instance is in the same century as the current moment.

isCurrentDay

date.isCurrentDay() → bool

Checks if the instance is in the same day as the current moment.

isCurrentDecade

date.isCurrentDecade() → bool

Checks if the instance is in the same decade as the current moment.

isCurrentHour

date.isCurrentHour() → bool

Checks if the instance is in the same hour as the current moment.

isCurrentMicro

date.isCurrentMicro() → bool

Checks if the instance is in the same microsecond as the current moment.

isCurrentMicrosecond

date.isCurrentMicrosecond() → bool

Checks if the instance is in the same microsecond as the current moment.

isCurrentMillennium

date.isCurrentMillennium() → bool

Checks if the instance is in the same millennium as the current moment.

isCurrentMilli

date.isCurrentMilli() → bool

Checks if the instance is in the same millisecond as the current moment.

isCurrentMillisecond

date.isCurrentMillisecond() → bool

Checks if the instance is in the same millisecond as the current moment.

isCurrentMinute

date.isCurrentMinute() → bool

Checks if the instance is in the same minute as the current moment.

isCurrentMonth

date.isCurrentMonth() → bool

Checks if the instance is in the same month as the current moment.

isCurrentQuarter

date.isCurrentQuarter() → bool

Checks if the instance is in the same quarter as the current moment.

isCurrentSecond

date.isCurrentSecond() → bool

Checks if the instance is in the same second as the current moment.

isCurrentUnit

date.isCurrentUnit(unit: string) → bool

Determines if the instance is in the current unit given.

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

isCurrentWeek

date.isCurrentWeek() → bool

Checks if the instance is in the same week as the current moment.

isCurrentYear

date.isCurrentYear() → bool

Checks if the instance is in the same year as the current moment.

isDST

date.isDST() → bool

Check if the current instance is in a daylight saving time.

isDayOfWeek

date.isDayOfWeek(dayOfWeek: int) → bool

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

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

isEndOfCentury

date.isEndOfCentury(interval?: Unit) → bool

Determines if the instance is end of century (last day by default but interval can be customized).

isEndOfDay

date.isEndOfDay(checkMicroseconds?: Unit = false, interval?: Unit) → bool

Check if the instance is end of day.

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

isEndOfDecade

date.isEndOfDecade(interval?: Unit) → bool

Determines if the instance is end of decade (last day by default but interval can be customized).

isEndOfHour

date.isEndOfHour(interval?: Unit) → bool

Determines if the instance is end of hour (last microsecond by default but interval can be customized).

isEndOfMillennium

date.isEndOfMillennium(interval?: Unit) → bool

Determines if the instance is end of millennium (last day by default but interval can be customized).

isEndOfMillisecond

date.isEndOfMillisecond(interval?: Unit) → bool

Determines if the instance is end of millisecond (last microsecond by default but interval can be customized).

isEndOfMinute

date.isEndOfMinute(interval?: Unit) → bool

Determines if the instance is end of minute (last microsecond by default but interval can be customized).

isEndOfMonth

date.isEndOfMonth(interval?: Unit) → bool

Determines if the instance is end of month (last day by default but interval can be customized).

isEndOfQuarter

date.isEndOfQuarter(interval?: Unit) → bool

Determines if the instance is end of quarter (last day by default but interval can be customized).

isEndOfSecond

date.isEndOfSecond(interval?: Unit) → bool

Determines if the instance is end of second (last microsecond by default but interval can be customized).

isEndOfTime

date.isEndOfTime() → bool

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

isEndOfUnit

date.isEndOfUnit(unit: Unit, interval?: Unit, params?: mixed) → bool

Check if the instance is end of a given unit (tolerating a given interval).

// Check if a date-time is the last 15 minutes of the hour it’s in Carbon::parse(‘2019-02-28 20:13:00’)->isEndOfUnit(Unit::Hour, ‘15 minutes’); // false

isEndOfWeek

date.isEndOfWeek(interval?: Unit, weekEndsAt?: WeekDay) → bool

Determines if the instance is end of week (last day by default but interval can be customized).

Carbon::parse(‘2024-08-31’)->endOfWeek()->isEndOfWeek(); // true Carbon::parse(‘2024-08-31’)->isEndOfWeek(); // false

isEndOfYear

date.isEndOfYear(interval?: Unit) → bool

Determines if the instance is end of year (last day by default but interval can be customized).

isFriday

date.isFriday() → bool

Checks if the instance day is friday.

isFuture

date.isFuture() → bool

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

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

isLastCentury

date.isLastCentury() → bool

Checks if the instance is in the same century as the current moment last century.

isLastDay

date.isLastDay() → bool

Checks if the instance is in the same day as the current moment last day.

isLastDecade

date.isLastDecade() → bool

Checks if the instance is in the same decade as the current moment last decade.

isLastHour

date.isLastHour() → bool

Checks if the instance is in the same hour as the current moment last hour.

isLastMicro

date.isLastMicro() → bool

Checks if the instance is in the same microsecond as the current moment last microsecond.

isLastMicrosecond

date.isLastMicrosecond() → bool

Checks if the instance is in the same microsecond as the current moment last microsecond.

isLastMillennium

date.isLastMillennium() → bool

Checks if the instance is in the same millennium as the current moment last millennium.

isLastMilli

date.isLastMilli() → bool

Checks if the instance is in the same millisecond as the current moment last millisecond.

isLastMillisecond

date.isLastMillisecond() → bool

Checks if the instance is in the same millisecond as the current moment last millisecond.

isLastMinute

date.isLastMinute() → bool

Checks if the instance is in the same minute as the current moment last minute.

isLastMonth

date.isLastMonth() → bool

Checks if the instance is in the same month as the current moment last month.

isLastOfMonth

date.isLastOfMonth() → bool

Check if today is the last day of the Month

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

isLastQuarter

date.isLastQuarter() → bool

Checks if the instance is in the same quarter as the current moment last quarter.

isLastSecond

date.isLastSecond() → bool

Checks if the instance is in the same second as the current moment last second.

isLastWeek

date.isLastWeek() → bool

Checks if the instance is in the same week as the current moment last week.

isLastYear

date.isLastYear() → bool

Checks if the instance is in the same year as the current moment last year.

isLeapYear

date.isLeapYear() → bool

Determines if the instance is a leap year.

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

isLocal

date.isLocal() → bool

Check if the current instance has non-UTC timezone.

isLongIsoYear

date.isLongIsoYear() → bool

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

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

isLongYear

date.isLongYear() → bool

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.

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

isMidday

date.isMidday() → bool

Check if the instance is midday.

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

isMidnight

date.isMidnight() → bool

Check if the instance is start of day / midnight.

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

isMonday

date.isMonday() → bool

Checks if the instance day is monday.

isNextCentury

date.isNextCentury() → bool

Checks if the instance is in the same century as the current moment next century.

isNextDay

date.isNextDay() → bool

Checks if the instance is in the same day as the current moment next day.

isNextDecade

date.isNextDecade() → bool

Checks if the instance is in the same decade as the current moment next decade.

isNextHour

date.isNextHour() → bool

Checks if the instance is in the same hour as the current moment next hour.

isNextMicro

date.isNextMicro() → bool

Checks if the instance is in the same microsecond as the current moment next microsecond.

isNextMicrosecond

date.isNextMicrosecond() → bool

Checks if the instance is in the same microsecond as the current moment next microsecond.

isNextMillennium

date.isNextMillennium() → bool

Checks if the instance is in the same millennium as the current moment next millennium.

isNextMilli

date.isNextMilli() → bool

Checks if the instance is in the same millisecond as the current moment next millisecond.

isNextMillisecond

date.isNextMillisecond() → bool

Checks if the instance is in the same millisecond as the current moment next millisecond.

isNextMinute

date.isNextMinute() → bool

Checks if the instance is in the same minute as the current moment next minute.

isNextMonth

date.isNextMonth() → bool

Checks if the instance is in the same month as the current moment next month.

isNextQuarter

date.isNextQuarter() → bool

Checks if the instance is in the same quarter as the current moment next quarter.

isNextSecond

date.isNextSecond() → bool

Checks if the instance is in the same second as the current moment next second.

isNextWeek

date.isNextWeek() → bool

Checks if the instance is in the same week as the current moment next week.

isNextYear

date.isNextYear() → bool

Checks if the instance is in the same year as the current moment next year.

isNowOrFuture

date.isNowOrFuture() → bool

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

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

isNowOrPast

date.isNowOrPast() → bool

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

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

isPast

date.isPast() → bool

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

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

isSameAs

date.isSameAs(format: string, date: DateTimeInterface) → bool

Compares the formatted values of the two dates.

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

isSameCentury

date.isSameCentury(date: DateTimeInterface|string) → bool

Checks if the given date is in the same century as the instance. If null passed, compare to now (with the same timezone).

isSameDay

date.isSameDay(date: DateTimeInterface|string) → bool

Checks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).

isSameDecade

date.isSameDecade(date: DateTimeInterface|string) → bool

Checks if the given date is in the same decade as the instance. If null passed, compare to now (with the same timezone).

isSameHour

date.isSameHour(date: DateTimeInterface|string) → bool

Checks if the given date is in the same hour as the instance. If null passed, compare to now (with the same timezone).

isSameMicro

date.isSameMicro(date: DateTimeInterface|string) → bool

Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).

isSameMicrosecond

date.isSameMicrosecond(date: DateTimeInterface|string) → bool

Checks if the given date is in the same microsecond as the instance. If null passed, compare to now (with the same timezone).

isSameMillennium

date.isSameMillennium(date: DateTimeInterface|string) → bool

Checks if the given date is in the same millennium as the instance. If null passed, compare to now (with the same timezone).

isSameMilli

date.isSameMilli(date: DateTimeInterface|string) → bool

Checks if the given date is in the same millisecond as the instance. If null passed, compare to now (with the same timezone).

isSameMillisecond

date.isSameMillisecond(date: DateTimeInterface|string) → bool

Checks if the given date is in the same millisecond as the instance. If null passed, compare to now (with the same timezone).

isSameMinute

date.isSameMinute(date: DateTimeInterface|string) → bool

Checks if the given date is in the same minute as the instance. If null passed, compare to now (with the same timezone).

isSameMonth

date.isSameMonth(date: DateTimeInterface, ofSameYear?: bool = true) → bool

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

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

isSameQuarter

date.isSameQuarter(date: DateTimeInterface, ofSameYear?: bool = true) → bool

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

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

isSameSecond

date.isSameSecond(date: DateTimeInterface|string) → bool

Checks if the given date is in the same second as the instance. If null passed, compare to now (with the same timezone).

isSameUnit

date.isSameUnit(unit: string, date: DateTimeInterface) → bool

Determines if the instance is in the current unit given.

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

isSameWeek

date.isSameWeek(date: DateTimeInterface|string) → bool

Checks if the given date is in the same week as the instance. If null passed, compare to now (with the same timezone).

isSameYear

date.isSameYear(date: DateTimeInterface|string) → bool

Checks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).

isSaturday

date.isSaturday() → bool

Checks if the instance day is saturday.

isStartOfCentury

date.isStartOfCentury(interval?: Unit) → bool

Determines if the instance is start of century (first day by default but interval can be customized).

isStartOfDay

date.isStartOfDay(checkMicroseconds?: Unit = false, interval?: Unit) → bool

Check if the instance is start of day / midnight.

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

isStartOfDecade

date.isStartOfDecade(interval?: Unit) → bool

Determines if the instance is start of decade (first day by default but interval can be customized).

isStartOfHour

date.isStartOfHour(interval?: Unit) → bool

Determines if the instance is start of hour (first microsecond by default but interval can be customized).

isStartOfMillennium

date.isStartOfMillennium(interval?: Unit) → bool

Determines if the instance is start of millennium (first day by default but interval can be customized).

isStartOfMillisecond

date.isStartOfMillisecond(interval?: Unit) → bool

Determines if the instance is start of millisecond (first microsecond by default but interval can be customized).

isStartOfMinute

date.isStartOfMinute(interval?: Unit) → bool

Determines if the instance is start of minute (first microsecond by default but interval can be customized).

isStartOfMonth

date.isStartOfMonth(interval?: Unit) → bool

Determines if the instance is start of month (first day by default but interval can be customized).

isStartOfQuarter

date.isStartOfQuarter(interval?: Unit) → bool

Determines if the instance is start of quarter (first day by default but interval can be customized).

isStartOfSecond

date.isStartOfSecond(interval?: Unit) → bool

Determines if the instance is start of second (first microsecond by default but interval can be customized).

isStartOfTime

date.isStartOfTime() → bool

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

isStartOfUnit

date.isStartOfUnit(unit: Unit, interval?: Unit, params?: mixed) → bool

Check if the instance is start of a given unit (tolerating a given interval).

// Check if a date-time is the first 15 minutes of the hour it’s in Carbon::parse(‘2019-02-28 20:13:00’)->isStartOfUnit(Unit::Hour, ‘15 minutes’); // true

isStartOfWeek

date.isStartOfWeek(interval?: Unit, weekStartsAt?: WeekDay) → bool

Determines if the instance is start of week (first day by default but interval can be customized).

Carbon::parse(‘2024-08-31’)->startOfWeek()->isStartOfWeek(); // true Carbon::parse(‘2024-08-31’)->isStartOfWeek(); // false

isStartOfYear

date.isStartOfYear(interval?: Unit) → bool

Determines if the instance is start of year (first day by default but interval can be customized).

isSunday

date.isSunday() → bool

Checks if the instance day is sunday.

isThursday

date.isThursday() → bool

Checks if the instance day is thursday.

isToday

date.isToday() → bool

Determines if the instance is today.

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

isTomorrow

date.isTomorrow() → bool

Determines if the instance is tomorrow.

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

isTuesday

date.isTuesday() → bool

Checks if the instance day is tuesday.

isUtc

date.isUtc() → bool

Check if the current instance has UTC timezone. (Both isUtc and isUTC cases are valid.)

isValid

date.isValid() → bool

Check if the current instance is a valid date.

isWednesday

date.isWednesday() → bool

Checks if the instance day is wednesday.

isWeekday

date.isWeekday() → bool

Determines if the instance is a weekday.

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

isWeekend

date.isWeekend() → bool

Determines if the instance is a weekend day.

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

isYesterday

date.isYesterday() → bool

Determines if the instance is yesterday.

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

isoFormat

date.isoFormat(format: string, originalFormat?: string) → string

Format in the current language using ISO replacement patterns.

isoWeek

date.isoWeek(week?: mixed, dayOfWeek?: mixed, dayOfYear?: int) → Date

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.

isoWeekYear

date.isoWeekYear(year?: mixed, dayOfWeek?: mixed, dayOfYear?: int) → Date

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.

isoWeekday

date.isoWeekday(value?: WeekDay) → Date

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

isoWeeksInYear

date.isoWeeksInYear(dayOfWeek?: mixed, dayOfYear?: int) → int

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.

lastOfMonth

date.lastOfMonth(dayOfWeek?: int) → Date

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.

lastOfQuarter

date.lastOfQuarter(dayOfWeek?: int) → Date

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.

lastOfYear

date.lastOfYear(dayOfWeek?: int) → Date

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.

lessThan

date.lessThan(date: DateTimeInterface) → bool

Determines if the instance is less (before) than another

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

lessThanOrEqualTo

date.lessThanOrEqualTo(date: DateTimeInterface) → bool

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

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

locale

date.locale(locale?: string, fallbackLocales?: string) → Date

Get/set the locale for the current instance.

longAbsoluteDiffForHumans

date.longAbsoluteDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (long format, ‘Absolute’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

longRelativeDiffForHumans

date.longRelativeDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (long format, ‘Relative’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

longRelativeToNowDiffForHumans

date.longRelativeToNowDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (long format, ‘RelativeToNow’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

longRelativeToOtherDiffForHumans

date.longRelativeToOtherDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (long format, ‘RelativeToOther’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

lt

date.lt(date: DateTimeInterface) → bool

Determines if the instance is less (before) than another

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

lte

date.lte(date: DateTimeInterface) → bool

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

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

max

date.max(date?: Date) → Date

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

maximum

date.maximum(date?: Date) → Date

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

meridiem

date.meridiem(isLower?: bool = false) → string

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

micro

date.micro(value: int) → Date

Set current instance microsecond to the given value.

micros

date.micros(value: int) → Date

Set current instance microsecond to the given value.

microsUntil

date.microsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.

microsecond

Changes the value

date.microsecond(value: int) → Date

Set current instance microsecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

microsecondOfCentury

date.microsecondOfCentury(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current century when called with no parameters, change the current microsecond when called with an integer value

microsecondOfDay

date.microsecondOfDay(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current day when called with no parameters, change the current microsecond when called with an integer value

microsecondOfDecade

date.microsecondOfDecade(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current decade when called with no parameters, change the current microsecond when called with an integer value

microsecondOfHour

date.microsecondOfHour(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current hour when called with no parameters, change the current microsecond when called with an integer value

microsecondOfMillennium

date.microsecondOfMillennium(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current millennium when called with no parameters, change the current microsecond when called with an integer value

microsecondOfMillisecond

date.microsecondOfMillisecond(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current millisecond when called with no parameters, change the current microsecond when called with an integer value

microsecondOfMinute

date.microsecondOfMinute(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current minute when called with no parameters, change the current microsecond when called with an integer value

microsecondOfMonth

date.microsecondOfMonth(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current month when called with no parameters, change the current microsecond when called with an integer value

microsecondOfQuarter

date.microsecondOfQuarter(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current quarter when called with no parameters, change the current microsecond when called with an integer value

microsecondOfSecond

date.microsecondOfSecond(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current second when called with no parameters, change the current microsecond when called with an integer value

microsecondOfWeek

date.microsecondOfWeek(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current week when called with no parameters, change the current microsecond when called with an integer value

microsecondOfYear

date.microsecondOfYear(microsecond?: ?int) → int|static

Return the value of the microsecond starting from the beginning of the current year when called with no parameters, change the current microsecond when called with an integer value

microseconds

date.microseconds(value: int) → Date

Set current instance microsecond to the given value.

microsecondsInCentury

date.microsecondsInCentury() → int

Return the number of microseconds contained in the current century

microsecondsInDay

date.microsecondsInDay() → int

Return the number of microseconds contained in the current day

microsecondsInDecade

date.microsecondsInDecade() → int

Return the number of microseconds contained in the current decade

microsecondsInHour

date.microsecondsInHour() → int

Return the number of microseconds contained in the current hour

microsecondsInMillennium

date.microsecondsInMillennium() → int

Return the number of microseconds contained in the current millennium

microsecondsInMillisecond

date.microsecondsInMillisecond() → int

Return the number of microseconds contained in the current millisecond

microsecondsInMinute

date.microsecondsInMinute() → int

Return the number of microseconds contained in the current minute

microsecondsInMonth

date.microsecondsInMonth() → int

Return the number of microseconds contained in the current month

microsecondsInQuarter

date.microsecondsInQuarter() → int

Return the number of microseconds contained in the current quarter

microsecondsInSecond

date.microsecondsInSecond() → int

Return the number of microseconds contained in the current second

microsecondsInWeek

date.microsecondsInWeek() → int

Return the number of microseconds contained in the current week

microsecondsInYear

date.microsecondsInYear() → int

Return the number of microseconds contained in the current year

microsecondsUntil

date.microsecondsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each microsecond or every X microseconds if a factor is given.

midDay

date.midDay() → Date

Modify to midday, default to self::$midDayAt

millenniaUntil

date.millenniaUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millennium or every X millennia if a factor is given.

milli

date.milli(value: int) → Date

Set current instance millisecond to the given value.

millis

date.millis(value: int) → Date

Set current instance millisecond to the given value.

millisUntil

date.millisUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.

millisecond

Changes the value

date.millisecond(value: int) → Date

Set current instance millisecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

millisecondOfCentury

date.millisecondOfCentury(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current century when called with no parameters, change the current millisecond when called with an integer value

millisecondOfDay

date.millisecondOfDay(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current day when called with no parameters, change the current millisecond when called with an integer value

millisecondOfDecade

date.millisecondOfDecade(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current decade when called with no parameters, change the current millisecond when called with an integer value

millisecondOfHour

date.millisecondOfHour(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current hour when called with no parameters, change the current millisecond when called with an integer value

millisecondOfMillennium

date.millisecondOfMillennium(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current millennium when called with no parameters, change the current millisecond when called with an integer value

millisecondOfMinute

date.millisecondOfMinute(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current minute when called with no parameters, change the current millisecond when called with an integer value

millisecondOfMonth

date.millisecondOfMonth(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current month when called with no parameters, change the current millisecond when called with an integer value

millisecondOfQuarter

date.millisecondOfQuarter(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current quarter when called with no parameters, change the current millisecond when called with an integer value

millisecondOfSecond

date.millisecondOfSecond(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current second when called with no parameters, change the current millisecond when called with an integer value

millisecondOfWeek

date.millisecondOfWeek(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current week when called with no parameters, change the current millisecond when called with an integer value

millisecondOfYear

date.millisecondOfYear(millisecond?: ?int) → int|static

Return the value of the millisecond starting from the beginning of the current year when called with no parameters, change the current millisecond when called with an integer value

milliseconds

date.milliseconds(value: int) → Date

Set current instance millisecond to the given value.

millisecondsInCentury

date.millisecondsInCentury() → int

Return the number of milliseconds contained in the current century

millisecondsInDay

date.millisecondsInDay() → int

Return the number of milliseconds contained in the current day

millisecondsInDecade

date.millisecondsInDecade() → int

Return the number of milliseconds contained in the current decade

millisecondsInHour

date.millisecondsInHour() → int

Return the number of milliseconds contained in the current hour

millisecondsInMillennium

date.millisecondsInMillennium() → int

Return the number of milliseconds contained in the current millennium

millisecondsInMinute

date.millisecondsInMinute() → int

Return the number of milliseconds contained in the current minute

millisecondsInMonth

date.millisecondsInMonth() → int

Return the number of milliseconds contained in the current month

millisecondsInQuarter

date.millisecondsInQuarter() → int

Return the number of milliseconds contained in the current quarter

millisecondsInSecond

date.millisecondsInSecond() → int

Return the number of milliseconds contained in the current second

millisecondsInWeek

date.millisecondsInWeek() → int

Return the number of milliseconds contained in the current week

millisecondsInYear

date.millisecondsInYear() → int

Return the number of milliseconds contained in the current year

millisecondsUntil

date.millisecondsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each millisecond or every X milliseconds if a factor is given.

min

date.min(date?: Date) → Date

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

minimum

date.minimum(date?: Date) → Date

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

minute

Changes the value

date.minute(value: int) → Date

Set current instance minute to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

minuteOfCentury

date.minuteOfCentury(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current century when called with no parameters, change the current minute when called with an integer value

minuteOfDay

date.minuteOfDay(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current day when called with no parameters, change the current minute when called with an integer value

minuteOfDecade

date.minuteOfDecade(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current decade when called with no parameters, change the current minute when called with an integer value

minuteOfHour

date.minuteOfHour(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current hour when called with no parameters, change the current minute when called with an integer value

minuteOfMillennium

date.minuteOfMillennium(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current millennium when called with no parameters, change the current minute when called with an integer value

minuteOfMonth

date.minuteOfMonth(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current month when called with no parameters, change the current minute when called with an integer value

minuteOfQuarter

date.minuteOfQuarter(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current quarter when called with no parameters, change the current minute when called with an integer value

minuteOfWeek

date.minuteOfWeek(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current week when called with no parameters, change the current minute when called with an integer value

minuteOfYear

date.minuteOfYear(minute?: ?int) → int|static

Return the value of the minute starting from the beginning of the current year when called with no parameters, change the current minute when called with an integer value

minutes

date.minutes(value: int) → Date

Set current instance minute to the given value.

minutesInCentury

date.minutesInCentury() → int

Return the number of minutes contained in the current century

minutesInDay

date.minutesInDay() → int

Return the number of minutes contained in the current day

minutesInDecade

date.minutesInDecade() → int

Return the number of minutes contained in the current decade

minutesInHour

date.minutesInHour() → int

Return the number of minutes contained in the current hour

minutesInMillennium

date.minutesInMillennium() → int

Return the number of minutes contained in the current millennium

minutesInMonth

date.minutesInMonth() → int

Return the number of minutes contained in the current month

minutesInQuarter

date.minutesInQuarter() → int

Return the number of minutes contained in the current quarter

minutesInWeek

date.minutesInWeek() → int

Return the number of minutes contained in the current week

minutesInYear

date.minutesInYear() → int

Return the number of minutes contained in the current year

minutesUntil

date.minutesUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each minute or every X minutes if a factor is given.

modify

Changes the value

date.modify(modify: mixed) → Date

Calls \DateTime::modify if mutable or \DateTimeImmutable::modify else. Changes this date in place and returns it. Use date.copy() first to keep the original.

month

Changes the value

date.month(value: Month|int) → Date

Set current instance month to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

monthOfCentury

date.monthOfCentury(month?: ?int) → int|static

Return the value of the month starting from the beginning of the current century when called with no parameters, change the current month when called with an integer value

monthOfDecade

date.monthOfDecade(month?: ?int) → int|static

Return the value of the month starting from the beginning of the current decade when called with no parameters, change the current month when called with an integer value

monthOfMillennium

date.monthOfMillennium(month?: ?int) → int|static

Return the value of the month starting from the beginning of the current millennium when called with no parameters, change the current month when called with an integer value

monthOfQuarter

date.monthOfQuarter(month?: ?int) → int|static

Return the value of the month starting from the beginning of the current quarter when called with no parameters, change the current month when called with an integer value

monthOfYear

date.monthOfYear(month?: ?int) → int|static

Return the value of the month starting from the beginning of the current year when called with no parameters, change the current month when called with an integer value

months

date.months(value: Month|int) → Date

Set current instance month to the given value.

monthsInCentury

date.monthsInCentury() → int

Return the number of months contained in the current century

monthsInDecade

date.monthsInDecade() → int

Return the number of months contained in the current decade

monthsInMillennium

date.monthsInMillennium() → int

Return the number of months contained in the current millennium

monthsInQuarter

date.monthsInQuarter() → int

Return the number of months contained in the current quarter

monthsInYear

date.monthsInYear() → int

Return the number of months contained in the current year

monthsUntil

date.monthsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each month or every X months if a factor is given.

ne

date.ne(date: DateTimeInterface) → bool

Determines if the instance is not equal to another

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

next

Changes the value

date.next(modifier?: string) → Date

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. Changes this date in place and returns it. Use date.copy() first to keep the original.

nextWeekday

Changes the value

date.nextWeekday() → Date

Go forward to the next weekday. Changes this date in place and returns it. Use date.copy() first to keep the original.

nextWeekendDay

Changes the value

date.nextWeekendDay() → Date

Go forward to the next weekend day. Changes this date in place and returns it. Use date.copy() first to keep the original.

notEqualTo

date.notEqualTo(date: DateTimeInterface) → bool

Determines if the instance is not equal to another

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

nowWithSameTz

date.nowWithSameTz() → Date

Returns a present instance in the same timezone.

nthOfMonth

date.nthOfMonth(nth: mixed, dayOfWeek: int)

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.

nthOfQuarter

date.nthOfQuarter(nth: mixed, dayOfWeek: int)

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.

nthOfYear

date.nthOfYear(nth: mixed, dayOfWeek: int)

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.

ordinal

date.ordinal(key: string, period?: string) → string

Return a property with its ordinal.

previous

Changes the value

date.previous(modifier?: string) → Date

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. Changes this date in place and returns it. Use date.copy() first to keep the original.

previousWeekday

Changes the value

date.previousWeekday() → Date

Go backward to the previous weekday. Changes this date in place and returns it. Use date.copy() first to keep the original.

previousWeekendDay

Changes the value

date.previousWeekendDay() → Date

Go backward to the previous weekend day. Changes this date in place and returns it. Use date.copy() first to keep the original.

quarterOfCentury

date.quarterOfCentury(quarter?: ?int) → int|static

Return the value of the quarter starting from the beginning of the current century when called with no parameters, change the current quarter when called with an integer value

quarterOfDecade

date.quarterOfDecade(quarter?: ?int) → int|static

Return the value of the quarter starting from the beginning of the current decade when called with no parameters, change the current quarter when called with an integer value

quarterOfMillennium

date.quarterOfMillennium(quarter?: ?int) → int|static

Return the value of the quarter starting from the beginning of the current millennium when called with no parameters, change the current quarter when called with an integer value

quarterOfYear

date.quarterOfYear(quarter?: ?int) → int|static

Return the value of the quarter starting from the beginning of the current year when called with no parameters, change the current quarter when called with an integer value

quartersInCentury

date.quartersInCentury() → int

Return the number of quarters contained in the current century

quartersInDecade

date.quartersInDecade() → int

Return the number of quarters contained in the current decade

quartersInMillennium

date.quartersInMillennium() → int

Return the number of quarters contained in the current millennium

quartersInYear

date.quartersInYear() → int

Return the number of quarters contained in the current year

quartersUntil

date.quartersUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each quarter or every X quarters if a factor is given.

range

date.range(end?: mixed, interval?: mixed, unit?: string) → CarbonPeriod

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

rawAdd

date.rawAdd(interval: DateInterval) → Date

Call native PHP DateTime/DateTimeImmutable add() method.

rawFormat

date.rawFormat(format: string) → string

No description yet.

rawSub

date.rawSub(interval: DateInterval) → Date

Call native PHP DateTime/DateTimeImmutable sub() method.

round

Changes the value

date.round(precision?: DateInterval = 1, function?: callable = "round") → Date

Round the current instance second with given precision if specified. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundCenturies

Changes the value

date.roundCenturies(precision?: float, function?: string) → Date

Round the current instance century with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundCentury

Changes the value

date.roundCentury(precision?: float, function?: string) → Date

Round the current instance century with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundDay

Changes the value

date.roundDay(precision?: float, function?: string) → Date

Round the current instance day with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundDays

Changes the value

date.roundDays(precision?: float, function?: string) → Date

Round the current instance day with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundDecade

Changes the value

date.roundDecade(precision?: float, function?: string) → Date

Round the current instance decade with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundDecades

Changes the value

date.roundDecades(precision?: float, function?: string) → Date

Round the current instance decade with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundHour

Changes the value

date.roundHour(precision?: float, function?: string) → Date

Round the current instance hour with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundHours

Changes the value

date.roundHours(precision?: float, function?: string) → Date

Round the current instance hour with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMicrosecond

Changes the value

date.roundMicrosecond(precision?: float, function?: string) → Date

Round the current instance microsecond with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMicroseconds

Changes the value

date.roundMicroseconds(precision?: float, function?: string) → Date

Round the current instance microsecond with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMillennia

Changes the value

date.roundMillennia(precision?: float, function?: string) → Date

Round the current instance millennium with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMillennium

Changes the value

date.roundMillennium(precision?: float, function?: string) → Date

Round the current instance millennium with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMillisecond

Changes the value

date.roundMillisecond(precision?: float, function?: string) → Date

Round the current instance millisecond with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMilliseconds

Changes the value

date.roundMilliseconds(precision?: float, function?: string) → Date

Round the current instance millisecond with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMinute

Changes the value

date.roundMinute(precision?: float, function?: string) → Date

Round the current instance minute with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMinutes

Changes the value

date.roundMinutes(precision?: float, function?: string) → Date

Round the current instance minute with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMonth

Changes the value

date.roundMonth(precision?: float, function?: string) → Date

Round the current instance month with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundMonths

Changes the value

date.roundMonths(precision?: float, function?: string) → Date

Round the current instance month with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundQuarter

Changes the value

date.roundQuarter(precision?: float, function?: string) → Date

Round the current instance quarter with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundQuarters

Changes the value

date.roundQuarters(precision?: float, function?: string) → Date

Round the current instance quarter with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundSecond

Changes the value

date.roundSecond(precision?: float, function?: string) → Date

Round the current instance second with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundSeconds

Changes the value

date.roundSeconds(precision?: float, function?: string) → Date

Round the current instance second with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundUnit

Changes the value

date.roundUnit(unit: string, precision?: DateInterval = 1, function?: callable = "round") → Date

Round the current instance at the given unit with given precision if specified and the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundWeek

Changes the value

date.roundWeek(weekStartsAt?: WeekDay) → Date

Round the current instance week. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundYear

Changes the value

date.roundYear(precision?: float, function?: string) → Date

Round the current instance year with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

roundYears

Changes the value

date.roundYears(precision?: float, function?: string) → Date

Round the current instance year with given precision using the given function. Changes this date in place and returns it. Use date.copy() first to keep the original.

second

Changes the value

date.second(value: int) → Date

Set current instance second to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

secondOfCentury

date.secondOfCentury(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current century when called with no parameters, change the current second when called with an integer value

secondOfDay

date.secondOfDay(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current day when called with no parameters, change the current second when called with an integer value

secondOfDecade

date.secondOfDecade(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current decade when called with no parameters, change the current second when called with an integer value

secondOfHour

date.secondOfHour(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current hour when called with no parameters, change the current second when called with an integer value

secondOfMillennium

date.secondOfMillennium(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current millennium when called with no parameters, change the current second when called with an integer value

secondOfMinute

date.secondOfMinute(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current minute when called with no parameters, change the current second when called with an integer value

secondOfMonth

date.secondOfMonth(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current month when called with no parameters, change the current second when called with an integer value

secondOfQuarter

date.secondOfQuarter(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current quarter when called with no parameters, change the current second when called with an integer value

secondOfWeek

date.secondOfWeek(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current week when called with no parameters, change the current second when called with an integer value

secondOfYear

date.secondOfYear(second?: ?int) → int|static

Return the value of the second starting from the beginning of the current year when called with no parameters, change the current second when called with an integer value

seconds

date.seconds(value: int) → Date

Set current instance second to the given value.

secondsInCentury

date.secondsInCentury() → int

Return the number of seconds contained in the current century

secondsInDay

date.secondsInDay() → int

Return the number of seconds contained in the current day

secondsInDecade

date.secondsInDecade() → int

Return the number of seconds contained in the current decade

secondsInHour

date.secondsInHour() → int

Return the number of seconds contained in the current hour

secondsInMillennium

date.secondsInMillennium() → int

Return the number of seconds contained in the current millennium

secondsInMinute

date.secondsInMinute() → int

Return the number of seconds contained in the current minute

secondsInMonth

date.secondsInMonth() → int

Return the number of seconds contained in the current month

secondsInQuarter

date.secondsInQuarter() → int

Return the number of seconds contained in the current quarter

secondsInWeek

date.secondsInWeek() → int

Return the number of seconds contained in the current week

secondsInYear

date.secondsInYear() → int

Return the number of seconds contained in the current year

secondsSinceMidnight

date.secondsSinceMidnight() → float

The number of seconds since midnight.

secondsUntil

date.secondsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each second or every X seconds if a factor is given.

secondsUntilEndOfDay

date.secondsUntilEndOfDay() → float

The number of seconds until 23:59:59.

serialize

date.serialize() → string

Return a serialized string of the instance.

set

Changes the value

date.set(name: Unit, value?: DateTimeZone) → Date

Set a part of the Carbon object. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDate

Changes the value

date.setDate(year: int, month: int, day: int) → Date

Set the date with gregorian year, month and day numbers. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDateFrom

Changes the value

date.setDateFrom(date: DateTimeInterface) → Date

Set the year, month, and date for this instance to that of the passed instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDateTime

Changes the value

date.setDateTime(year: int, month: int, day: int, hour: int, minute: int, second?: int = 0, microseconds?: int = 0) → Date

Set the date and time all together. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDateTimeFrom

Changes the value

date.setDateTimeFrom(date: DateTimeInterface) → Date

Set the date and time for this instance to that of the passed instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDay

Changes the value

date.setDay(value: int) → Date

Set current instance day to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDays

Changes the value

date.setDays(value: int) → Date

Set current instance day to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setDaysFromStartOfWeek

Changes the value

date.setDaysFromStartOfWeek(numberOfDays: int, weekStartsAt?: WeekDay) → Date

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. Changes this date in place and returns it. Use date.copy() first to keep the original.

setHour

Changes the value

date.setHour(value: int) → Date

Set current instance hour to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setHours

Changes the value

date.setHours(value: int) → Date

Set current instance hour to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setISODate

Changes the value

date.setISODate(year: int, week: int, day?: int = 1) → Date

Set a date according to the ISO 8601 standard - using weeks and day offsets rather than specific dates. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMicro

Changes the value

date.setMicro(value: int) → Date

Set current instance microsecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMicros

Changes the value

date.setMicros(value: int) → Date

Set current instance microsecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMicrosecond

Changes the value

date.setMicrosecond(microsecond: int) → Date

Changes this date in place and returns it. Use date.copy() first to keep the original.

setMicroseconds

Changes the value

date.setMicroseconds(value: int) → Date

Set current instance microsecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMilli

Changes the value

date.setMilli(value: int) → Date

Set current instance millisecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMillis

Changes the value

date.setMillis(value: int) → Date

Set current instance millisecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMillisecond

Changes the value

date.setMillisecond(value: int) → Date

Set current instance millisecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMilliseconds

Changes the value

date.setMilliseconds(value: int) → Date

Set current instance millisecond to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMinute

Changes the value

date.setMinute(value: int) → Date

Set current instance minute to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMinutes

Changes the value

date.setMinutes(value: int) → Date

Set current instance minute to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMonth

Changes the value

date.setMonth(value: Month|int) → Date

Set current instance month to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setMonths

Changes the value

date.setMonths(value: Month|int) → Date

Set current instance month to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setSecond

Changes the value

date.setSecond(value: int) → Date

Set current instance second to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setSeconds

Changes the value

date.setSeconds(value: int) → Date

Set current instance second to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setTime

Changes the value

date.setTime(hour: int, minute: int, second?: int = 0, microseconds?: int = 0) → Date

Resets the current time of the DateTime object to a different time. Changes this date in place and returns it. Use date.copy() first to keep the original.

setTimeFrom

Changes the value

date.setTimeFrom(date: DateTimeInterface) → Date

Set the hour, minute, second and microseconds for this instance to that of the passed instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

setTimeFromTimeString

Changes the value

date.setTimeFromTimeString(time: string) → Date

Set the time by time string. Changes this date in place and returns it. Use date.copy() first to keep the original.

setTimestamp

Changes the value

date.setTimestamp(timestamp: string) → Date

Set the instance’s timestamp.

Timestamp input can be given as int, float or a string containing one or more numbers. Changes this date in place and returns it. Use date.copy() first to keep the original.

setTimezone

Changes the value

date.setTimezone(timeZone: DateTimeZone) → Date

Set the instance’s timezone from a string or object. Changes this date in place and returns it. Use date.copy() first to keep the original.

setUnit

Changes the value

date.setUnit(unit: string, value?: Month) → Date

Set specified unit to new given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setUnitNoOverflow

Changes the value

date.setUnitNoOverflow(valueUnit: string, value: int, overflowUnit: string) → Date

Set any unit to a new value without overflowing current other unit given. Changes this date in place and returns it. Use date.copy() first to keep the original.

setYear

Changes the value

date.setYear(value: int) → Date

Set current instance year to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

setYears

Changes the value

date.setYears(value: int) → Date

Set current instance year to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

shiftTimezone

Changes the value

date.shiftTimezone(value: DateTimeZone) → Date

Set the instance’s timezone from a string or object and add/subtract the offset difference. Changes this date in place and returns it. Use date.copy() first to keep the original.

shortAbsoluteDiffForHumans

date.shortAbsoluteDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (short format, ‘Absolute’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

shortRelativeDiffForHumans

date.shortRelativeDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (short format, ‘Relative’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

shortRelativeToNowDiffForHumans

date.shortRelativeToNowDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (short format, ‘RelativeToNow’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

shortRelativeToOtherDiffForHumans

date.shortRelativeToOtherDiffForHumans(other?: DateTimeInterface, parts?: int) → string

Get the difference (short format, ‘RelativeToOther’ mode) in a human readable format in the current locale. ($other and $parts parameters can be swapped.)

since

date.since(other?: mixed, syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: mixed)

No description yet.

startOf

Changes the value

date.startOf(unit: Unit, params?: mixed) → Date

Modify to start of current given unit. Changes this date in place and returns it. Use date.copy() first to keep the original.

echo Carbon::parse(‘2018-07-25 12:45:16.334455’) ->startOf(Unit::Month) ->endOf(Unit::Week, Carbon::FRIDAY);

startOfCentury

Changes the value

date.startOfCentury() → Date

Resets the date to the first day of the century and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfDay

Changes the value

date.startOfDay() → Date

Resets the time to 00:00:00 start of day Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfDecade

Changes the value

date.startOfDecade() → Date

Resets the date to the first day of the decade and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfHour

Changes the value

date.startOfHour() → Date

Modify to start of current hour, minutes and seconds become 0 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfMillennium

Changes the value

date.startOfMillennium() → Date

Resets the date to the first day of the millennium and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfMillisecond

Changes the value

date.startOfMillisecond() → Date

Modify to start of current millisecond, microseconds such as 12345 become 123000 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfMinute

Changes the value

date.startOfMinute() → Date

Modify to start of current minute, seconds become 0 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfMonth

Changes the value

date.startOfMonth() → Date

Resets the date to the first day of the month and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfQuarter

Changes the value

date.startOfQuarter() → Date

Resets the date to the first day of the quarter and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfSecond

Changes the value

date.startOfSecond() → Date

Modify to start of current second, microseconds become 0 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

startOfWeek

Changes the value

date.startOfWeek(weekStartsAt?: WeekDay) → Date

Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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”;

startOfYear

Changes the value

date.startOfYear() → Date

Resets the date to the first day of the year and the time to 00:00:00 Changes this date in place and returns it. Use date.copy() first to keep the original.

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

sub

Changes the value

date.sub(unit: mixed, value?: mixed = 1, overflow?: bool) → Date

Subtract given units or interval to the current instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

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

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

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

subCenturies

Changes the value

date.subCenturies(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturiesNoOverflow

Changes the value

date.subCenturiesNoOverflow(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturiesWithNoOverflow

Changes the value

date.subCenturiesWithNoOverflow(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturiesWithOverflow

Changes the value

date.subCenturiesWithOverflow(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturiesWithoutOverflow

Changes the value

date.subCenturiesWithoutOverflow(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCentury

Changes the value

date.subCentury() → Date

Sub one century to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturyNoOverflow

Changes the value

date.subCenturyNoOverflow() → Date

Sub one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturyWithNoOverflow

Changes the value

date.subCenturyWithNoOverflow() → Date

Sub one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturyWithOverflow

Changes the value

date.subCenturyWithOverflow() → Date

Sub one century to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subCenturyWithoutOverflow

Changes the value

date.subCenturyWithoutOverflow() → Date

Sub one century to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDay

Changes the value

date.subDay() → Date

Sub one day to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subDays

Changes the value

date.subDays(value?: int|float) → Date

Sub days (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecade

Changes the value

date.subDecade() → Date

Sub one decade to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadeNoOverflow

Changes the value

date.subDecadeNoOverflow() → Date

Sub one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadeWithNoOverflow

Changes the value

date.subDecadeWithNoOverflow() → Date

Sub one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadeWithOverflow

Changes the value

date.subDecadeWithOverflow() → Date

Sub one decade to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadeWithoutOverflow

Changes the value

date.subDecadeWithoutOverflow() → Date

Sub one decade to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecades

Changes the value

date.subDecades(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadesNoOverflow

Changes the value

date.subDecadesNoOverflow(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadesWithNoOverflow

Changes the value

date.subDecadesWithNoOverflow(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadesWithOverflow

Changes the value

date.subDecadesWithOverflow(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subDecadesWithoutOverflow

Changes the value

date.subDecadesWithoutOverflow(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subHour

Changes the value

date.subHour() → Date

Sub one hour to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subHours

Changes the value

date.subHours(value?: int|float) → Date

Sub hours (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMicro

Changes the value

date.subMicro() → Date

Sub one microsecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMicros

Changes the value

date.subMicros(value?: int|float) → Date

Sub microseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMicrosecond

Changes the value

date.subMicrosecond() → Date

Sub one microsecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMicroseconds

Changes the value

date.subMicroseconds(value?: int|float) → Date

Sub microseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillennia

Changes the value

date.subMillennia(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniaNoOverflow

Changes the value

date.subMillenniaNoOverflow(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniaWithNoOverflow

Changes the value

date.subMillenniaWithNoOverflow(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniaWithOverflow

Changes the value

date.subMillenniaWithOverflow(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniaWithoutOverflow

Changes the value

date.subMillenniaWithoutOverflow(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillennium

Changes the value

date.subMillennium() → Date

Sub one millennium to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniumNoOverflow

Changes the value

date.subMillenniumNoOverflow() → Date

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniumWithNoOverflow

Changes the value

date.subMillenniumWithNoOverflow() → Date

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniumWithOverflow

Changes the value

date.subMillenniumWithOverflow() → Date

Sub one millennium to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillenniumWithoutOverflow

Changes the value

date.subMillenniumWithoutOverflow() → Date

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMilli

Changes the value

date.subMilli() → Date

Sub one millisecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillis

Changes the value

date.subMillis(value?: int|float) → Date

Sub milliseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMillisecond

Changes the value

date.subMillisecond() → Date

Sub one millisecond to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMilliseconds

Changes the value

date.subMilliseconds(value?: int|float) → Date

Sub milliseconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMinute

Changes the value

date.subMinute() → Date

Sub one minute to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMinutes

Changes the value

date.subMinutes(value?: int|float) → Date

Sub minutes (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonth

Changes the value

date.subMonth() → Date

Sub one month to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthNoOverflow

Changes the value

date.subMonthNoOverflow() → Date

Sub one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthWithNoOverflow

Changes the value

date.subMonthWithNoOverflow() → Date

Sub one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthWithOverflow

Changes the value

date.subMonthWithOverflow() → Date

Sub one month to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthWithoutOverflow

Changes the value

date.subMonthWithoutOverflow() → Date

Sub one month to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonths

Changes the value

date.subMonths(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthsNoOverflow

Changes the value

date.subMonthsNoOverflow(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthsWithNoOverflow

Changes the value

date.subMonthsWithNoOverflow(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthsWithOverflow

Changes the value

date.subMonthsWithOverflow(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subMonthsWithoutOverflow

Changes the value

date.subMonthsWithoutOverflow(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarter

Changes the value

date.subQuarter() → Date

Sub one quarter to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarterNoOverflow

Changes the value

date.subQuarterNoOverflow() → Date

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarterWithNoOverflow

Changes the value

date.subQuarterWithNoOverflow() → Date

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarterWithOverflow

Changes the value

date.subQuarterWithOverflow() → Date

Sub one quarter to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarterWithoutOverflow

Changes the value

date.subQuarterWithoutOverflow() → Date

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuarters

Changes the value

date.subQuarters(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuartersNoOverflow

Changes the value

date.subQuartersNoOverflow(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuartersWithNoOverflow

Changes the value

date.subQuartersWithNoOverflow(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuartersWithOverflow

Changes the value

date.subQuartersWithOverflow(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subQuartersWithoutOverflow

Changes the value

date.subQuartersWithoutOverflow(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subRealUnit

Changes the value

date.subRealUnit(unit: mixed, value?: int = 1) → Date

Changes this date in place and returns it. Use date.copy() first to keep the original.

subSecond

Changes the value

date.subSecond() → Date

Sub one second to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subSeconds

Changes the value

date.subSeconds(value?: int|float) → Date

Sub seconds (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCCenturies

Changes the value

date.subUTCCenturies(value?: int|float) → Date

Sub centuries (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCCentury

Changes the value

date.subUTCCentury() → Date

Sub one century to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCDay

Changes the value

date.subUTCDay() → Date

Sub one day to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCDays

Changes the value

date.subUTCDays(value?: int|float) → Date

Sub days (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCDecade

Changes the value

date.subUTCDecade() → Date

Sub one decade to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCDecades

Changes the value

date.subUTCDecades(value?: int|float) → Date

Sub decades (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCHour

Changes the value

date.subUTCHour() → Date

Sub one hour to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCHours

Changes the value

date.subUTCHours(value?: int|float) → Date

Sub hours (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMicro

Changes the value

date.subUTCMicro() → Date

Sub one microsecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMicros

Changes the value

date.subUTCMicros(value?: int|float) → Date

Sub microseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMicrosecond

Changes the value

date.subUTCMicrosecond() → Date

Sub one microsecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMicroseconds

Changes the value

date.subUTCMicroseconds(value?: int|float) → Date

Sub microseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMillennia

Changes the value

date.subUTCMillennia(value?: int|float) → Date

Sub millennia (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMillennium

Changes the value

date.subUTCMillennium() → Date

Sub one millennium to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMilli

Changes the value

date.subUTCMilli() → Date

Sub one millisecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMillis

Changes the value

date.subUTCMillis(value?: int|float) → Date

Sub milliseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMillisecond

Changes the value

date.subUTCMillisecond() → Date

Sub one millisecond to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMilliseconds

Changes the value

date.subUTCMilliseconds(value?: int|float) → Date

Sub milliseconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMinute

Changes the value

date.subUTCMinute() → Date

Sub one minute to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMinutes

Changes the value

date.subUTCMinutes(value?: int|float) → Date

Sub minutes (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMonth

Changes the value

date.subUTCMonth() → Date

Sub one month to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCMonths

Changes the value

date.subUTCMonths(value?: int|float) → Date

Sub months (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCQuarter

Changes the value

date.subUTCQuarter() → Date

Sub one quarter to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCQuarters

Changes the value

date.subUTCQuarters(value?: int|float) → Date

Sub quarters (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCSecond

Changes the value

date.subUTCSecond() → Date

Sub one second to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCSeconds

Changes the value

date.subUTCSeconds(value?: int|float) → Date

Sub seconds (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCUnit

Changes the value

date.subUTCUnit(unit: mixed, value?: int = 1) → Date

Subtract seconds to the instance using timestamp. Positive $value travels into the past while negative $value travels forward. Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCWeek

Changes the value

date.subUTCWeek() → Date

Sub one week to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCWeeks

Changes the value

date.subUTCWeeks(value?: int|float) → Date

Sub weeks (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCYear

Changes the value

date.subUTCYear() → Date

Sub one year to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUTCYears

Changes the value

date.subUTCYears(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using timestamp). Changes this date in place and returns it. Use date.copy() first to keep the original.

subUnit

Changes the value

date.subUnit(unit: Unit, value?: mixed = 1, overflow?: bool) → Date

Subtract given units to the current instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

subUnitNoOverflow

Changes the value

date.subUnitNoOverflow(valueUnit: string, value: int, overflowUnit: string) → Date

Subtract any unit to a new value without overflowing current other unit given. Changes this date in place and returns it. Use date.copy() first to keep the original.

subWeek

Changes the value

date.subWeek() → Date

Sub one week to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subWeekday

Changes the value

date.subWeekday() → Date

Sub one weekday to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subWeekdays

Changes the value

date.subWeekdays(value?: int|float) → Date

Sub weekdays (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subWeeks

Changes the value

date.subWeeks(value?: int|float) → Date

Sub weeks (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subYear

Changes the value

date.subYear() → Date

Sub one year to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearNoOverflow

Changes the value

date.subYearNoOverflow() → Date

Sub one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearWithNoOverflow

Changes the value

date.subYearWithNoOverflow() → Date

Sub one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearWithOverflow

Changes the value

date.subYearWithOverflow() → Date

Sub one year to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearWithoutOverflow

Changes the value

date.subYearWithoutOverflow() → Date

Sub one year to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYears

Changes the value

date.subYears(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using date interval). Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearsNoOverflow

Changes the value

date.subYearsNoOverflow(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearsWithNoOverflow

Changes the value

date.subYearsWithNoOverflow(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearsWithOverflow

Changes the value

date.subYearsWithOverflow(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed. Changes this date in place and returns it. Use date.copy() first to keep the original.

subYearsWithoutOverflow

Changes the value

date.subYearsWithoutOverflow(value?: int|float) → Date

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden. Changes this date in place and returns it. Use date.copy() first to keep the original.

subtract

Changes the value

date.subtract(unit: mixed, value?: mixed = 1, overflow?: bool) → Date

Subtract given units or interval to the current instance. Changes this date in place and returns it. Use date.copy() first to keep the original.

timespan

date.timespan(other?: mixed, timezone?: mixed) → string

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

timestamp

date.timestamp(timestamp: string) → Date

Set the instance’s timestamp.

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

timezone

date.timezone(value: DateTimeZone) → Date

No description yet.

to

date.to(other?: mixed, syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

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

toArray

date.toArray() → array

Get default array representation.

var_dump(Carbon::now()->toArray());

toAtomString

date.toAtomString() → string

Format the instance as ATOM

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

toCookieString

date.toCookieString() → string

Format the instance as COOKIE

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

toDate

date.toDate() → DateTime

No description yet.

var_dump(Carbon::now()->toDate());

toDateString

date.toDateString() → string

Format the instance as date

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

toDateTime

date.toDateTime() → DateTime

Return native DateTime PHP object matching the current instance.

var_dump(Carbon::now()->toDateTime());

toDateTimeImmutable

date.toDateTimeImmutable() → DateTimeImmutable

Return native toDateTimeImmutable PHP object matching the current instance.

var_dump(Carbon::now()->toDateTimeImmutable());

toDateTimeLocalString

date.toDateTimeLocalString(unitPrecision?: string = "second") → string

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

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

toDateTimeString

date.toDateTimeString(unitPrecision?: string = "second") → string

Format the instance as date and time

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

toDayDateTimeString

date.toDayDateTimeString() → string

Format the instance with day, date and time

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

toFormattedDateString

date.toFormattedDateString() → string

Format the instance as a readable date

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

toFormattedDayDateString

date.toFormattedDayDateString() → string

Format the instance with the day, and a readable date

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

toISOString

date.toISOString(keepOffset?: bool = false) → string

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).

echo Carbon::now(‘America/Toronto’)->toISOString() . “\n”; echo Carbon::now(‘America/Toronto’)->toISOString(true) . “\n”;

toImmutable

date.toImmutable() → CarbonImmutable

Return a immutable copy of the instance.

toIso8601String

date.toIso8601String() → string

Format the instance as ISO8601

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

toIso8601ZuluString

date.toIso8601ZuluString(unitPrecision?: string = "second") → string

Convert the instance to UTC and return as Zulu ISO8601

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

toJSON

date.toJSON() → string

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

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

toMutable

date.toMutable() → Date

Return a mutable copy of the instance.

toNow

date.toNow(syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

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

toObject

date.toObject() → object

Get default object representation.

var_dump(Carbon::now()->toObject());

toPeriod

date.toPeriod(end?: mixed, interval?: mixed, unit?: string) → CarbonPeriod

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

toRfc1036String

date.toRfc1036String() → string

Format the instance as RFC1036

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

toRfc1123String

date.toRfc1123String() → string

Format the instance as RFC1123

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

toRfc2822String

date.toRfc2822String() → string

Format the instance as RFC2822

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

toRfc3339String

date.toRfc3339String(extended?: bool = false) → string

Format the instance as RFC3339.

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

toRfc7231String

date.toRfc7231String() → string

Format the instance as RFC7231

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

toRfc822String

date.toRfc822String() → string

Format the instance as RFC822

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

toRfc850String

date.toRfc850String() → string

Format the instance as RFC850

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

toRssString

date.toRssString() → string

Format the instance as RSS

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

toString

date.toString() → string

Returns english human-readable complete date string.

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

toTimeString

date.toTimeString(unitPrecision?: string = "second") → string

Format the instance as time

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

toW3cString

date.toW3cString() → string

Format the instance as W3C

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

translate

date.translate(key: string, parameters?: array = [], number?: string, translator?: TranslatorInterface, altNumbers?: bool = false) → string

Translate using translation string or callback available.

translateNumber

date.translateNumber(number: int) → string

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

translateTimeStringTo

date.translateTimeStringTo(timeString: string, to?: string) → string

Translate a time string from the current locale ($date->locale()) to another one.

translatedFormat

date.translatedFormat(format: string) → string

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.

tz

date.tz(value?: DateTimeZone) → Date

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

unix

date.unix() → int

No description yet.

until

date.until(other?: mixed, syntax?: mixed, short?: mixed = false, parts?: mixed = 1, options?: int) → string

No description yet.

utc

date.utc() → Date

Set the instance’s timezone to UTC.

utcOffset

date.utcOffset(minuteOffset?: int) → Date

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

valueOf

date.valueOf() → float

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

week

date.week(week?: mixed, dayOfWeek?: mixed, dayOfYear?: int) → Date

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).

weekOfCentury

date.weekOfCentury(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current century when called with no parameters, change the current week when called with an integer value

weekOfDecade

date.weekOfDecade(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current decade when called with no parameters, change the current week when called with an integer value

weekOfMillennium

date.weekOfMillennium(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current millennium when called with no parameters, change the current week when called with an integer value

weekOfMonth

date.weekOfMonth(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current month when called with no parameters, change the current week when called with an integer value

weekOfQuarter

date.weekOfQuarter(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current quarter when called with no parameters, change the current week when called with an integer value

weekOfYear

date.weekOfYear(week?: ?int) → int|static

Return the value of the week starting from the beginning of the current year when called with no parameters, change the current week when called with an integer value

weekYear

date.weekYear(year?: mixed, dayOfWeek?: mixed, dayOfYear?: int) → Date

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).

weekday

date.weekday(value?: WeekDay) → Date

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

weeksInCentury

date.weeksInCentury() → int

Return the number of weeks contained in the current century

weeksInDecade

date.weeksInDecade() → int

Return the number of weeks contained in the current decade

weeksInMillennium

date.weeksInMillennium() → int

Return the number of weeks contained in the current millennium

weeksInMonth

date.weeksInMonth() → int

Return the number of weeks contained in the current month

weeksInQuarter

date.weeksInQuarter() → int

Return the number of weeks contained in the current quarter

weeksInYear

date.weeksInYear(dayOfWeek?: mixed, dayOfYear?: int) → int

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).

weeksUntil

date.weeksUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each week or every X weeks if a factor is given.

year

Changes the value

date.year(value: int) → Date

Set current instance year to the given value. Changes this date in place and returns it. Use date.copy() first to keep the original.

yearOfCentury

date.yearOfCentury(year?: ?int) → int|static

Return the value of the year starting from the beginning of the current century when called with no parameters, change the current year when called with an integer value

yearOfDecade

date.yearOfDecade(year?: ?int) → int|static

Return the value of the year starting from the beginning of the current decade when called with no parameters, change the current year when called with an integer value

yearOfMillennium

date.yearOfMillennium(year?: ?int) → int|static

Return the value of the year starting from the beginning of the current millennium when called with no parameters, change the current year when called with an integer value

years

date.years(value: int) → Date

Set current instance year to the given value.

yearsInCentury

date.yearsInCentury() → int

Return the number of years contained in the current century

yearsInDecade

date.yearsInDecade() → int

Return the number of years contained in the current decade

yearsInMillennium

date.yearsInMillennium() → int

Return the number of years contained in the current millennium

yearsUntil

date.yearsUntil(endDate?: mixed, factor?: int|float) → CarbonPeriod

Return an iterable period from current date to given end (string, DateTime or Carbon instance) for each year or every X years if a factor is given.