Pionia Core

Carbon extends DateTime
in package
implements CarbonInterface Uses Date

A simple API extension for DateTime.

<autodoc generated by composer phpdoc>

Table of Contents

Interfaces

CarbonInterface
Common interface for Carbon and CarbonImmutable.

Properties

$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
$isoWeeksInYear  : int
$isoWeekYear  : 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|string
$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
$weeksInCentury  : int
$weeksInDecade  : int
$weeksInMillennium  : int
$weeksInMonth  : int
$weeksInQuarter  : int
$weeksInYear  : int
$weekYear  : int
$year  : int
$yearIso  : int
$yearOfCentury  : int
$yearOfDecade  : int
$yearOfMillennium  : int
$yearsInCentury  : int
$yearsInDecade  : int
$yearsInMillennium  : int
$days  : array<string|int, mixed>
Names of days of the week.
$units  : array<string|int, mixed>
List of unit and magic methods associated as doc-comments.

Methods

__call()  : mixed
Dynamically handle calls to the class.
__callStatic()  : mixed
Dynamically handle calls to the class.
__get()  : string|int|bool|DateTimeZone|null
Get a part of the Carbon object.
__isset()  : bool
Check if an attribute exists on the object
__set()  : void
Set a part of the Carbon object
addCenturies()  : $this
addCenturiesNoOverflow()  : $this
addCenturiesWithNoOverflow()  : $this
addCenturiesWithoutOverflow()  : $this
addCenturiesWithOverflow()  : $this
addCentury()  : $this
addCenturyNoOverflow()  : $this
addCenturyWithNoOverflow()  : $this
addCenturyWithoutOverflow()  : $this
addCenturyWithOverflow()  : $this
addDay()  : $this
addDays()  : $this
addDecade()  : $this
addDecadeNoOverflow()  : $this
addDecades()  : $this
addDecadesNoOverflow()  : $this
addDecadesWithNoOverflow()  : $this
addDecadesWithoutOverflow()  : $this
addDecadesWithOverflow()  : $this
addDecadeWithNoOverflow()  : $this
addDecadeWithoutOverflow()  : $this
addDecadeWithOverflow()  : $this
addHour()  : $this
addHours()  : $this
addMicro()  : $this
addMicros()  : $this
addMicrosecond()  : $this
addMicroseconds()  : $this
addMillennia()  : $this
addMillenniaNoOverflow()  : $this
addMillenniaWithNoOverflow()  : $this
addMillenniaWithoutOverflow()  : $this
addMillenniaWithOverflow()  : $this
addMillennium()  : $this
addMillenniumNoOverflow()  : $this
addMillenniumWithNoOverflow()  : $this
addMillenniumWithoutOverflow()  : $this
addMillenniumWithOverflow()  : $this
addMilli()  : $this
addMillis()  : $this
addMillisecond()  : $this
addMilliseconds()  : $this
addMinute()  : $this
addMinutes()  : $this
addMonth()  : $this
addMonthNoOverflow()  : $this
addMonths()  : $this
addMonthsNoOverflow()  : $this
addMonthsWithNoOverflow()  : $this
addMonthsWithoutOverflow()  : $this
addMonthsWithOverflow()  : $this
addMonthWithNoOverflow()  : $this
addMonthWithoutOverflow()  : $this
addMonthWithOverflow()  : $this
addQuarter()  : $this
addQuarterNoOverflow()  : $this
addQuarters()  : $this
addQuartersNoOverflow()  : $this
addQuartersWithNoOverflow()  : $this
addQuartersWithoutOverflow()  : $this
addQuartersWithOverflow()  : $this
addQuarterWithNoOverflow()  : $this
addQuarterWithoutOverflow()  : $this
addQuarterWithOverflow()  : $this
addSecond()  : $this
addSeconds()  : $this
addUnitNoOverflow()  : static
Add any unit to a new value without overflowing current other unit given.
addUTCCenturies()  : $this
addUTCCentury()  : $this
addUTCDay()  : $this
addUTCDays()  : $this
addUTCDecade()  : $this
addUTCDecades()  : $this
addUTCHour()  : $this
addUTCHours()  : $this
addUTCMicro()  : $this
addUTCMicros()  : $this
addUTCMicrosecond()  : $this
addUTCMicroseconds()  : $this
addUTCMillennia()  : $this
addUTCMillennium()  : $this
addUTCMilli()  : $this
addUTCMillis()  : $this
addUTCMillisecond()  : $this
addUTCMilliseconds()  : $this
addUTCMinute()  : $this
addUTCMinutes()  : $this
addUTCMonth()  : $this
addUTCMonths()  : $this
addUTCQuarter()  : $this
addUTCQuarters()  : $this
addUTCSecond()  : $this
addUTCSeconds()  : $this
addUTCWeek()  : $this
addUTCWeeks()  : $this
addUTCYear()  : $this
addUTCYears()  : $this
addWeek()  : $this
addWeekday()  : $this
addWeekdays()  : $this
addWeeks()  : $this
addYear()  : $this
addYearNoOverflow()  : $this
addYears()  : $this
addYearsNoOverflow()  : $this
addYearsWithNoOverflow()  : $this
addYearsWithoutOverflow()  : $this
addYearsWithOverflow()  : $this
addYearWithNoOverflow()  : $this
addYearWithoutOverflow()  : $this
addYearWithOverflow()  : $this
avoidMutation()  : static
Clone the current instance if it's mutable.
carbonize()  : static
Return the Carbon instance passed through, a now instance in the same timezone if null given or parse the input if string given.
ceilCenturies()  : $this
ceilCentury()  : $this
ceilDay()  : $this
ceilDays()  : $this
ceilDecade()  : $this
ceilDecades()  : $this
ceilHour()  : $this
ceilHours()  : $this
ceilMicrosecond()  : $this
ceilMicroseconds()  : $this
ceilMillennia()  : $this
ceilMillennium()  : $this
ceilMillisecond()  : $this
ceilMilliseconds()  : $this
ceilMinute()  : $this
ceilMinutes()  : $this
ceilMonth()  : $this
ceilMonths()  : $this
ceilQuarter()  : $this
ceilQuarters()  : $this
ceilSecond()  : $this
ceilSeconds()  : $this
ceilYear()  : $this
ceilYears()  : $this
centuriesInMillennium()  : int
centuriesUntil()  : CarbonPeriod
centuryOfMillennium()  : int|static
clone()  : static
copy()  : static
Get a copy of the instance.
day()  : $this
dayOfCentury()  : int|static
dayOfDecade()  : int|static
dayOfMillennium()  : int|static
dayOfMonth()  : int|static
dayOfQuarter()  : int|static
dayOfWeek()  : int|static
dayOfYear()  : static|int
Get/set the day of year.
days()  : $this
daysInCentury()  : int
daysInDecade()  : int
daysInMillennium()  : int
daysInMonth()  : int
daysInQuarter()  : int
daysInWeek()  : int
daysInYear()  : int
daysUntil()  : CarbonPeriod
decadeOfCentury()  : int|static
decadeOfMillennium()  : int|static
decadesInCentury()  : int
decadesInMillennium()  : int
decadesUntil()  : CarbonPeriod
diffInUTCCenturies()  : float
diffInUTCDays()  : float
diffInUTCDecades()  : float
diffInUTCHours()  : float
diffInUTCMicros()  : float
diffInUTCMicroseconds()  : float
diffInUTCMillennia()  : float
diffInUTCMillis()  : float
diffInUTCMilliseconds()  : float
diffInUTCMinutes()  : float
diffInUTCMonths()  : float
diffInUTCQuarters()  : float
diffInUTCSeconds()  : float
diffInUTCWeeks()  : float
diffInUTCYears()  : float
floorCenturies()  : $this
floorCentury()  : $this
floorDay()  : $this
floorDays()  : $this
floorDecade()  : $this
floorDecades()  : $this
floorHour()  : $this
floorHours()  : $this
floorMicrosecond()  : $this
floorMicroseconds()  : $this
floorMillennia()  : $this
floorMillennium()  : $this
floorMillisecond()  : $this
floorMilliseconds()  : $this
floorMinute()  : $this
floorMinutes()  : $this
floorMonth()  : $this
floorMonths()  : $this
floorQuarter()  : $this
floorQuarters()  : $this
floorSecond()  : $this
floorSeconds()  : $this
floorYear()  : $this
floorYears()  : $this
get()  : string|int|bool|DateTimeZone
Get a part of the Carbon object.
getAltNumber()  : string
Returns the alternative number for a given date property if available in the current locale.
getCalendarFormats()  : array<string|int, mixed>
Returns list of calendar formats for ISO formatting.
getDays()  : array<string|int, mixed>
Get the days of the week.
getDaysFromStartOfWeek()  : int
Return the number of days since the start of the week (using the current locale or the first parameter if explicitly given).
getFormatsToIsoReplacements()  : array<string|int, mixed>
List of replacements from date() format to isoFormat().
getIsoFormats()  : array<string|int, mixed>
Returns list of locale formats for ISO formatting.
getIsoUnits()  : array<string|int, mixed>
Returns list of locale units for ISO formatting.
getOffsetString()  : string
Returns the offset hour and minute formatted with +/- and a given separator (":" by default).
getPaddedUnit()  : string
Returns a unit of the instance padded with 0 by default or any other string if specified.
getTimezone()  : CarbonTimeZone
Get the TimeZone associated with the Carbon instance (as CarbonTimeZone).
getTranslatedDayName()  : string
Get the translation of the current week day name (with context for languages with multiple forms).
getTranslatedMinDayName()  : string
Get the translation of the current abbreviated week day name (with context for languages with multiple forms).
getTranslatedMonthName()  : string
Get the translation of the current month day name (with context for languages with multiple forms).
getTranslatedShortDayName()  : string
Get the translation of the current short week day name (with context for languages with multiple forms).
getTranslatedShortMonthName()  : string
Get the translation of the current short month day name (with context for languages with multiple forms).
getWeekendDays()  : array<string|int, mixed>
Get weekend days
getWeekEndsAt()  : int
Get the last day of week.
getWeekStartsAt()  : int
Get the first day of week.
hasRelativeKeywords()  : bool
Determine if a time string will produce a relative date.
hour()  : $this
hourOfCentury()  : int|static
hourOfDay()  : int|static
hourOfDecade()  : int|static
hourOfMillennium()  : int|static
hourOfMonth()  : int|static
hourOfQuarter()  : int|static
hourOfWeek()  : int|static
hourOfYear()  : int|static
hours()  : $this
hoursInCentury()  : int
hoursInDay()  : int
hoursInDecade()  : int
hoursInMillennium()  : int
hoursInMonth()  : int
hoursInQuarter()  : int
hoursInWeek()  : int
hoursInYear()  : int
hoursUntil()  : CarbonPeriod
isCurrentCentury()  : bool
isCurrentDay()  : bool
isCurrentDecade()  : bool
isCurrentHour()  : bool
isCurrentMicro()  : bool
isCurrentMicrosecond()  : bool
isCurrentMillennium()  : bool
isCurrentMilli()  : bool
isCurrentMillisecond()  : bool
isCurrentMinute()  : bool
isCurrentMonth()  : bool
isCurrentQuarter()  : bool
isCurrentSecond()  : bool
isCurrentWeek()  : bool
isCurrentYear()  : bool
isDST()  : bool
isFriday()  : bool
isLastCentury()  : bool
isLastDay()  : bool
isLastDecade()  : bool
isLastHour()  : bool
isLastMicro()  : bool
isLastMicrosecond()  : bool
isLastMillennium()  : bool
isLastMilli()  : bool
isLastMillisecond()  : bool
isLastMinute()  : bool
isLastMonth()  : bool
isLastQuarter()  : bool
isLastSecond()  : bool
isLastWeek()  : bool
isLastYear()  : bool
isLocal()  : bool
isMonday()  : bool
isMutable()  : bool
Returns true if the current class/instance is mutable.
isNextCentury()  : bool
isNextDay()  : bool
isNextDecade()  : bool
isNextHour()  : bool
isNextMicro()  : bool
isNextMicrosecond()  : bool
isNextMillennium()  : bool
isNextMilli()  : bool
isNextMillisecond()  : bool
isNextMinute()  : bool
isNextMonth()  : bool
isNextQuarter()  : bool
isNextSecond()  : bool
isNextWeek()  : bool
isNextYear()  : bool
isoFormat()  : string
Format in the current language using ISO replacement patterns.
isoWeekday()  : static|int
Get/set the ISO weekday from 1 (Monday) to 7 (Sunday).
isSameCentury()  : bool
isSameDay()  : bool
isSameDecade()  : bool
isSameHour()  : bool
isSameMicro()  : bool
isSameMicrosecond()  : bool
isSameMillennium()  : bool
isSameMilli()  : bool
isSameMillisecond()  : bool
isSameMinute()  : bool
isSameSecond()  : bool
isSameWeek()  : bool
isSameYear()  : bool
isSaturday()  : bool
isSunday()  : bool
isThursday()  : bool
isTuesday()  : bool
isUtc()  : bool
isValid()  : bool
isWednesday()  : bool
longAbsoluteDiffForHumans()  : string
longRelativeDiffForHumans()  : string
longRelativeToNowDiffForHumans()  : string
longRelativeToOtherDiffForHumans()  : string
meridiem()  : string
Return the meridiem of the current time in the current locale.
micro()  : $this
micros()  : $this
microsecond()  : $this
microsecondOfCentury()  : int|static
microsecondOfDay()  : int|static
microsecondOfDecade()  : int|static
microsecondOfHour()  : int|static
microsecondOfMillennium()  : int|static
microsecondOfMillisecond()  : int|static
microsecondOfMinute()  : int|static
microsecondOfMonth()  : int|static
microsecondOfQuarter()  : int|static
microsecondOfSecond()  : int|static
microsecondOfWeek()  : int|static
microsecondOfYear()  : int|static
microseconds()  : $this
microsecondsInCentury()  : int
microsecondsInDay()  : int
microsecondsInDecade()  : int
microsecondsInHour()  : int
microsecondsInMillennium()  : int
microsecondsInMillisecond()  : int
microsecondsInMinute()  : int
microsecondsInMonth()  : int
microsecondsInQuarter()  : int
microsecondsInSecond()  : int
microsecondsInWeek()  : int
microsecondsInYear()  : int
microsecondsUntil()  : CarbonPeriod
microsUntil()  : CarbonPeriod
millenniaUntil()  : CarbonPeriod
milli()  : $this
millis()  : $this
millisecond()  : $this
millisecondOfCentury()  : int|static
millisecondOfDay()  : int|static
millisecondOfDecade()  : int|static
millisecondOfHour()  : int|static
millisecondOfMillennium()  : int|static
millisecondOfMinute()  : int|static
millisecondOfMonth()  : int|static
millisecondOfQuarter()  : int|static
millisecondOfSecond()  : int|static
millisecondOfWeek()  : int|static
millisecondOfYear()  : int|static
milliseconds()  : $this
millisecondsInCentury()  : int
millisecondsInDay()  : int
millisecondsInDecade()  : int
millisecondsInHour()  : int
millisecondsInMillennium()  : int
millisecondsInMinute()  : int
millisecondsInMonth()  : int
millisecondsInQuarter()  : int
millisecondsInSecond()  : int
millisecondsInWeek()  : int
millisecondsInYear()  : int
millisecondsUntil()  : CarbonPeriod
millisUntil()  : CarbonPeriod
minute()  : $this
minuteOfCentury()  : int|static
minuteOfDay()  : int|static
minuteOfDecade()  : int|static
minuteOfHour()  : int|static
minuteOfMillennium()  : int|static
minuteOfMonth()  : int|static
minuteOfQuarter()  : int|static
minuteOfWeek()  : int|static
minuteOfYear()  : int|static
minutes()  : $this
minutesInCentury()  : int
minutesInDay()  : int
minutesInDecade()  : int
minutesInHour()  : int
minutesInMillennium()  : int
minutesInMonth()  : int
minutesInQuarter()  : int
minutesInWeek()  : int
minutesInYear()  : int
minutesUntil()  : CarbonPeriod
month()  : $this
monthOfCentury()  : int|static
monthOfDecade()  : int|static
monthOfMillennium()  : int|static
monthOfQuarter()  : int|static
monthOfYear()  : int|static
months()  : $this
monthsInCentury()  : int
monthsInDecade()  : int
monthsInMillennium()  : int
monthsInQuarter()  : int
monthsInYear()  : int
monthsUntil()  : CarbonPeriod
nowWithSameTz()  : static
Returns a present instance in the same timezone.
ordinal()  : string
Return a property with its ordinal.
pluralUnit()  : string
Returns standardized plural of a given singular/plural unit name (in English).
quarterOfCentury()  : int|static
quarterOfDecade()  : int|static
quarterOfMillennium()  : int|static
quarterOfYear()  : int|static
quartersInCentury()  : int
quartersInDecade()  : int
quartersInMillennium()  : int
quartersInYear()  : int
quartersUntil()  : CarbonPeriod
roundCenturies()  : $this
roundCentury()  : $this
roundDay()  : $this
roundDays()  : $this
roundDecade()  : $this
roundDecades()  : $this
roundHour()  : $this
roundHours()  : $this
roundMicrosecond()  : $this
roundMicroseconds()  : $this
roundMillennia()  : $this
roundMillennium()  : $this
roundMillisecond()  : $this
roundMilliseconds()  : $this
roundMinute()  : $this
roundMinutes()  : $this
roundMonth()  : $this
roundMonths()  : $this
roundQuarter()  : $this
roundQuarters()  : $this
roundSecond()  : $this
roundSeconds()  : $this
roundYear()  : $this
roundYears()  : $this
second()  : $this
secondOfCentury()  : int|static
secondOfDay()  : int|static
secondOfDecade()  : int|static
secondOfHour()  : int|static
secondOfMillennium()  : int|static
secondOfMinute()  : int|static
secondOfMonth()  : int|static
secondOfQuarter()  : int|static
secondOfWeek()  : int|static
secondOfYear()  : int|static
seconds()  : $this
secondsInCentury()  : int
secondsInDay()  : int
secondsInDecade()  : int
secondsInHour()  : int
secondsInMillennium()  : int
secondsInMinute()  : int
secondsInMonth()  : int
secondsInQuarter()  : int
secondsInWeek()  : int
secondsInYear()  : int
secondsUntil()  : CarbonPeriod
set()  : $this
Set a part of the Carbon object.
setDate()  : static
Set the date with gregorian year, month and day numbers.
setDateFrom()  : static
Set the year, month, and date for this instance to that of the passed instance.
setDateTime()  : static
Set the date and time all together.
setDateTimeFrom()  : static
Set the date and time for this instance to that of the passed instance.
setDay()  : $this
setDays()  : $this
setDaysFromStartOfWeek()  : static
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.
setHour()  : $this
setHours()  : $this
setISODate()  : static
Set a date according to the ISO 8601 standard - using weeks and day offsets rather than specific dates.
setMicro()  : $this
setMicros()  : $this
setMicrosecond()  : $this
setMicroseconds()  : $this
setMilli()  : $this
setMillis()  : $this
setMillisecond()  : $this
setMilliseconds()  : $this
setMinute()  : $this
setMinutes()  : $this
setMonth()  : $this
setMonths()  : $this
setSecond()  : $this
setSeconds()  : $this
setTime()  : static
Resets the current time of the DateTime object to a different time.
setTimeFrom()  : static
Set the hour, minute, second and microseconds for this instance to that of the passed instance.
setTimeFromTimeString()  : static
Set the time by time string.
setTimestamp()  : static
Set the instance's timestamp.
setTimezone()  : static
Set the instance's timezone from a string or object.
setUnit()  : static
Set specified unit to new given value.
setUnitNoOverflow()  : static
Set any unit to a new value without overflowing current other unit given.
setWeekendDays()  : void
setYear()  : $this
setYears()  : $this
shiftTimezone()  : static
Set the instance's timezone from a string or object and add/subtract the offset difference.
shortAbsoluteDiffForHumans()  : string
shortRelativeDiffForHumans()  : string
shortRelativeToNowDiffForHumans()  : string
shortRelativeToOtherDiffForHumans()  : string
singularUnit()  : string
Returns standardized singular of a given singular/plural unit name (in English).
sleep()  : void
subCenturies()  : $this
subCenturiesNoOverflow()  : $this
subCenturiesWithNoOverflow()  : $this
subCenturiesWithoutOverflow()  : $this
subCenturiesWithOverflow()  : $this
subCentury()  : $this
subCenturyNoOverflow()  : $this
subCenturyWithNoOverflow()  : $this
subCenturyWithoutOverflow()  : $this
subCenturyWithOverflow()  : $this
subDay()  : $this
subDays()  : $this
subDecade()  : $this
subDecadeNoOverflow()  : $this
subDecades()  : $this
subDecadesNoOverflow()  : $this
subDecadesWithNoOverflow()  : $this
subDecadesWithoutOverflow()  : $this
subDecadesWithOverflow()  : $this
subDecadeWithNoOverflow()  : $this
subDecadeWithoutOverflow()  : $this
subDecadeWithOverflow()  : $this
subHour()  : $this
subHours()  : $this
subMicro()  : $this
subMicros()  : $this
subMicrosecond()  : $this
subMicroseconds()  : $this
subMillennia()  : $this
subMillenniaNoOverflow()  : $this
subMillenniaWithNoOverflow()  : $this
subMillenniaWithoutOverflow()  : $this
subMillenniaWithOverflow()  : $this
subMillennium()  : $this
subMillenniumNoOverflow()  : $this
subMillenniumWithNoOverflow()  : $this
subMillenniumWithoutOverflow()  : $this
subMillenniumWithOverflow()  : $this
subMilli()  : $this
subMillis()  : $this
subMillisecond()  : $this
subMilliseconds()  : $this
subMinute()  : $this
subMinutes()  : $this
subMonth()  : $this
subMonthNoOverflow()  : $this
subMonths()  : $this
subMonthsNoOverflow()  : $this
subMonthsWithNoOverflow()  : $this
subMonthsWithoutOverflow()  : $this
subMonthsWithOverflow()  : $this
subMonthWithNoOverflow()  : $this
subMonthWithoutOverflow()  : $this
subMonthWithOverflow()  : $this
subQuarter()  : $this
subQuarterNoOverflow()  : $this
subQuarters()  : $this
subQuartersNoOverflow()  : $this
subQuartersWithNoOverflow()  : $this
subQuartersWithoutOverflow()  : $this
subQuartersWithOverflow()  : $this
subQuarterWithNoOverflow()  : $this
subQuarterWithoutOverflow()  : $this
subQuarterWithOverflow()  : $this
subSecond()  : $this
subSeconds()  : $this
subUnitNoOverflow()  : static
Subtract any unit to a new value without overflowing current other unit given.
subUTCCenturies()  : $this
subUTCCentury()  : $this
subUTCDay()  : $this
subUTCDays()  : $this
subUTCDecade()  : $this
subUTCDecades()  : $this
subUTCHour()  : $this
subUTCHours()  : $this
subUTCMicro()  : $this
subUTCMicros()  : $this
subUTCMicrosecond()  : $this
subUTCMicroseconds()  : $this
subUTCMillennia()  : $this
subUTCMillennium()  : $this
subUTCMilli()  : $this
subUTCMillis()  : $this
subUTCMillisecond()  : $this
subUTCMilliseconds()  : $this
subUTCMinute()  : $this
subUTCMinutes()  : $this
subUTCMonth()  : $this
subUTCMonths()  : $this
subUTCQuarter()  : $this
subUTCQuarters()  : $this
subUTCSecond()  : $this
subUTCSeconds()  : $this
subUTCWeek()  : $this
subUTCWeeks()  : $this
subUTCYear()  : $this
subUTCYears()  : $this
subWeek()  : $this
subWeekday()  : $this
subWeekdays()  : $this
subWeeks()  : $this
subYear()  : $this
subYearNoOverflow()  : $this
subYears()  : $this
subYearsNoOverflow()  : $this
subYearsWithNoOverflow()  : $this
subYearsWithoutOverflow()  : $this
subYearsWithOverflow()  : $this
subYearWithNoOverflow()  : $this
subYearWithoutOverflow()  : $this
subYearWithOverflow()  : $this
timezone()  : static
translatedFormat()  : 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()  : static|string
Set the timezone or returns the timezone name if no arguments passed.
utc()  : static
Set the instance's timezone to UTC.
utcOffset()  : static|int
Returns the minutes offset to UTC if no arguments passed, else set the timezone with given minutes shift passed.
weekday()  : static|int
Get/set the weekday from 0 (Sunday) to 6 (Saturday).
weekOfCentury()  : int|static
weekOfDecade()  : int|static
weekOfMillennium()  : int|static
weekOfMonth()  : int|static
weekOfQuarter()  : int|static
weekOfYear()  : int|static
weeksInCentury()  : int
weeksInDecade()  : int
weeksInMillennium()  : int
weeksInMonth()  : int
weeksInQuarter()  : int
weeksUntil()  : CarbonPeriod
year()  : $this
yearOfCentury()  : int|static
yearOfDecade()  : int|static
yearOfMillennium()  : int|static
years()  : $this
yearsInCentury()  : int
yearsInDecade()  : int
yearsInMillennium()  : int
yearsUntil()  : CarbonPeriod
executeCallable()  : mixed
executeCallableWithContext()  : mixed
executeStaticCallable()  : mixed
getAllGenericMacros()  : Generator
getGenericMacros()  : Generator
getRangesByUnit()  : array<string|int, mixed>
List of minimum and maximums for each unit.
getTranslatedFormByRegExp()  : mixed
resolveCarbon()  : self
Return the Carbon instance passed through, a now instance in the same timezone if null given or parse the input if string given.
safeCreateDateTimeZone()  : CarbonTimeZone|null
Creates a DateTimeZone from a string, DateTimeZone or integer offset.
weekRotate()  : int
callComparatorMethod()  : bool|null
callDiffAlias()  : mixed
callGetOrSet()  : mixed
callGetOrSetMethod()  : mixed
callHumanDiffAlias()  : string|null
callIsMethod()  : bool|null
callMacroMethod()  : mixed
callModifierMethod()  : static|null
callPeriodMethod()  : CarbonPeriod|null
floorZeroPad()  : string
getUTCUnit()  : string|null

Properties

$age

public int $age

does a diffInYears() with default parameters

$centuriesInMillennium read-only

public int $centuriesInMillennium

The number of centuries contained in the current millennium

$century read-only

public int $century

the century of this instance

$centuryOfMillennium

public int $centuryOfMillennium

The value of the century starting from the beginning of the current millennium

$dayName read-only

public string $dayName

long name of weekday translated according to Carbon locale, in english if no translation available for current language

$dayOfCentury

public int $dayOfCentury

The value of the day starting from the beginning of the current century

$dayOfDecade

public int $dayOfDecade

The value of the day starting from the beginning of the current decade

$dayOfMillennium

public int $dayOfMillennium

The value of the day starting from the beginning of the current millennium

$dayOfMonth

public int $dayOfMonth

The value of the day starting from the beginning of the current month

$dayOfQuarter

public int $dayOfQuarter

The value of the day starting from the beginning of the current quarter

$dayOfWeek

public int $dayOfWeek

0 (for Sunday) through 6 (for Saturday)

$dayOfWeekIso

public int $dayOfWeekIso

1 (for Monday) through 7 (for Sunday)

$dayOfYear

public int $dayOfYear

1 through 366

$daysInCentury read-only

public int $daysInCentury

The number of days contained in the current century

$daysInDecade read-only

public int $daysInDecade

The number of days contained in the current decade

$daysInMillennium read-only

public int $daysInMillennium

The number of days contained in the current millennium

$daysInMonth read-only

public int $daysInMonth

number of days in the given month

$daysInQuarter read-only

public int $daysInQuarter

The number of days contained in the current quarter

$daysInWeek read-only

public int $daysInWeek

The number of days contained in the current week

$daysInYear read-only

public int $daysInYear

365 or 366

$decade read-only

public int $decade

the decade of this instance

$decadeOfCentury

public int $decadeOfCentury

The value of the decade starting from the beginning of the current century

$decadeOfMillennium

public int $decadeOfMillennium

The value of the decade starting from the beginning of the current millennium

$decadesInCentury read-only

public int $decadesInCentury

The number of decades contained in the current century

$decadesInMillennium read-only

public int $decadesInMillennium

The number of decades contained in the current millennium

$dst read-only

public bool $dst

daylight savings time indicator, true if DST, false otherwise

$englishDayOfWeek

public string $englishDayOfWeek

the day of week in English

$englishMonth

public string $englishMonth

the month in English

$firstWeekDay read-only

public int $firstWeekDay

0 through 6

$hourOfCentury

public int $hourOfCentury

The value of the hour starting from the beginning of the current century

$hourOfDay

public int $hourOfDay

The value of the hour starting from the beginning of the current day

$hourOfDecade

public int $hourOfDecade

The value of the hour starting from the beginning of the current decade

$hourOfMillennium

public int $hourOfMillennium

The value of the hour starting from the beginning of the current millennium

$hourOfMonth

public int $hourOfMonth

The value of the hour starting from the beginning of the current month

$hourOfQuarter

public int $hourOfQuarter

The value of the hour starting from the beginning of the current quarter

$hourOfWeek

public int $hourOfWeek

The value of the hour starting from the beginning of the current week

$hourOfYear

public int $hourOfYear

The value of the hour starting from the beginning of the current year

$hoursInCentury read-only

public int $hoursInCentury

The number of hours contained in the current century

$hoursInDay read-only

public int $hoursInDay

The number of hours contained in the current day

$hoursInDecade read-only

public int $hoursInDecade

The number of hours contained in the current decade

$hoursInMillennium read-only

public int $hoursInMillennium

The number of hours contained in the current millennium

$hoursInMonth read-only

public int $hoursInMonth

The number of hours contained in the current month

$hoursInQuarter read-only

public int $hoursInQuarter

The number of hours contained in the current quarter

$hoursInWeek read-only

public int $hoursInWeek

The number of hours contained in the current week

$hoursInYear read-only

public int $hoursInYear

The number of hours contained in the current year

$isoWeek

public int $isoWeek

1 through 53

$isoWeeksInYear read-only

public int $isoWeeksInYear

51 through 53

$isoWeekYear

public int $isoWeekYear

year according to ISO week format

$lastWeekDay read-only

public int $lastWeekDay

0 through 6

$latinMeridiem read-only

public string $latinMeridiem

"am"/"pm" (Ante meridiem or Post meridiem latin lowercase mark)

$latinUpperMeridiem read-only

public string $latinUpperMeridiem

"AM"/"PM" (Ante meridiem or Post meridiem latin uppercase mark)

$local read-only

public bool $local

checks if the timezone is local, true if local, false otherwise

$locale read-only

public string $locale

locale of the current instance

$localeDayOfWeek

public string $localeDayOfWeek

the day of week in current locale

$localeMonth

public string $localeMonth

the month in current locale

$meridiem read-only

public string $meridiem

lowercase meridiem mark translated according to Carbon locale, in latin if no translation available for current language

$microsecond

public int $microsecond

$microsecondOfCentury

public int $microsecondOfCentury

The value of the microsecond starting from the beginning of the current century

$microsecondOfDay

public int $microsecondOfDay

The value of the microsecond starting from the beginning of the current day

$microsecondOfDecade

public int $microsecondOfDecade

The value of the microsecond starting from the beginning of the current decade

$microsecondOfHour

public int $microsecondOfHour

The value of the microsecond starting from the beginning of the current hour

$microsecondOfMillennium

public int $microsecondOfMillennium

The value of the microsecond starting from the beginning of the current millennium

$microsecondOfMillisecond

public int $microsecondOfMillisecond

The value of the microsecond starting from the beginning of the current millisecond

$microsecondOfMinute

public int $microsecondOfMinute

The value of the microsecond starting from the beginning of the current minute

$microsecondOfMonth

public int $microsecondOfMonth

The value of the microsecond starting from the beginning of the current month

$microsecondOfQuarter

public int $microsecondOfQuarter

The value of the microsecond starting from the beginning of the current quarter

$microsecondOfSecond

public int $microsecondOfSecond

The value of the microsecond starting from the beginning of the current second

$microsecondOfWeek

public int $microsecondOfWeek

The value of the microsecond starting from the beginning of the current week

$microsecondOfYear

public int $microsecondOfYear

The value of the microsecond starting from the beginning of the current year

$microsecondsInCentury read-only

public int $microsecondsInCentury

The number of microseconds contained in the current century

$microsecondsInDay read-only

public int $microsecondsInDay

The number of microseconds contained in the current day

$microsecondsInDecade read-only

public int $microsecondsInDecade

The number of microseconds contained in the current decade

$microsecondsInHour read-only

public int $microsecondsInHour

The number of microseconds contained in the current hour

$microsecondsInMillennium read-only

public int $microsecondsInMillennium

The number of microseconds contained in the current millennium

$microsecondsInMillisecond read-only

public int $microsecondsInMillisecond

The number of microseconds contained in the current millisecond

$microsecondsInMinute read-only

public int $microsecondsInMinute

The number of microseconds contained in the current minute

$microsecondsInMonth read-only

public int $microsecondsInMonth

The number of microseconds contained in the current month

$microsecondsInQuarter read-only

public int $microsecondsInQuarter

The number of microseconds contained in the current quarter

$microsecondsInSecond read-only

public int $microsecondsInSecond

The number of microseconds contained in the current second

$microsecondsInWeek read-only

public int $microsecondsInWeek

The number of microseconds contained in the current week

$microsecondsInYear read-only

public int $microsecondsInYear

The number of microseconds contained in the current year

$millennium read-only

public int $millennium

the millennium of this instance

$millisecond

public int $millisecond

$millisecondOfCentury

public int $millisecondOfCentury

The value of the millisecond starting from the beginning of the current century

$millisecondOfDay

public int $millisecondOfDay

The value of the millisecond starting from the beginning of the current day

$millisecondOfDecade

public int $millisecondOfDecade

The value of the millisecond starting from the beginning of the current decade

$millisecondOfHour

public int $millisecondOfHour

The value of the millisecond starting from the beginning of the current hour

$millisecondOfMillennium

public int $millisecondOfMillennium

The value of the millisecond starting from the beginning of the current millennium

$millisecondOfMinute

public int $millisecondOfMinute

The value of the millisecond starting from the beginning of the current minute

$millisecondOfMonth

public int $millisecondOfMonth

The value of the millisecond starting from the beginning of the current month

$millisecondOfQuarter

public int $millisecondOfQuarter

The value of the millisecond starting from the beginning of the current quarter

$millisecondOfSecond

public int $millisecondOfSecond

The value of the millisecond starting from the beginning of the current second

$millisecondOfWeek

public int $millisecondOfWeek

The value of the millisecond starting from the beginning of the current week

$millisecondOfYear

public int $millisecondOfYear

The value of the millisecond starting from the beginning of the current year

$milliseconds

public int $milliseconds

$millisecondsInCentury read-only

public int $millisecondsInCentury

The number of milliseconds contained in the current century

$millisecondsInDay read-only

public int $millisecondsInDay

The number of milliseconds contained in the current day

$millisecondsInDecade read-only

public int $millisecondsInDecade

The number of milliseconds contained in the current decade

$millisecondsInHour read-only

public int $millisecondsInHour

The number of milliseconds contained in the current hour

$millisecondsInMillennium read-only

public int $millisecondsInMillennium

The number of milliseconds contained in the current millennium

$millisecondsInMinute read-only

public int $millisecondsInMinute

The number of milliseconds contained in the current minute

$millisecondsInMonth read-only

public int $millisecondsInMonth

The number of milliseconds contained in the current month

$millisecondsInQuarter read-only

public int $millisecondsInQuarter

The number of milliseconds contained in the current quarter

$millisecondsInSecond read-only

public int $millisecondsInSecond

The number of milliseconds contained in the current second

$millisecondsInWeek read-only

public int $millisecondsInWeek

The number of milliseconds contained in the current week

$millisecondsInYear read-only

public int $millisecondsInYear

The number of milliseconds contained in the current year

$minDayName read-only

public string $minDayName

very short name of weekday translated according to Carbon locale, in english if no translation available for current language

$minuteOfCentury

public int $minuteOfCentury

The value of the minute starting from the beginning of the current century

$minuteOfDay

public int $minuteOfDay

The value of the minute starting from the beginning of the current day

$minuteOfDecade

public int $minuteOfDecade

The value of the minute starting from the beginning of the current decade

$minuteOfHour

public int $minuteOfHour

The value of the minute starting from the beginning of the current hour

$minuteOfMillennium

public int $minuteOfMillennium

The value of the minute starting from the beginning of the current millennium

$minuteOfMonth

public int $minuteOfMonth

The value of the minute starting from the beginning of the current month

$minuteOfQuarter

public int $minuteOfQuarter

The value of the minute starting from the beginning of the current quarter

$minuteOfWeek

public int $minuteOfWeek

The value of the minute starting from the beginning of the current week

$minuteOfYear

public int $minuteOfYear

The value of the minute starting from the beginning of the current year

$minutesInCentury read-only

public int $minutesInCentury

The number of minutes contained in the current century

$minutesInDay read-only

public int $minutesInDay

The number of minutes contained in the current day

$minutesInDecade read-only

public int $minutesInDecade

The number of minutes contained in the current decade

$minutesInHour read-only

public int $minutesInHour

The number of minutes contained in the current hour

$minutesInMillennium read-only

public int $minutesInMillennium

The number of minutes contained in the current millennium

$minutesInMonth read-only

public int $minutesInMonth

The number of minutes contained in the current month

$minutesInQuarter read-only

public int $minutesInQuarter

The number of minutes contained in the current quarter

$minutesInWeek read-only

public int $minutesInWeek

The number of minutes contained in the current week

$minutesInYear read-only

public int $minutesInYear

The number of minutes contained in the current year

$monthName read-only

public string $monthName

long name of month translated according to Carbon locale, in english if no translation available for current language

$monthOfCentury

public int $monthOfCentury

The value of the month starting from the beginning of the current century

$monthOfDecade

public int $monthOfDecade

The value of the month starting from the beginning of the current decade

$monthOfMillennium

public int $monthOfMillennium

The value of the month starting from the beginning of the current millennium

$monthOfQuarter

public int $monthOfQuarter

The value of the month starting from the beginning of the current quarter

$monthOfYear

public int $monthOfYear

The value of the month starting from the beginning of the current year

$monthsInCentury read-only

public int $monthsInCentury

The number of months contained in the current century

$monthsInDecade read-only

public int $monthsInDecade

The number of months contained in the current decade

$monthsInMillennium read-only

public int $monthsInMillennium

The number of months contained in the current millennium

$monthsInQuarter read-only

public int $monthsInQuarter

The number of months contained in the current quarter

$monthsInYear read-only

public int $monthsInYear

The number of months contained in the current year

$noZeroHour read-only

public int $noZeroHour

current hour from 1 to 24

$offset

public int $offset

the timezone offset in seconds from UTC

$offsetHours

public int $offsetHours

the timezone offset in hours from UTC

$offsetMinutes

public int $offsetMinutes

the timezone offset in minutes from UTC

$quarter read-only

public int $quarter

the quarter of this instance, 1 - 4

$quarterOfCentury

public int $quarterOfCentury

The value of the quarter starting from the beginning of the current century

$quarterOfDecade

public int $quarterOfDecade

The value of the quarter starting from the beginning of the current decade

$quarterOfMillennium

public int $quarterOfMillennium

The value of the quarter starting from the beginning of the current millennium

$quarterOfYear

public int $quarterOfYear

The value of the quarter starting from the beginning of the current year

$quartersInCentury read-only

public int $quartersInCentury

The number of quarters contained in the current century

$quartersInDecade read-only

public int $quartersInDecade

The number of quarters contained in the current decade

$quartersInMillennium read-only

public int $quartersInMillennium

The number of quarters contained in the current millennium

$quartersInYear read-only

public int $quartersInYear

The number of quarters contained in the current year

$secondOfCentury

public int $secondOfCentury

The value of the second starting from the beginning of the current century

$secondOfDay

public int $secondOfDay

The value of the second starting from the beginning of the current day

$secondOfDecade

public int $secondOfDecade

The value of the second starting from the beginning of the current decade

$secondOfHour

public int $secondOfHour

The value of the second starting from the beginning of the current hour

$secondOfMillennium

public int $secondOfMillennium

The value of the second starting from the beginning of the current millennium

$secondOfMinute

public int $secondOfMinute

The value of the second starting from the beginning of the current minute

$secondOfMonth

public int $secondOfMonth

The value of the second starting from the beginning of the current month

$secondOfQuarter

public int $secondOfQuarter

The value of the second starting from the beginning of the current quarter

$secondOfWeek

public int $secondOfWeek

The value of the second starting from the beginning of the current week

$secondOfYear

public int $secondOfYear

The value of the second starting from the beginning of the current year

$secondsInCentury read-only

public int $secondsInCentury

The number of seconds contained in the current century

$secondsInDay read-only

public int $secondsInDay

The number of seconds contained in the current day

$secondsInDecade read-only

public int $secondsInDecade

The number of seconds contained in the current decade

$secondsInHour read-only

public int $secondsInHour

The number of seconds contained in the current hour

$secondsInMillennium read-only

public int $secondsInMillennium

The number of seconds contained in the current millennium

$secondsInMinute read-only

public int $secondsInMinute

The number of seconds contained in the current minute

$secondsInMonth read-only

public int $secondsInMonth

The number of seconds contained in the current month

$secondsInQuarter read-only

public int $secondsInQuarter

The number of seconds contained in the current quarter

$secondsInWeek read-only

public int $secondsInWeek

The number of seconds contained in the current week

$secondsInYear read-only

public int $secondsInYear

The number of seconds contained in the current year

$shortDayName read-only

public string $shortDayName

short name of weekday translated according to Carbon locale, in english if no translation available for current language

$shortEnglishDayOfWeek

public string $shortEnglishDayOfWeek

the abbreviated day of week in English

$shortEnglishMonth

public string $shortEnglishMonth

the abbreviated month in English

$shortLocaleDayOfWeek

public string $shortLocaleDayOfWeek

the abbreviated day of week in current locale

$shortLocaleMonth

public string $shortLocaleMonth

the abbreviated month in current locale

$shortMonthName read-only

public string $shortMonthName

short name of month translated according to Carbon locale, in english if no translation available for current language

$timestamp

public int|float|string $timestamp

seconds since the Unix Epoch

$timezoneAbbreviatedName read-only

public string $timezoneAbbreviatedName

the current timezone abbreviated name

$timezoneName read-only

public string $timezoneName

the current timezone name

$tzAbbrName read-only

public string $tzAbbrName

alias of $timezoneAbbreviatedName

$tzName read-only

public string $tzName

alias of $timezoneName

$upperMeridiem read-only

public string $upperMeridiem

uppercase meridiem mark translated according to Carbon locale, in latin if no translation available for current language

$utc read-only

public bool $utc

checks if the timezone is UTC, true if UTC, false otherwise

$week

public int $week

1 through 53

$weekNumberInMonth read-only

public int $weekNumberInMonth

1 through 5

$weekOfCentury

public int $weekOfCentury

The value of the week starting from the beginning of the current century

$weekOfDecade

public int $weekOfDecade

The value of the week starting from the beginning of the current decade

$weekOfMillennium

public int $weekOfMillennium

The value of the week starting from the beginning of the current millennium

$weekOfMonth

public int $weekOfMonth

1 through 5

$weekOfQuarter

public int $weekOfQuarter

The value of the week starting from the beginning of the current quarter

$weekOfYear

public int $weekOfYear

ISO-8601 week number of year, weeks starting on Monday

$weeksInCentury read-only

public int $weeksInCentury

The number of weeks contained in the current century

$weeksInDecade read-only

public int $weeksInDecade

The number of weeks contained in the current decade

$weeksInMillennium read-only

public int $weeksInMillennium

The number of weeks contained in the current millennium

$weeksInMonth read-only

public int $weeksInMonth

The number of weeks contained in the current month

$weeksInQuarter read-only

public int $weeksInQuarter

The number of weeks contained in the current quarter

$weeksInYear read-only

public int $weeksInYear

51 through 53

$weekYear

public int $weekYear

year according to week format

$yearOfCentury

public int $yearOfCentury

The value of the year starting from the beginning of the current century

$yearOfDecade

public int $yearOfDecade

The value of the year starting from the beginning of the current decade

$yearOfMillennium

public int $yearOfMillennium

The value of the year starting from the beginning of the current millennium

$yearsInCentury read-only

public int $yearsInCentury

The number of years contained in the current century

$yearsInDecade read-only

public int $yearsInDecade

The number of years contained in the current decade

$yearsInMillennium read-only

public int $yearsInMillennium

The number of years contained in the current millennium

$days

Names of days of the week.

protected static array<string|int, mixed> $days = [ // @call isDayOfWeek \Carbon\CarbonInterface::SUNDAY => 'Sunday', // @call isDayOfWeek \Carbon\CarbonInterface::MONDAY => 'Monday', // @call isDayOfWeek \Carbon\CarbonInterface::TUESDAY => 'Tuesday', // @call isDayOfWeek \Carbon\CarbonInterface::WEDNESDAY => 'Wednesday', // @call isDayOfWeek \Carbon\CarbonInterface::THURSDAY => 'Thursday', // @call isDayOfWeek \Carbon\CarbonInterface::FRIDAY => 'Friday', // @call isDayOfWeek \Carbon\CarbonInterface::SATURDAY => 'Saturday', ]

$units

List of unit and magic methods associated as doc-comments.

protected static array<string|int, mixed> $units = [ // @call setUnit // @call addUnit 'year', // @call setUnit // @call addUnit 'month', // @call setUnit // @call addUnit 'day', // @call setUnit // @call addUnit 'hour', // @call setUnit // @call addUnit 'minute', // @call setUnit // @call addUnit 'second', // @call setUnit // @call addUnit 'milli', // @call setUnit // @call addUnit 'millisecond', // @call setUnit // @call addUnit 'micro', // @call setUnit // @call addUnit 'microsecond', ]

Methods

__call()

Dynamically handle calls to the class.

public __call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string

magic method name called

$parameters : array<string|int, mixed>

parameters list

Tags
throws
UnknownMethodException|BadMethodCallException|ReflectionException|Throwable

__callStatic()

Dynamically handle calls to the class.

public static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string

magic method name called

$parameters : array<string|int, mixed>

parameters list

Tags
throws
BadMethodCallException

__get()

Get a part of the Carbon object.

public __get(string $name) : string|int|bool|DateTimeZone|null
Parameters
$name : string
Tags
throws
UnknownGetterException
Return values
string|int|bool|DateTimeZone|null

__isset()

Check if an attribute exists on the object

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

__set()

Set a part of the Carbon object

public __set(string $name, string|int|DateTimeZone $value) : void
Parameters
$name : string
$value : string|int|DateTimeZone
Tags
throws
UnknownSetterException|ReflectionException

addCenturies()

public addCenturies(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addCenturiesNoOverflow()

public addCenturiesNoOverflow(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addCenturiesWithNoOverflow()

public addCenturiesWithNoOverflow(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addCenturiesWithoutOverflow()

public addCenturiesWithoutOverflow(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addCenturiesWithOverflow()

public addCenturiesWithOverflow(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addCentury()

public addCentury() : $this

Add one century to the instance (using date interval).

Return values
$this

addCenturyNoOverflow()

public addCenturyNoOverflow() : $this

Add one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addCenturyWithNoOverflow()

public addCenturyWithNoOverflow() : $this

Add one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addCenturyWithoutOverflow()

public addCenturyWithoutOverflow() : $this

Add one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addCenturyWithOverflow()

public addCenturyWithOverflow() : $this

Add one century to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

addDay()

public addDay() : $this

Add one day to the instance (using date interval).

Return values
$this

addDays()

public addDays(int|float $value = 1) : $this

Add days (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addDecade()

public addDecade() : $this

Add one decade to the instance (using date interval).

Return values
$this

addDecadeNoOverflow()

public addDecadeNoOverflow() : $this

Add one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addDecades()

public addDecades(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addDecadesNoOverflow()

public addDecadesNoOverflow(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addDecadesWithNoOverflow()

public addDecadesWithNoOverflow(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addDecadesWithoutOverflow()

public addDecadesWithoutOverflow(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addDecadesWithOverflow()

public addDecadesWithOverflow(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addDecadeWithNoOverflow()

public addDecadeWithNoOverflow() : $this

Add one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addDecadeWithoutOverflow()

public addDecadeWithoutOverflow() : $this

Add one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addDecadeWithOverflow()

public addDecadeWithOverflow() : $this

Add one decade to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

addHour()

public addHour() : $this

Add one hour to the instance (using date interval).

Return values
$this

addHours()

public addHours(int|float $value = 1) : $this

Add hours (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMicro()

public addMicro() : $this

Add one microsecond to the instance (using date interval).

Return values
$this

addMicros()

public addMicros(int|float $value = 1) : $this

Add microseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMicrosecond()

public addMicrosecond() : $this

Add one microsecond to the instance (using date interval).

Return values
$this

addMicroseconds()

public addMicroseconds(int|float $value = 1) : $this

Add microseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMillennia()

public addMillennia(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMillenniaNoOverflow()

public addMillenniaNoOverflow(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMillenniaWithNoOverflow()

public addMillenniaWithNoOverflow(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMillenniaWithoutOverflow()

public addMillenniaWithoutOverflow(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMillenniaWithOverflow()

public addMillenniaWithOverflow(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addMillennium()

public addMillennium() : $this

Add one millennium to the instance (using date interval).

Return values
$this

addMillenniumNoOverflow()

public addMillenniumNoOverflow() : $this

Add one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMillenniumWithNoOverflow()

public addMillenniumWithNoOverflow() : $this

Add one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMillenniumWithoutOverflow()

public addMillenniumWithoutOverflow() : $this

Add one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMillenniumWithOverflow()

public addMillenniumWithOverflow() : $this

Add one millennium to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

addMilli()

public addMilli() : $this

Add one millisecond to the instance (using date interval).

Return values
$this

addMillis()

public addMillis(int|float $value = 1) : $this

Add milliseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMillisecond()

public addMillisecond() : $this

Add one millisecond to the instance (using date interval).

Return values
$this

addMilliseconds()

public addMilliseconds(int|float $value = 1) : $this

Add milliseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMinute()

public addMinute() : $this

Add one minute to the instance (using date interval).

Return values
$this

addMinutes()

public addMinutes(int|float $value = 1) : $this

Add minutes (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMonth()

public addMonth() : $this

Add one month to the instance (using date interval).

Return values
$this

addMonthNoOverflow()

public addMonthNoOverflow() : $this

Add one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMonths()

public addMonths(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addMonthsNoOverflow()

public addMonthsNoOverflow(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMonthsWithNoOverflow()

public addMonthsWithNoOverflow(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMonthsWithoutOverflow()

public addMonthsWithoutOverflow(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addMonthsWithOverflow()

public addMonthsWithOverflow(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addMonthWithNoOverflow()

public addMonthWithNoOverflow() : $this

Add one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMonthWithoutOverflow()

public addMonthWithoutOverflow() : $this

Add one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addMonthWithOverflow()

public addMonthWithOverflow() : $this

Add one month to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

addQuarter()

public addQuarter() : $this

Add one quarter to the instance (using date interval).

Return values
$this

addQuarterNoOverflow()

public addQuarterNoOverflow() : $this

Add one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addQuarters()

public addQuarters(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addQuartersNoOverflow()

public addQuartersNoOverflow(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addQuartersWithNoOverflow()

public addQuartersWithNoOverflow(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addQuartersWithoutOverflow()

public addQuartersWithoutOverflow(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addQuartersWithOverflow()

public addQuartersWithOverflow(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addQuarterWithNoOverflow()

public addQuarterWithNoOverflow() : $this

Add one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addQuarterWithoutOverflow()

public addQuarterWithoutOverflow() : $this

Add one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addQuarterWithOverflow()

public addQuarterWithOverflow() : $this

Add one quarter to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

addSecond()

public addSecond() : $this

Add one second to the instance (using date interval).

Return values
$this

addSeconds()

public addSeconds(int|float $value = 1) : $this

Add seconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addUnitNoOverflow()

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

public addUnitNoOverflow(string $valueUnit, int $value, string $overflowUnit) : static
Parameters
$valueUnit : string

unit name to modify

$value : int

amount to add to the input unit

$overflowUnit : string

unit name to not overflow

Return values
static

addUTCCenturies()

public addUTCCenturies(int|float $value = 1) : $this

Add centuries (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCCentury()

public addUTCCentury() : $this

Add one century to the instance (using timestamp).

Return values
$this

addUTCDay()

public addUTCDay() : $this

Add one day to the instance (using timestamp).

Return values
$this

addUTCDays()

public addUTCDays(int|float $value = 1) : $this

Add days (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCDecade()

public addUTCDecade() : $this

Add one decade to the instance (using timestamp).

Return values
$this

addUTCDecades()

public addUTCDecades(int|float $value = 1) : $this

Add decades (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCHour()

public addUTCHour() : $this

Add one hour to the instance (using timestamp).

Return values
$this

addUTCHours()

public addUTCHours(int|float $value = 1) : $this

Add hours (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMicro()

public addUTCMicro() : $this

Add one microsecond to the instance (using timestamp).

Return values
$this

addUTCMicros()

public addUTCMicros(int|float $value = 1) : $this

Add microseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMicrosecond()

public addUTCMicrosecond() : $this

Add one microsecond to the instance (using timestamp).

Return values
$this

addUTCMicroseconds()

public addUTCMicroseconds(int|float $value = 1) : $this

Add microseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMillennia()

public addUTCMillennia(int|float $value = 1) : $this

Add millennia (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMillennium()

public addUTCMillennium() : $this

Add one millennium to the instance (using timestamp).

Return values
$this

addUTCMilli()

public addUTCMilli() : $this

Add one millisecond to the instance (using timestamp).

Return values
$this

addUTCMillis()

public addUTCMillis(int|float $value = 1) : $this

Add milliseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMillisecond()

public addUTCMillisecond() : $this

Add one millisecond to the instance (using timestamp).

Return values
$this

addUTCMilliseconds()

public addUTCMilliseconds(int|float $value = 1) : $this

Add milliseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMinute()

public addUTCMinute() : $this

Add one minute to the instance (using timestamp).

Return values
$this

addUTCMinutes()

public addUTCMinutes(int|float $value = 1) : $this

Add minutes (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCMonth()

public addUTCMonth() : $this

Add one month to the instance (using timestamp).

Return values
$this

addUTCMonths()

public addUTCMonths(int|float $value = 1) : $this

Add months (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCQuarter()

public addUTCQuarter() : $this

Add one quarter to the instance (using timestamp).

Return values
$this

addUTCQuarters()

public addUTCQuarters(int|float $value = 1) : $this

Add quarters (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCSecond()

public addUTCSecond() : $this

Add one second to the instance (using timestamp).

Return values
$this

addUTCSeconds()

public addUTCSeconds(int|float $value = 1) : $this

Add seconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCWeek()

public addUTCWeek() : $this

Add one week to the instance (using timestamp).

Return values
$this

addUTCWeeks()

public addUTCWeeks(int|float $value = 1) : $this

Add weeks (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addUTCYear()

public addUTCYear() : $this

Add one year to the instance (using timestamp).

Return values
$this

addUTCYears()

public addUTCYears(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

addWeek()

public addWeek() : $this

Add one week to the instance (using date interval).

Return values
$this

addWeekday()

public addWeekday() : $this

Add one weekday to the instance (using date interval).

Return values
$this

addWeekdays()

public addWeekdays(int|float $value = 1) : $this

Add weekdays (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addWeeks()

public addWeeks(int|float $value = 1) : $this

Add weeks (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addYear()

public addYear() : $this

Add one year to the instance (using date interval).

Return values
$this

addYearNoOverflow()

public addYearNoOverflow() : $this

Add one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addYears()

public addYears(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

addYearsNoOverflow()

public addYearsNoOverflow(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addYearsWithNoOverflow()

public addYearsWithNoOverflow(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addYearsWithoutOverflow()

public addYearsWithoutOverflow(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

addYearsWithOverflow()

public addYearsWithOverflow(int|float $value = 1) : $this

Add years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

addYearWithNoOverflow()

public addYearWithNoOverflow() : $this

Add one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addYearWithoutOverflow()

public addYearWithoutOverflow() : $this

Add one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

addYearWithOverflow()

public addYearWithOverflow() : $this

Add one year to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

avoidMutation()

Clone the current instance if it's mutable.

public avoidMutation() : static

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.

Return values
static

carbonize()

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

public carbonize([Carbon|CarbonPeriod|CarbonInterval|DateInterval|DatePeriod|DateTimeInterface|string|null $date = null ]) : static
Parameters
$date : Carbon|CarbonPeriod|CarbonInterval|DateInterval|DatePeriod|DateTimeInterface|string|null = null
Return values
static

ceilCenturies()

public ceilCenturies(float $precision = 1) : $this

Ceil the current instance century with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilCentury()

public ceilCentury(float $precision = 1) : $this

Ceil the current instance century with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilDay()

public ceilDay(float $precision = 1) : $this

Ceil the current instance day with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilDays()

public ceilDays(float $precision = 1) : $this

Ceil the current instance day with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilDecade()

public ceilDecade(float $precision = 1) : $this

Ceil the current instance decade with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilDecades()

public ceilDecades(float $precision = 1) : $this

Ceil the current instance decade with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilHour()

public ceilHour(float $precision = 1) : $this

Ceil the current instance hour with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilHours()

public ceilHours(float $precision = 1) : $this

Ceil the current instance hour with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMicrosecond()

public ceilMicrosecond(float $precision = 1) : $this

Ceil the current instance microsecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMicroseconds()

public ceilMicroseconds(float $precision = 1) : $this

Ceil the current instance microsecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMillennia()

public ceilMillennia(float $precision = 1) : $this

Ceil the current instance millennium with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMillennium()

public ceilMillennium(float $precision = 1) : $this

Ceil the current instance millennium with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMillisecond()

public ceilMillisecond(float $precision = 1) : $this

Ceil the current instance millisecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMilliseconds()

public ceilMilliseconds(float $precision = 1) : $this

Ceil the current instance millisecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMinute()

public ceilMinute(float $precision = 1) : $this

Ceil the current instance minute with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMinutes()

public ceilMinutes(float $precision = 1) : $this

Ceil the current instance minute with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMonth()

public ceilMonth(float $precision = 1) : $this

Ceil the current instance month with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilMonths()

public ceilMonths(float $precision = 1) : $this

Ceil the current instance month with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilQuarter()

public ceilQuarter(float $precision = 1) : $this

Ceil the current instance quarter with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilQuarters()

public ceilQuarters(float $precision = 1) : $this

Ceil the current instance quarter with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilSecond()

public ceilSecond(float $precision = 1) : $this

Ceil the current instance second with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilSeconds()

public ceilSeconds(float $precision = 1) : $this

Ceil the current instance second with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilYear()

public ceilYear(float $precision = 1) : $this

Ceil the current instance year with given precision.

Parameters
$precision = 1 : float
Return values
$this

ceilYears()

public ceilYears(float $precision = 1) : $this

Ceil the current instance year with given precision.

Parameters
$precision = 1 : float
Return values
$this

centuriesInMillennium()

public centuriesInMillennium() : int

Return the number of centuries contained in the current millennium

Return values
int

centuriesUntil()

public centuriesUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

centuryOfMillennium()

public centuryOfMillennium(int|null $century = null) : 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

Parameters
$century = null : int|null
Return values
int|static

clone()

public clone() : static
Tags
alias

copy

Get a copy of the instance.

Return values
static

copy()

Get a copy of the instance.

public copy() : static
Return values
static

day()

public day(int $value) : $this

Set current instance day to the given value.

Parameters
$value : int
Return values
$this

dayOfCentury()

public dayOfCentury(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfDecade()

public dayOfDecade(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfMillennium()

public dayOfMillennium(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfMonth()

public dayOfMonth(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfQuarter()

public dayOfQuarter(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfWeek()

public dayOfWeek(int|null $day = null) : 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

Parameters
$day = null : int|null
Return values
int|static

dayOfYear()

Get/set the day of year.

public dayOfYear([int|null $value = null ]) : static|int
Parameters
$value : int|null = null

new value for day of year if using as setter.

Tags
template

T of int|null

psalm-param

T $value

psalm-return

(T is int ? static : int)

Return values
static|int

days()

public days(int $value) : $this

Set current instance day to the given value.

Parameters
$value : int
Return values
$this

daysInCentury()

public daysInCentury() : int

Return the number of days contained in the current century

Return values
int

daysInDecade()

public daysInDecade() : int

Return the number of days contained in the current decade

Return values
int

daysInMillennium()

public daysInMillennium() : int

Return the number of days contained in the current millennium

Return values
int

daysInMonth()

public daysInMonth() : int

Return the number of days contained in the current month

Return values
int

daysInQuarter()

public daysInQuarter() : int

Return the number of days contained in the current quarter

Return values
int

daysInWeek()

public daysInWeek() : int

Return the number of days contained in the current week

Return values
int

daysInYear()

public daysInYear() : int

Return the number of days contained in the current year

Return values
int

daysUntil()

public daysUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

decadeOfCentury()

public decadeOfCentury(int|null $decade = null) : 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

Parameters
$decade = null : int|null
Return values
int|static

decadeOfMillennium()

public decadeOfMillennium(int|null $decade = null) : 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

Parameters
$decade = null : int|null
Return values
int|static

decadesInCentury()

public decadesInCentury() : int

Return the number of decades contained in the current century

Return values
int

decadesInMillennium()

public decadesInMillennium() : int

Return the number of decades contained in the current millennium

Return values
int

decadesUntil()

public decadesUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

diffInUTCCenturies()

public diffInUTCCenturies(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCDays()

public diffInUTCDays(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCDecades()

public diffInUTCDecades(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCHours()

public diffInUTCHours(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMicros()

public diffInUTCMicros(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMicroseconds()

public diffInUTCMicroseconds(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMillennia()

public diffInUTCMillennia(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMillis()

public diffInUTCMillis(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMilliseconds()

public diffInUTCMilliseconds(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMinutes()

public diffInUTCMinutes(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCMonths()

public diffInUTCMonths(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCQuarters()

public diffInUTCQuarters(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCSeconds()

public diffInUTCSeconds(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCWeeks()

public diffInUTCWeeks(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

diffInUTCYears()

public diffInUTCYears(DateTimeInterface|string|null $date, bool $absolute = false) : float

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

Parameters
$date : DateTimeInterface|string|null
$absolute = false : bool
Return values
float

floorCenturies()

public floorCenturies(float $precision = 1) : $this

Truncate the current instance century with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorCentury()

public floorCentury(float $precision = 1) : $this

Truncate the current instance century with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorDay()

public floorDay(float $precision = 1) : $this

Truncate the current instance day with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorDays()

public floorDays(float $precision = 1) : $this

Truncate the current instance day with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorDecade()

public floorDecade(float $precision = 1) : $this

Truncate the current instance decade with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorDecades()

public floorDecades(float $precision = 1) : $this

Truncate the current instance decade with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorHour()

public floorHour(float $precision = 1) : $this

Truncate the current instance hour with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorHours()

public floorHours(float $precision = 1) : $this

Truncate the current instance hour with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMicrosecond()

public floorMicrosecond(float $precision = 1) : $this

Truncate the current instance microsecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMicroseconds()

public floorMicroseconds(float $precision = 1) : $this

Truncate the current instance microsecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMillennia()

public floorMillennia(float $precision = 1) : $this

Truncate the current instance millennium with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMillennium()

public floorMillennium(float $precision = 1) : $this

Truncate the current instance millennium with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMillisecond()

public floorMillisecond(float $precision = 1) : $this

Truncate the current instance millisecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMilliseconds()

public floorMilliseconds(float $precision = 1) : $this

Truncate the current instance millisecond with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMinute()

public floorMinute(float $precision = 1) : $this

Truncate the current instance minute with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMinutes()

public floorMinutes(float $precision = 1) : $this

Truncate the current instance minute with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMonth()

public floorMonth(float $precision = 1) : $this

Truncate the current instance month with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorMonths()

public floorMonths(float $precision = 1) : $this

Truncate the current instance month with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorQuarter()

public floorQuarter(float $precision = 1) : $this

Truncate the current instance quarter with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorQuarters()

public floorQuarters(float $precision = 1) : $this

Truncate the current instance quarter with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorSecond()

public floorSecond(float $precision = 1) : $this

Truncate the current instance second with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorSeconds()

public floorSeconds(float $precision = 1) : $this

Truncate the current instance second with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorYear()

public floorYear(float $precision = 1) : $this

Truncate the current instance year with given precision.

Parameters
$precision = 1 : float
Return values
$this

floorYears()

public floorYears(float $precision = 1) : $this

Truncate the current instance year with given precision.

Parameters
$precision = 1 : float
Return values
$this

get()

Get a part of the Carbon object.

public get(Unit|string $name) : string|int|bool|DateTimeZone
Parameters
$name : Unit|string
Tags
throws
UnknownGetterException
Return values
string|int|bool|DateTimeZone

getAltNumber()

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

public getAltNumber(string $key) : string
Parameters
$key : string

date property

Return values
string

getCalendarFormats()

Returns list of calendar formats for ISO formatting.

public getCalendarFormats([string|null $locale = null ]) : array<string|int, mixed>
Parameters
$locale : string|null = null

current locale used if null

Return values
array<string|int, mixed>

getDays()

Get the days of the week.

public static getDays() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDaysFromStartOfWeek()

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

public getDaysFromStartOfWeek([WeekDay|int|null $weekStartsAt = null ]) : int
Parameters
$weekStartsAt : WeekDay|int|null = null

optional start allow you to specify the day of week to use to start the week, if not provided, start of week is inferred from the locale (Sunday for en_US, Monday for de_DE, etc.)

Return values
int

getFormatsToIsoReplacements()

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

public static getFormatsToIsoReplacements() : array<string|int, mixed>
Return values
array<string|int, mixed>

getIsoFormats()

Returns list of locale formats for ISO formatting.

public getIsoFormats([string|null $locale = null ]) : array<string|int, mixed>
Parameters
$locale : string|null = null

current locale used if null

Return values
array<string|int, mixed>

getIsoUnits()

Returns list of locale units for ISO formatting.

public static getIsoUnits() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOffsetString()

Returns the offset hour and minute formatted with +/- and a given separator (":" by default).

public getOffsetString([string $separator = ':' ]) : string

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

Parameters
$separator : string = ':'

string to place between hours and minutes (":" by default)

Return values
string

getPaddedUnit()

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

public getPaddedUnit(string $unit[, int $length = 2 ][, string $padString = '0' ][, int $padType = STR_PAD_LEFT ]) : string
Parameters
$unit : string

Carbon unit name

$length : int = 2

Length of the output (2 by default)

$padString : string = '0'

String to use for padding ("0" by default)

$padType : int = STR_PAD_LEFT

Side(s) to pad (STR_PAD_LEFT by default)

Return values
string

getTranslatedDayName()

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

public getTranslatedDayName([string|null $context = null ][, string $keySuffix = '' ][, string|null $defaultValue = null ]) : string
Parameters
$context : string|null = null

whole format string

$keySuffix : string = ''

"", "_short" or "_min"

$defaultValue : string|null = null

default value if translation missing

Return values
string

getTranslatedMinDayName()

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

public getTranslatedMinDayName([string|null $context = null ]) : string
Parameters
$context : string|null = null

whole format string

Return values
string

getTranslatedMonthName()

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

public getTranslatedMonthName([string|null $context = null ][, string $keySuffix = '' ][, string|null $defaultValue = null ]) : string
Parameters
$context : string|null = null

whole format string

$keySuffix : string = ''

"" or "_short"

$defaultValue : string|null = null

default value if translation missing

Return values
string

getTranslatedShortDayName()

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

public getTranslatedShortDayName([string|null $context = null ]) : string
Parameters
$context : string|null = null

whole format string

Return values
string

getTranslatedShortMonthName()

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

public getTranslatedShortMonthName([string|null $context = null ]) : string
Parameters
$context : string|null = null

whole format string

Return values
string

getWeekendDays()

Get weekend days

public static getWeekendDays() : array<string|int, mixed>
Return values
array<string|int, mixed>

getWeekEndsAt()

Get the last day of week.

public static getWeekEndsAt([string $locale = null ]) : int
Parameters
$locale : string = null

local to consider the last day of week.

Return values
int

getWeekStartsAt()

Get the first day of week.

public static getWeekStartsAt([string|null $locale = null ]) : int
Parameters
$locale : string|null = null
Return values
int

hasRelativeKeywords()

Determine if a time string will produce a relative date.

public static hasRelativeKeywords(string|null $time) : bool
Parameters
$time : string|null
Return values
bool

true if time match a relative date, false if absolute or invalid time string

hour()

public hour(int $value) : $this

Set current instance hour to the given value.

Parameters
$value : int
Return values
$this

hourOfCentury()

public hourOfCentury(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfDay()

public hourOfDay(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfDecade()

public hourOfDecade(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfMillennium()

public hourOfMillennium(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfMonth()

public hourOfMonth(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfQuarter()

public hourOfQuarter(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfWeek()

public hourOfWeek(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hourOfYear()

public hourOfYear(int|null $hour = null) : 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

Parameters
$hour = null : int|null
Return values
int|static

hours()

public hours(int $value) : $this

Set current instance hour to the given value.

Parameters
$value : int
Return values
$this

hoursInCentury()

public hoursInCentury() : int

Return the number of hours contained in the current century

Return values
int

hoursInDay()

public hoursInDay() : int

Return the number of hours contained in the current day

Return values
int

hoursInDecade()

public hoursInDecade() : int

Return the number of hours contained in the current decade

Return values
int

hoursInMillennium()

public hoursInMillennium() : int

Return the number of hours contained in the current millennium

Return values
int

hoursInMonth()

public hoursInMonth() : int

Return the number of hours contained in the current month

Return values
int

hoursInQuarter()

public hoursInQuarter() : int

Return the number of hours contained in the current quarter

Return values
int

hoursInWeek()

public hoursInWeek() : int

Return the number of hours contained in the current week

Return values
int

hoursInYear()

public hoursInYear() : int

Return the number of hours contained in the current year

Return values
int

hoursUntil()

public hoursUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

isCurrentCentury()

public isCurrentCentury() : bool

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

Return values
bool

isCurrentDay()

public isCurrentDay() : bool

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

Return values
bool

isCurrentDecade()

public isCurrentDecade() : bool

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

Return values
bool

isCurrentHour()

public isCurrentHour() : bool

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

Return values
bool

isCurrentMicro()

public isCurrentMicro() : bool

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

Return values
bool

isCurrentMicrosecond()

public isCurrentMicrosecond() : bool

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

Return values
bool

isCurrentMillennium()

public isCurrentMillennium() : bool

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

Return values
bool

isCurrentMilli()

public isCurrentMilli() : bool

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

Return values
bool

isCurrentMillisecond()

public isCurrentMillisecond() : bool

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

Return values
bool

isCurrentMinute()

public isCurrentMinute() : bool

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

Return values
bool

isCurrentMonth()

public isCurrentMonth() : bool

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

Return values
bool

isCurrentQuarter()

public isCurrentQuarter() : bool

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

Return values
bool

isCurrentSecond()

public isCurrentSecond() : bool

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

Return values
bool

isCurrentWeek()

public isCurrentWeek() : bool

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

Return values
bool

isCurrentYear()

public isCurrentYear() : bool

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

Return values
bool

isDST()

public isDST() : bool

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

Return values
bool

isFriday()

public isFriday() : bool

Checks if the instance day is friday.

Return values
bool

isLastCentury()

public isLastCentury() : bool

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

Return values
bool

isLastDay()

public isLastDay() : bool

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

Return values
bool

isLastDecade()

public isLastDecade() : bool

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

Return values
bool

isLastHour()

public isLastHour() : bool

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

Return values
bool

isLastMicro()

public isLastMicro() : bool

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

Return values
bool

isLastMicrosecond()

public isLastMicrosecond() : bool

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

Return values
bool

isLastMillennium()

public isLastMillennium() : bool

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

Return values
bool

isLastMilli()

public isLastMilli() : bool

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

Return values
bool

isLastMillisecond()

public isLastMillisecond() : bool

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

Return values
bool

isLastMinute()

public isLastMinute() : bool

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

Return values
bool

isLastMonth()

public isLastMonth() : bool

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

Return values
bool

isLastQuarter()

public isLastQuarter() : bool

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

Return values
bool

isLastSecond()

public isLastSecond() : bool

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

Return values
bool

isLastWeek()

public isLastWeek() : bool

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

Return values
bool

isLastYear()

public isLastYear() : bool

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

Return values
bool

isLocal()

public isLocal() : bool

Check if the current instance has non-UTC timezone.

Return values
bool

isMonday()

public isMonday() : bool

Checks if the instance day is monday.

Return values
bool

isMutable()

Returns true if the current class/instance is mutable.

public static isMutable() : bool
Return values
bool

isNextCentury()

public isNextCentury() : bool

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

Return values
bool

isNextDay()

public isNextDay() : bool

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

Return values
bool

isNextDecade()

public isNextDecade() : bool

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

Return values
bool

isNextHour()

public isNextHour() : bool

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

Return values
bool

isNextMicro()

public isNextMicro() : bool

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

Return values
bool

isNextMicrosecond()

public isNextMicrosecond() : bool

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

Return values
bool

isNextMillennium()

public isNextMillennium() : bool

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

Return values
bool

isNextMilli()

public isNextMilli() : bool

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

Return values
bool

isNextMillisecond()

public isNextMillisecond() : bool

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

Return values
bool

isNextMinute()

public isNextMinute() : bool

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

Return values
bool

isNextMonth()

public isNextMonth() : bool

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

Return values
bool

isNextQuarter()

public isNextQuarter() : bool

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

Return values
bool

isNextSecond()

public isNextSecond() : bool

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

Return values
bool

isNextWeek()

public isNextWeek() : bool

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

Return values
bool

isNextYear()

public isNextYear() : bool

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

Return values
bool

isoFormat()

Format in the current language using ISO replacement patterns.

public isoFormat(string $format[, string|null $originalFormat = null ]) : string
Parameters
$format : string
$originalFormat : string|null = null

provide context if a chunk has been passed alone

Return values
string

isoWeekday()

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

public isoWeekday([WeekDay|int|null $value = null ]) : static|int
Parameters
$value : WeekDay|int|null = null

new value for weekday if using as setter.

Return values
static|int

isSameCentury()

public isSameCentury(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameDay()

public isSameDay(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameDecade()

public isSameDecade(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameHour()

public isSameHour(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMicro()

public isSameMicro(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMicrosecond()

public isSameMicrosecond(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMillennium()

public isSameMillennium(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMilli()

public isSameMilli(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMillisecond()

public isSameMillisecond(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameMinute()

public isSameMinute(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameSecond()

public isSameSecond(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameWeek()

public isSameWeek(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSameYear()

public isSameYear(DateTimeInterface|string $date) : bool

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

Parameters
$date : DateTimeInterface|string
Return values
bool

isSaturday()

public isSaturday() : bool

Checks if the instance day is saturday.

Return values
bool

isSunday()

public isSunday() : bool

Checks if the instance day is sunday.

Return values
bool

isThursday()

public isThursday() : bool

Checks if the instance day is thursday.

Return values
bool

isTuesday()

public isTuesday() : bool

Checks if the instance day is tuesday.

Return values
bool

isUtc()

public isUtc() : bool

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

Return values
bool

isValid()

public isValid() : bool

Check if the current instance is a valid date.

Return values
bool

isWednesday()

public isWednesday() : bool

Checks if the instance day is wednesday.

Return values
bool

longAbsoluteDiffForHumans()

public longAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

longRelativeDiffForHumans()

public longRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

longRelativeToNowDiffForHumans()

public longRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

longRelativeToOtherDiffForHumans()

public longRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

meridiem()

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

public meridiem([bool $isLower = false ]) : string
Parameters
$isLower : bool = false

if true, returns lowercase variant if available in the current locale.

Return values
string

micro()

public micro(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

micros()

public micros(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

microsecond()

public microsecond(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

microsecondOfCentury()

public microsecondOfCentury(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfDay()

public microsecondOfDay(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfDecade()

public microsecondOfDecade(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfHour()

public microsecondOfHour(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfMillennium()

public microsecondOfMillennium(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfMillisecond()

public microsecondOfMillisecond(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfMinute()

public microsecondOfMinute(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfMonth()

public microsecondOfMonth(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfQuarter()

public microsecondOfQuarter(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfSecond()

public microsecondOfSecond(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfWeek()

public microsecondOfWeek(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microsecondOfYear()

public microsecondOfYear(int|null $microsecond = null) : 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

Parameters
$microsecond = null : int|null
Return values
int|static

microseconds()

public microseconds(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

microsecondsInCentury()

public microsecondsInCentury() : int

Return the number of microseconds contained in the current century

Return values
int

microsecondsInDay()

public microsecondsInDay() : int

Return the number of microseconds contained in the current day

Return values
int

microsecondsInDecade()

public microsecondsInDecade() : int

Return the number of microseconds contained in the current decade

Return values
int

microsecondsInHour()

public microsecondsInHour() : int

Return the number of microseconds contained in the current hour

Return values
int

microsecondsInMillennium()

public microsecondsInMillennium() : int

Return the number of microseconds contained in the current millennium

Return values
int

microsecondsInMillisecond()

public microsecondsInMillisecond() : int

Return the number of microseconds contained in the current millisecond

Return values
int

microsecondsInMinute()

public microsecondsInMinute() : int

Return the number of microseconds contained in the current minute

Return values
int

microsecondsInMonth()

public microsecondsInMonth() : int

Return the number of microseconds contained in the current month

Return values
int

microsecondsInQuarter()

public microsecondsInQuarter() : int

Return the number of microseconds contained in the current quarter

Return values
int

microsecondsInSecond()

public microsecondsInSecond() : int

Return the number of microseconds contained in the current second

Return values
int

microsecondsInWeek()

public microsecondsInWeek() : int

Return the number of microseconds contained in the current week

Return values
int

microsecondsInYear()

public microsecondsInYear() : int

Return the number of microseconds contained in the current year

Return values
int

microsecondsUntil()

public microsecondsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

microsUntil()

public microsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

millenniaUntil()

public millenniaUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

milli()

public milli(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

millis()

public millis(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

millisecond()

public millisecond(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

millisecondOfCentury()

public millisecondOfCentury(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfDay()

public millisecondOfDay(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfDecade()

public millisecondOfDecade(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfHour()

public millisecondOfHour(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfMillennium()

public millisecondOfMillennium(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfMinute()

public millisecondOfMinute(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfMonth()

public millisecondOfMonth(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfQuarter()

public millisecondOfQuarter(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfSecond()

public millisecondOfSecond(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfWeek()

public millisecondOfWeek(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

millisecondOfYear()

public millisecondOfYear(int|null $millisecond = null) : 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

Parameters
$millisecond = null : int|null
Return values
int|static

milliseconds()

public milliseconds(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

millisecondsInCentury()

public millisecondsInCentury() : int

Return the number of milliseconds contained in the current century

Return values
int

millisecondsInDay()

public millisecondsInDay() : int

Return the number of milliseconds contained in the current day

Return values
int

millisecondsInDecade()

public millisecondsInDecade() : int

Return the number of milliseconds contained in the current decade

Return values
int

millisecondsInHour()

public millisecondsInHour() : int

Return the number of milliseconds contained in the current hour

Return values
int

millisecondsInMillennium()

public millisecondsInMillennium() : int

Return the number of milliseconds contained in the current millennium

Return values
int

millisecondsInMinute()

public millisecondsInMinute() : int

Return the number of milliseconds contained in the current minute

Return values
int

millisecondsInMonth()

public millisecondsInMonth() : int

Return the number of milliseconds contained in the current month

Return values
int

millisecondsInQuarter()

public millisecondsInQuarter() : int

Return the number of milliseconds contained in the current quarter

Return values
int

millisecondsInSecond()

public millisecondsInSecond() : int

Return the number of milliseconds contained in the current second

Return values
int

millisecondsInWeek()

public millisecondsInWeek() : int

Return the number of milliseconds contained in the current week

Return values
int

millisecondsInYear()

public millisecondsInYear() : int

Return the number of milliseconds contained in the current year

Return values
int

millisecondsUntil()

public millisecondsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

millisUntil()

public millisUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

minute()

public minute(int $value) : $this

Set current instance minute to the given value.

Parameters
$value : int
Return values
$this

minuteOfCentury()

public minuteOfCentury(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfDay()

public minuteOfDay(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfDecade()

public minuteOfDecade(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfHour()

public minuteOfHour(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfMillennium()

public minuteOfMillennium(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfMonth()

public minuteOfMonth(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfQuarter()

public minuteOfQuarter(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfWeek()

public minuteOfWeek(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minuteOfYear()

public minuteOfYear(int|null $minute = null) : 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

Parameters
$minute = null : int|null
Return values
int|static

minutes()

public minutes(int $value) : $this

Set current instance minute to the given value.

Parameters
$value : int
Return values
$this

minutesInCentury()

public minutesInCentury() : int

Return the number of minutes contained in the current century

Return values
int

minutesInDay()

public minutesInDay() : int

Return the number of minutes contained in the current day

Return values
int

minutesInDecade()

public minutesInDecade() : int

Return the number of minutes contained in the current decade

Return values
int

minutesInHour()

public minutesInHour() : int

Return the number of minutes contained in the current hour

Return values
int

minutesInMillennium()

public minutesInMillennium() : int

Return the number of minutes contained in the current millennium

Return values
int

minutesInMonth()

public minutesInMonth() : int

Return the number of minutes contained in the current month

Return values
int

minutesInQuarter()

public minutesInQuarter() : int

Return the number of minutes contained in the current quarter

Return values
int

minutesInWeek()

public minutesInWeek() : int

Return the number of minutes contained in the current week

Return values
int

minutesInYear()

public minutesInYear() : int

Return the number of minutes contained in the current year

Return values
int

minutesUntil()

public minutesUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

month()

public month(Month|int $value) : $this

Set current instance month to the given value.

Parameters
$value : Month|int
Return values
$this

monthOfCentury()

public monthOfCentury(int|null $month = null) : 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

Parameters
$month = null : int|null
Return values
int|static

monthOfDecade()

public monthOfDecade(int|null $month = null) : 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

Parameters
$month = null : int|null
Return values
int|static

monthOfMillennium()

public monthOfMillennium(int|null $month = null) : 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

Parameters
$month = null : int|null
Return values
int|static

monthOfQuarter()

public monthOfQuarter(int|null $month = null) : 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

Parameters
$month = null : int|null
Return values
int|static

monthOfYear()

public monthOfYear(int|null $month = null) : 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

Parameters
$month = null : int|null
Return values
int|static

months()

public months(Month|int $value) : $this

Set current instance month to the given value.

Parameters
$value : Month|int
Return values
$this

monthsInCentury()

public monthsInCentury() : int

Return the number of months contained in the current century

Return values
int

monthsInDecade()

public monthsInDecade() : int

Return the number of months contained in the current decade

Return values
int

monthsInMillennium()

public monthsInMillennium() : int

Return the number of months contained in the current millennium

Return values
int

monthsInQuarter()

public monthsInQuarter() : int

Return the number of months contained in the current quarter

Return values
int

monthsInYear()

public monthsInYear() : int

Return the number of months contained in the current year

Return values
int

monthsUntil()

public monthsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

nowWithSameTz()

Returns a present instance in the same timezone.

public nowWithSameTz() : static
Return values
static

ordinal()

Return a property with its ordinal.

public ordinal(string $key[, string|null $period = null ]) : string
Parameters
$key : string
$period : string|null = null
Return values
string

pluralUnit()

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

public static pluralUnit(string $unit) : string
Parameters
$unit : string
Return values
string

quarterOfCentury()

public quarterOfCentury(int|null $quarter = null) : 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

Parameters
$quarter = null : int|null
Return values
int|static

quarterOfDecade()

public quarterOfDecade(int|null $quarter = null) : 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

Parameters
$quarter = null : int|null
Return values
int|static

quarterOfMillennium()

public quarterOfMillennium(int|null $quarter = null) : 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

Parameters
$quarter = null : int|null
Return values
int|static

quarterOfYear()

public quarterOfYear(int|null $quarter = null) : 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

Parameters
$quarter = null : int|null
Return values
int|static

quartersInCentury()

public quartersInCentury() : int

Return the number of quarters contained in the current century

Return values
int

quartersInDecade()

public quartersInDecade() : int

Return the number of quarters contained in the current decade

Return values
int

quartersInMillennium()

public quartersInMillennium() : int

Return the number of quarters contained in the current millennium

Return values
int

quartersInYear()

public quartersInYear() : int

Return the number of quarters contained in the current year

Return values
int

quartersUntil()

public quartersUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

roundCenturies()

public roundCenturies(float $precision = 1, string $function = "round") : $this

Round the current instance century with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundCentury()

public roundCentury(float $precision = 1, string $function = "round") : $this

Round the current instance century with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundDay()

public roundDay(float $precision = 1, string $function = "round") : $this

Round the current instance day with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundDays()

public roundDays(float $precision = 1, string $function = "round") : $this

Round the current instance day with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundDecade()

public roundDecade(float $precision = 1, string $function = "round") : $this

Round the current instance decade with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundDecades()

public roundDecades(float $precision = 1, string $function = "round") : $this

Round the current instance decade with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundHour()

public roundHour(float $precision = 1, string $function = "round") : $this

Round the current instance hour with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundHours()

public roundHours(float $precision = 1, string $function = "round") : $this

Round the current instance hour with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMicrosecond()

public roundMicrosecond(float $precision = 1, string $function = "round") : $this

Round the current instance microsecond with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMicroseconds()

public roundMicroseconds(float $precision = 1, string $function = "round") : $this

Round the current instance microsecond with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMillennia()

public roundMillennia(float $precision = 1, string $function = "round") : $this

Round the current instance millennium with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMillennium()

public roundMillennium(float $precision = 1, string $function = "round") : $this

Round the current instance millennium with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMillisecond()

public roundMillisecond(float $precision = 1, string $function = "round") : $this

Round the current instance millisecond with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMilliseconds()

public roundMilliseconds(float $precision = 1, string $function = "round") : $this

Round the current instance millisecond with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMinute()

public roundMinute(float $precision = 1, string $function = "round") : $this

Round the current instance minute with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMinutes()

public roundMinutes(float $precision = 1, string $function = "round") : $this

Round the current instance minute with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMonth()

public roundMonth(float $precision = 1, string $function = "round") : $this

Round the current instance month with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundMonths()

public roundMonths(float $precision = 1, string $function = "round") : $this

Round the current instance month with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundQuarter()

public roundQuarter(float $precision = 1, string $function = "round") : $this

Round the current instance quarter with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundQuarters()

public roundQuarters(float $precision = 1, string $function = "round") : $this

Round the current instance quarter with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundSecond()

public roundSecond(float $precision = 1, string $function = "round") : $this

Round the current instance second with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundSeconds()

public roundSeconds(float $precision = 1, string $function = "round") : $this

Round the current instance second with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundYear()

public roundYear(float $precision = 1, string $function = "round") : $this

Round the current instance year with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

roundYears()

public roundYears(float $precision = 1, string $function = "round") : $this

Round the current instance year with given precision using the given function.

Parameters
$precision = 1 : float
$function = "round" : string
Return values
$this

second()

public second(int $value) : $this

Set current instance second to the given value.

Parameters
$value : int
Return values
$this

secondOfCentury()

public secondOfCentury(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfDay()

public secondOfDay(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfDecade()

public secondOfDecade(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfHour()

public secondOfHour(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfMillennium()

public secondOfMillennium(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfMinute()

public secondOfMinute(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfMonth()

public secondOfMonth(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfQuarter()

public secondOfQuarter(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfWeek()

public secondOfWeek(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

secondOfYear()

public secondOfYear(int|null $second = null) : 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

Parameters
$second = null : int|null
Return values
int|static

seconds()

public seconds(int $value) : $this

Set current instance second to the given value.

Parameters
$value : int
Return values
$this

secondsInCentury()

public secondsInCentury() : int

Return the number of seconds contained in the current century

Return values
int

secondsInDay()

public secondsInDay() : int

Return the number of seconds contained in the current day

Return values
int

secondsInDecade()

public secondsInDecade() : int

Return the number of seconds contained in the current decade

Return values
int

secondsInHour()

public secondsInHour() : int

Return the number of seconds contained in the current hour

Return values
int

secondsInMillennium()

public secondsInMillennium() : int

Return the number of seconds contained in the current millennium

Return values
int

secondsInMinute()

public secondsInMinute() : int

Return the number of seconds contained in the current minute

Return values
int

secondsInMonth()

public secondsInMonth() : int

Return the number of seconds contained in the current month

Return values
int

secondsInQuarter()

public secondsInQuarter() : int

Return the number of seconds contained in the current quarter

Return values
int

secondsInWeek()

public secondsInWeek() : int

Return the number of seconds contained in the current week

Return values
int

secondsInYear()

public secondsInYear() : int

Return the number of seconds contained in the current year

Return values
int

secondsUntil()

public secondsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

set()

Set a part of the Carbon object.

public set(Unit|array<string|int, mixed>|string $name[, DateTimeZone|Month|string|int|float|null $value = null ]) : $this
Parameters
$name : Unit|array<string|int, mixed>|string
$value : DateTimeZone|Month|string|int|float|null = null
Tags
throws
ImmutableException|UnknownSetterException
Return values
$this

setDateFrom()

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

public setDateFrom(DateTimeInterface|string $date) : static
Parameters
$date : DateTimeInterface|string
Return values
static

setDateTime()

Set the date and time all together.

public setDateTime(int $year, int $month, int $day, int $hour, int $minute[, int $second = 0 ][, int $microseconds = 0 ]) : static
Parameters
$year : int
$month : int
$day : int
$hour : int
$minute : int
$second : int = 0
$microseconds : int = 0
Return values
static

setDateTimeFrom()

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

public setDateTimeFrom(DateTimeInterface|string $date) : static
Parameters
$date : DateTimeInterface|string
Return values
static

setDay()

public setDay(int $value) : $this

Set current instance day to the given value.

Parameters
$value : int
Return values
$this

setDays()

public setDays(int $value) : $this

Set current instance day to the given value.

Parameters
$value : int
Return values
$this

setDaysFromStartOfWeek()

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

public setDaysFromStartOfWeek(int $numberOfDays[, WeekDay|int|null $weekStartsAt = null ]) : static
Parameters
$numberOfDays : int

number of days to add after the start of the current week

$weekStartsAt : WeekDay|int|null = null

optional start allow you to specify the day of week to use to start the week, if not provided, start of week is inferred from the locale (Sunday for en_US, Monday for de_DE, etc.)

Return values
static

setHour()

public setHour(int $value) : $this

Set current instance hour to the given value.

Parameters
$value : int
Return values
$this

setHours()

public setHours(int $value) : $this

Set current instance hour to the given value.

Parameters
$value : int
Return values
$this

setISODate()

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

public setISODate(int $year, int $week[, int $day = 1 ]) : static
Parameters
$year : int
$week : int
$day : int = 1
Tags
see
https://php.net/manual/en/datetime.setisodate.php
Return values
static

setMicro()

public setMicro(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

setMicros()

public setMicros(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

setMicrosecond()

public setMicrosecond(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

setMicroseconds()

public setMicroseconds(int $value) : $this

Set current instance microsecond to the given value.

Parameters
$value : int
Return values
$this

setMilli()

public setMilli(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

setMillis()

public setMillis(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

setMillisecond()

public setMillisecond(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

setMilliseconds()

public setMilliseconds(int $value) : $this

Set current instance millisecond to the given value.

Parameters
$value : int
Return values
$this

setMinute()

public setMinute(int $value) : $this

Set current instance minute to the given value.

Parameters
$value : int
Return values
$this

setMinutes()

public setMinutes(int $value) : $this

Set current instance minute to the given value.

Parameters
$value : int
Return values
$this

setMonth()

public setMonth(Month|int $value) : $this

Set current instance month to the given value.

Parameters
$value : Month|int
Return values
$this

setMonths()

public setMonths(Month|int $value) : $this

Set current instance month to the given value.

Parameters
$value : Month|int
Return values
$this

setSecond()

public setSecond(int $value) : $this

Set current instance second to the given value.

Parameters
$value : int
Return values
$this

setSeconds()

public setSeconds(int $value) : $this

Set current instance second to the given value.

Parameters
$value : int
Return values
$this

setTime()

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

public setTime(int $hour, int $minute[, int $second = 0 ][, int $microseconds = 0 ]) : static
Parameters
$hour : int
$minute : int
$second : int = 0
$microseconds : int = 0
Tags
see
https://php.net/manual/en/datetime.settime.php
Return values
static

setTimeFrom()

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

public setTimeFrom(DateTimeInterface|string $date) : static
Parameters
$date : DateTimeInterface|string
Return values
static

setTimeFromTimeString()

Set the time by time string.

public setTimeFromTimeString(string $time) : static
Parameters
$time : string
Return values
static

setTimestamp()

Set the instance's timestamp.

public setTimestamp(float|int|string $timestamp) : static

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

Parameters
$timestamp : float|int|string
Return values
static

setTimezone()

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

public setTimezone(DateTimeZone|string|int $timeZone) : static
Parameters
$timeZone : DateTimeZone|string|int
Return values
static

setUnit()

Set specified unit to new given value.

public setUnit(string $unit[, Month|int $value = null ]) : static
Parameters
$unit : string

year, month, day, hour, minute, second or microsecond

$value : Month|int = null

new value for given unit

Return values
static

setUnitNoOverflow()

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

public setUnitNoOverflow(string $valueUnit, int $value, string $overflowUnit) : static
Parameters
$valueUnit : string

unit name to modify

$value : int

new value for the input unit

$overflowUnit : string

unit name to not overflow

Return values
static

setWeekendDays()

public static setWeekendDays(array<string|int, mixed> $days) : void
Parameters
$days : array<string|int, mixed>
Tags
deprecated

To avoid conflict between different third-party libraries, static setters should not be used. You should rather consider week-end is always saturday and sunday, and if you have some custom week-end days to handle, give to those days an other name and create a macro for them:

        ```
        Carbon::macro('isDayOff', function ($date) {
            return $date->isSunday() || $date->isMonday();
        });
        Carbon::macro('isNotDayOff', function ($date) {
            return !$date->isDayOff();
        });
        if ($someDate->isDayOff()) ...
        if ($someDate->isNotDayOff()) ...
        // Add 5 not-off days
        $count = 5;
        while ($someDate->isDayOff() || ($count-- > 0)) {
            $someDate->addDay();
        }
        ```

Set weekend days

setYear()

public setYear(int $value) : $this

Set current instance year to the given value.

Parameters
$value : int
Return values
$this

setYears()

public setYears(int $value) : $this

Set current instance year to the given value.

Parameters
$value : int
Return values
$this

shiftTimezone()

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

public shiftTimezone(DateTimeZone|string $value) : static
Parameters
$value : DateTimeZone|string
Return values
static

shortAbsoluteDiffForHumans()

public shortAbsoluteDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

shortRelativeDiffForHumans()

public shortRelativeDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

shortRelativeToNowDiffForHumans()

public shortRelativeToNowDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

shortRelativeToOtherDiffForHumans()

public shortRelativeToOtherDiffForHumans(DateTimeInterface $other = null, int $parts = 1) : string

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

Parameters
$other = null : DateTimeInterface
$parts = 1 : int
Return values
string

singularUnit()

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

public static singularUnit(string $unit) : string
Parameters
$unit : string
Return values
string

sleep()

public static sleep(int|float $seconds) : void
Parameters
$seconds : int|float

subCenturies()

public subCenturies(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subCenturiesNoOverflow()

public subCenturiesNoOverflow(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subCenturiesWithNoOverflow()

public subCenturiesWithNoOverflow(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subCenturiesWithoutOverflow()

public subCenturiesWithoutOverflow(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subCenturiesWithOverflow()

public subCenturiesWithOverflow(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subCentury()

public subCentury() : $this

Sub one century to the instance (using date interval).

Return values
$this

subCenturyNoOverflow()

public subCenturyNoOverflow() : $this

Sub one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subCenturyWithNoOverflow()

public subCenturyWithNoOverflow() : $this

Sub one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subCenturyWithoutOverflow()

public subCenturyWithoutOverflow() : $this

Sub one century to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subCenturyWithOverflow()

public subCenturyWithOverflow() : $this

Sub one century to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

subDay()

public subDay() : $this

Sub one day to the instance (using date interval).

Return values
$this

subDays()

public subDays(int|float $value = 1) : $this

Sub days (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subDecade()

public subDecade() : $this

Sub one decade to the instance (using date interval).

Return values
$this

subDecadeNoOverflow()

public subDecadeNoOverflow() : $this

Sub one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subDecades()

public subDecades(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subDecadesNoOverflow()

public subDecadesNoOverflow(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subDecadesWithNoOverflow()

public subDecadesWithNoOverflow(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subDecadesWithoutOverflow()

public subDecadesWithoutOverflow(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subDecadesWithOverflow()

public subDecadesWithOverflow(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subDecadeWithNoOverflow()

public subDecadeWithNoOverflow() : $this

Sub one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subDecadeWithoutOverflow()

public subDecadeWithoutOverflow() : $this

Sub one decade to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subDecadeWithOverflow()

public subDecadeWithOverflow() : $this

Sub one decade to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

subHour()

public subHour() : $this

Sub one hour to the instance (using date interval).

Return values
$this

subHours()

public subHours(int|float $value = 1) : $this

Sub hours (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMicro()

public subMicro() : $this

Sub one microsecond to the instance (using date interval).

Return values
$this

subMicros()

public subMicros(int|float $value = 1) : $this

Sub microseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMicrosecond()

public subMicrosecond() : $this

Sub one microsecond to the instance (using date interval).

Return values
$this

subMicroseconds()

public subMicroseconds(int|float $value = 1) : $this

Sub microseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMillennia()

public subMillennia(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMillenniaNoOverflow()

public subMillenniaNoOverflow(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMillenniaWithNoOverflow()

public subMillenniaWithNoOverflow(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMillenniaWithoutOverflow()

public subMillenniaWithoutOverflow(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMillenniaWithOverflow()

public subMillenniaWithOverflow(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subMillennium()

public subMillennium() : $this

Sub one millennium to the instance (using date interval).

Return values
$this

subMillenniumNoOverflow()

public subMillenniumNoOverflow() : $this

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMillenniumWithNoOverflow()

public subMillenniumWithNoOverflow() : $this

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMillenniumWithoutOverflow()

public subMillenniumWithoutOverflow() : $this

Sub one millennium to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMillenniumWithOverflow()

public subMillenniumWithOverflow() : $this

Sub one millennium to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

subMilli()

public subMilli() : $this

Sub one millisecond to the instance (using date interval).

Return values
$this

subMillis()

public subMillis(int|float $value = 1) : $this

Sub milliseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMillisecond()

public subMillisecond() : $this

Sub one millisecond to the instance (using date interval).

Return values
$this

subMilliseconds()

public subMilliseconds(int|float $value = 1) : $this

Sub milliseconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMinute()

public subMinute() : $this

Sub one minute to the instance (using date interval).

Return values
$this

subMinutes()

public subMinutes(int|float $value = 1) : $this

Sub minutes (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMonth()

public subMonth() : $this

Sub one month to the instance (using date interval).

Return values
$this

subMonthNoOverflow()

public subMonthNoOverflow() : $this

Sub one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMonths()

public subMonths(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subMonthsNoOverflow()

public subMonthsNoOverflow(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMonthsWithNoOverflow()

public subMonthsWithNoOverflow(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMonthsWithoutOverflow()

public subMonthsWithoutOverflow(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subMonthsWithOverflow()

public subMonthsWithOverflow(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subMonthWithNoOverflow()

public subMonthWithNoOverflow() : $this

Sub one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMonthWithoutOverflow()

public subMonthWithoutOverflow() : $this

Sub one month to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subMonthWithOverflow()

public subMonthWithOverflow() : $this

Sub one month to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

subQuarter()

public subQuarter() : $this

Sub one quarter to the instance (using date interval).

Return values
$this

subQuarterNoOverflow()

public subQuarterNoOverflow() : $this

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subQuarters()

public subQuarters(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subQuartersNoOverflow()

public subQuartersNoOverflow(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subQuartersWithNoOverflow()

public subQuartersWithNoOverflow(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subQuartersWithoutOverflow()

public subQuartersWithoutOverflow(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subQuartersWithOverflow()

public subQuartersWithOverflow(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subQuarterWithNoOverflow()

public subQuarterWithNoOverflow() : $this

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subQuarterWithoutOverflow()

public subQuarterWithoutOverflow() : $this

Sub one quarter to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subQuarterWithOverflow()

public subQuarterWithOverflow() : $this

Sub one quarter to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

subSecond()

public subSecond() : $this

Sub one second to the instance (using date interval).

Return values
$this

subSeconds()

public subSeconds(int|float $value = 1) : $this

Sub seconds (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subUnitNoOverflow()

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

public subUnitNoOverflow(string $valueUnit, int $value, string $overflowUnit) : static
Parameters
$valueUnit : string

unit name to modify

$value : int

amount to subtract to the input unit

$overflowUnit : string

unit name to not overflow

Return values
static

subUTCCenturies()

public subUTCCenturies(int|float $value = 1) : $this

Sub centuries (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCCentury()

public subUTCCentury() : $this

Sub one century to the instance (using timestamp).

Return values
$this

subUTCDay()

public subUTCDay() : $this

Sub one day to the instance (using timestamp).

Return values
$this

subUTCDays()

public subUTCDays(int|float $value = 1) : $this

Sub days (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCDecade()

public subUTCDecade() : $this

Sub one decade to the instance (using timestamp).

Return values
$this

subUTCDecades()

public subUTCDecades(int|float $value = 1) : $this

Sub decades (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCHour()

public subUTCHour() : $this

Sub one hour to the instance (using timestamp).

Return values
$this

subUTCHours()

public subUTCHours(int|float $value = 1) : $this

Sub hours (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMicro()

public subUTCMicro() : $this

Sub one microsecond to the instance (using timestamp).

Return values
$this

subUTCMicros()

public subUTCMicros(int|float $value = 1) : $this

Sub microseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMicrosecond()

public subUTCMicrosecond() : $this

Sub one microsecond to the instance (using timestamp).

Return values
$this

subUTCMicroseconds()

public subUTCMicroseconds(int|float $value = 1) : $this

Sub microseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMillennia()

public subUTCMillennia(int|float $value = 1) : $this

Sub millennia (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMillennium()

public subUTCMillennium() : $this

Sub one millennium to the instance (using timestamp).

Return values
$this

subUTCMilli()

public subUTCMilli() : $this

Sub one millisecond to the instance (using timestamp).

Return values
$this

subUTCMillis()

public subUTCMillis(int|float $value = 1) : $this

Sub milliseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMillisecond()

public subUTCMillisecond() : $this

Sub one millisecond to the instance (using timestamp).

Return values
$this

subUTCMilliseconds()

public subUTCMilliseconds(int|float $value = 1) : $this

Sub milliseconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMinute()

public subUTCMinute() : $this

Sub one minute to the instance (using timestamp).

Return values
$this

subUTCMinutes()

public subUTCMinutes(int|float $value = 1) : $this

Sub minutes (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCMonth()

public subUTCMonth() : $this

Sub one month to the instance (using timestamp).

Return values
$this

subUTCMonths()

public subUTCMonths(int|float $value = 1) : $this

Sub months (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCQuarter()

public subUTCQuarter() : $this

Sub one quarter to the instance (using timestamp).

Return values
$this

subUTCQuarters()

public subUTCQuarters(int|float $value = 1) : $this

Sub quarters (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCSecond()

public subUTCSecond() : $this

Sub one second to the instance (using timestamp).

Return values
$this

subUTCSeconds()

public subUTCSeconds(int|float $value = 1) : $this

Sub seconds (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCWeek()

public subUTCWeek() : $this

Sub one week to the instance (using timestamp).

Return values
$this

subUTCWeeks()

public subUTCWeeks(int|float $value = 1) : $this

Sub weeks (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subUTCYear()

public subUTCYear() : $this

Sub one year to the instance (using timestamp).

Return values
$this

subUTCYears()

public subUTCYears(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using timestamp).

Parameters
$value = 1 : int|float
Return values
$this

subWeek()

public subWeek() : $this

Sub one week to the instance (using date interval).

Return values
$this

subWeekday()

public subWeekday() : $this

Sub one weekday to the instance (using date interval).

Return values
$this

subWeekdays()

public subWeekdays(int|float $value = 1) : $this

Sub weekdays (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subWeeks()

public subWeeks(int|float $value = 1) : $this

Sub weeks (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subYear()

public subYear() : $this

Sub one year to the instance (using date interval).

Return values
$this

subYearNoOverflow()

public subYearNoOverflow() : $this

Sub one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subYears()

public subYears(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using date interval).

Parameters
$value = 1 : int|float
Return values
$this

subYearsNoOverflow()

public subYearsNoOverflow(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subYearsWithNoOverflow()

public subYearsWithNoOverflow(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subYearsWithoutOverflow()

public subYearsWithoutOverflow(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.

Parameters
$value = 1 : int|float
Return values
$this

subYearsWithOverflow()

public subYearsWithOverflow(int|float $value = 1) : $this

Sub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.

Parameters
$value = 1 : int|float
Return values
$this

subYearWithNoOverflow()

public subYearWithNoOverflow() : $this

Sub one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subYearWithoutOverflow()

public subYearWithoutOverflow() : $this

Sub one year to the instance (using date interval) with overflow explicitly forbidden.

Return values
$this

subYearWithOverflow()

public subYearWithOverflow() : $this

Sub one year to the instance (using date interval) with overflow explicitly allowed.

Return values
$this

timezone()

public timezone(DateTimeZone|string|int $value) : static
Parameters
$value : DateTimeZone|string|int
Tags
alias

setTimezone

Return values
static

translatedFormat()

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

public translatedFormat(string $format) : string
Parameters
$format : string
Return values
string

tz()

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

public tz([DateTimeZone|string|int|null $value = null ]) : static|string
Parameters
$value : DateTimeZone|string|int|null = null
Return values
static|string

utc()

Set the instance's timezone to UTC.

public utc() : static
Return values
static

utcOffset()

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

public utcOffset([int|null $minuteOffset = null ]) : static|int
Parameters
$minuteOffset : int|null = null
Return values
static|int

weekday()

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

public weekday([WeekDay|int|null $value = null ]) : static|int
Parameters
$value : WeekDay|int|null = null

new value for weekday if using as setter.

Return values
static|int

weekOfCentury()

public weekOfCentury(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weekOfDecade()

public weekOfDecade(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weekOfMillennium()

public weekOfMillennium(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weekOfMonth()

public weekOfMonth(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weekOfQuarter()

public weekOfQuarter(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weekOfYear()

public weekOfYear(int|null $week = null) : 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

Parameters
$week = null : int|null
Return values
int|static

weeksInCentury()

public weeksInCentury() : int

Return the number of weeks contained in the current century

Return values
int

weeksInDecade()

public weeksInDecade() : int

Return the number of weeks contained in the current decade

Return values
int

weeksInMillennium()

public weeksInMillennium() : int

Return the number of weeks contained in the current millennium

Return values
int

weeksInMonth()

public weeksInMonth() : int

Return the number of weeks contained in the current month

Return values
int

weeksInQuarter()

public weeksInQuarter() : int

Return the number of weeks contained in the current quarter

Return values
int

weeksUntil()

public weeksUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

year()

public year(int $value) : $this

Set current instance year to the given value.

Parameters
$value : int
Return values
$this

yearOfCentury()

public yearOfCentury(int|null $year = null) : 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

Parameters
$year = null : int|null
Return values
int|static

yearOfDecade()

public yearOfDecade(int|null $year = null) : 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

Parameters
$year = null : int|null
Return values
int|static

yearOfMillennium()

public yearOfMillennium(int|null $year = null) : 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

Parameters
$year = null : int|null
Return values
int|static

years()

public years(int $value) : $this

Set current instance year to the given value.

Parameters
$value : int
Return values
$this

yearsInCentury()

public yearsInCentury() : int

Return the number of years contained in the current century

Return values
int

yearsInDecade()

public yearsInDecade() : int

Return the number of years contained in the current decade

Return values
int

yearsInMillennium()

public yearsInMillennium() : int

Return the number of years contained in the current millennium

Return values
int

yearsUntil()

public yearsUntil(mixed $endDate, int|float $factor = 1) : 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.

Parameters
$endDate : mixed
$factor = 1 : int|float
Return values
CarbonPeriod

executeCallable()

protected executeCallable(callable $macro, mixed ...$parameters) : mixed
Parameters
$macro : callable
$parameters : mixed

executeCallableWithContext()

protected executeCallableWithContext(callable $macro, mixed ...$parameters) : mixed
Parameters
$macro : callable
$parameters : mixed

executeStaticCallable()

protected static executeStaticCallable(callable $macro, mixed ...$parameters) : mixed
Parameters
$macro : callable
$parameters : mixed

getAllGenericMacros()

protected getAllGenericMacros() : Generator
Return values
Generator

getGenericMacros()

protected static getGenericMacros() : Generator
Return values
Generator

getRangesByUnit()

List of minimum and maximums for each unit.

protected static getRangesByUnit([int $daysInMonth = 31 ]) : array<string|int, mixed>
Parameters
$daysInMonth : int = 31
Return values
array<string|int, mixed>

getTranslatedFormByRegExp()

protected getTranslatedFormByRegExp(mixed $baseKey, mixed $keySuffix, mixed $context, mixed $subKey, mixed $defaultValue) : mixed
Parameters
$baseKey : mixed
$keySuffix : mixed
$context : mixed
$subKey : mixed
$defaultValue : mixed

resolveCarbon()

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

protected resolveCarbon(DateTimeInterface|string|null $date) : self
Parameters
$date : DateTimeInterface|string|null
Return values
self

safeCreateDateTimeZone()

Creates a DateTimeZone from a string, DateTimeZone or integer offset.

protected static safeCreateDateTimeZone(DateTimeZone|string|int|false|null $object[, DateTimeZone|string|int|false|null $objectDump = null ]) : CarbonTimeZone|null
Parameters
$object : DateTimeZone|string|int|false|null

original value to get CarbonTimeZone from it.

$objectDump : DateTimeZone|string|int|false|null = null

dump of the object for error messages.

Tags
throws
InvalidTimeZoneException
Return values
CarbonTimeZone|null

weekRotate()

protected static weekRotate(int $day, int $rotation) : int
Parameters
$day : int
$rotation : int
Return values
int

callComparatorMethod()

private callComparatorMethod(string $unit, array<string|int, mixed> $parameters) : bool|null
Parameters
$unit : string
$parameters : array<string|int, mixed>
Return values
bool|null

callDiffAlias()

private callDiffAlias(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>

callGetOrSet()

private callGetOrSet(string $name, mixed $value) : mixed
Parameters
$name : string
$value : mixed

callGetOrSetMethod()

private callGetOrSetMethod(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>

callHumanDiffAlias()

private callHumanDiffAlias(string $method, array<string|int, mixed> $parameters) : string|null
Parameters
$method : string
$parameters : array<string|int, mixed>
Return values
string|null

callIsMethod()

private callIsMethod(string $unit, array<string|int, mixed> $parameters) : bool|null
Parameters
$unit : string
$parameters : array<string|int, mixed>
Return values
bool|null

callMacroMethod()

private callMacroMethod(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>

callModifierMethod()

private callModifierMethod(string $unit, array<string|int, mixed> $parameters) : static|null
Parameters
$unit : string
$parameters : array<string|int, mixed>
Return values
static|null

callPeriodMethod()

private callPeriodMethod(string $method, array<string|int, mixed> $parameters) : CarbonPeriod|null
Parameters
$method : string
$parameters : array<string|int, mixed>
Return values
CarbonPeriod|null

floorZeroPad()

private static floorZeroPad(int|float $value, int $length) : string
Parameters
$value : int|float
$length : int
Return values
string

getUTCUnit()

private getUTCUnit(string $unit) : string|null
Parameters
$unit : string
Return values
string|null

        
On this page

Search results