Menu

## CarbonImmutable extends DateTimeImmutable
in package
implements CarbonInterface Uses Date

CarbonImmutable.php : 836

A simple API extension for DateTimeImmutable.

<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.
__clone() : void
  Update constructedObjectId on cloned.
__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() : CarbonImmutable
addCenturiesNoOverflow() : CarbonImmutable
addCenturiesWithNoOverflow() : CarbonImmutable
addCenturiesWithoutOverflow() : CarbonImmutable
addCenturiesWithOverflow() : CarbonImmutable
addCentury() : CarbonImmutable
addCenturyNoOverflow() : CarbonImmutable
addCenturyWithNoOverflow() : CarbonImmutable
addCenturyWithoutOverflow() : CarbonImmutable
addCenturyWithOverflow() : CarbonImmutable
addDay() : CarbonImmutable
addDays() : CarbonImmutable
addDecade() : CarbonImmutable
addDecadeNoOverflow() : CarbonImmutable
addDecades() : CarbonImmutable
addDecadesNoOverflow() : CarbonImmutable
addDecadesWithNoOverflow() : CarbonImmutable
addDecadesWithoutOverflow() : CarbonImmutable
addDecadesWithOverflow() : CarbonImmutable
addDecadeWithNoOverflow() : CarbonImmutable
addDecadeWithoutOverflow() : CarbonImmutable
addDecadeWithOverflow() : CarbonImmutable
addHour() : CarbonImmutable
addHours() : CarbonImmutable
addMicro() : CarbonImmutable
addMicros() : CarbonImmutable
addMicrosecond() : CarbonImmutable
addMicroseconds() : CarbonImmutable
addMillennia() : CarbonImmutable
addMillenniaNoOverflow() : CarbonImmutable
addMillenniaWithNoOverflow() : CarbonImmutable
addMillenniaWithoutOverflow() : CarbonImmutable
addMillenniaWithOverflow() : CarbonImmutable
addMillennium() : CarbonImmutable
addMillenniumNoOverflow() : CarbonImmutable
addMillenniumWithNoOverflow() : CarbonImmutable
addMillenniumWithoutOverflow() : CarbonImmutable
addMillenniumWithOverflow() : CarbonImmutable
addMilli() : CarbonImmutable
addMillis() : CarbonImmutable
addMillisecond() : CarbonImmutable
addMilliseconds() : CarbonImmutable
addMinute() : CarbonImmutable
addMinutes() : CarbonImmutable
addMonth() : CarbonImmutable
addMonthNoOverflow() : CarbonImmutable
addMonths() : CarbonImmutable
addMonthsNoOverflow() : CarbonImmutable
addMonthsWithNoOverflow() : CarbonImmutable
addMonthsWithoutOverflow() : CarbonImmutable
addMonthsWithOverflow() : CarbonImmutable
addMonthWithNoOverflow() : CarbonImmutable
addMonthWithoutOverflow() : CarbonImmutable
addMonthWithOverflow() : CarbonImmutable
addQuarter() : CarbonImmutable
addQuarterNoOverflow() : CarbonImmutable
addQuarters() : CarbonImmutable
addQuartersNoOverflow() : CarbonImmutable
addQuartersWithNoOverflow() : CarbonImmutable
addQuartersWithoutOverflow() : CarbonImmutable
addQuartersWithOverflow() : CarbonImmutable
addQuarterWithNoOverflow() : CarbonImmutable
addQuarterWithoutOverflow() : CarbonImmutable
addQuarterWithOverflow() : CarbonImmutable
addSecond() : CarbonImmutable
addSeconds() : CarbonImmutable
addUnitNoOverflow() : static
  Add any unit to a new value without overflowing current other unit given.
addUTCCenturies() : CarbonImmutable
addUTCCentury() : CarbonImmutable
addUTCDay() : CarbonImmutable
addUTCDays() : CarbonImmutable
addUTCDecade() : CarbonImmutable
addUTCDecades() : CarbonImmutable
addUTCHour() : CarbonImmutable
addUTCHours() : CarbonImmutable
addUTCMicro() : CarbonImmutable
addUTCMicros() : CarbonImmutable
addUTCMicrosecond() : CarbonImmutable
addUTCMicroseconds() : CarbonImmutable
addUTCMillennia() : CarbonImmutable
addUTCMillennium() : CarbonImmutable
addUTCMilli() : CarbonImmutable
addUTCMillis() : CarbonImmutable
addUTCMillisecond() : CarbonImmutable
addUTCMilliseconds() : CarbonImmutable
addUTCMinute() : CarbonImmutable
addUTCMinutes() : CarbonImmutable
addUTCMonth() : CarbonImmutable
addUTCMonths() : CarbonImmutable
addUTCQuarter() : CarbonImmutable
addUTCQuarters() : CarbonImmutable
addUTCSecond() : CarbonImmutable
addUTCSeconds() : CarbonImmutable
addUTCWeek() : CarbonImmutable
addUTCWeeks() : CarbonImmutable
addUTCYear() : CarbonImmutable
addUTCYears() : CarbonImmutable
addWeek() : CarbonImmutable
addWeekday() : CarbonImmutable
addWeekdays() : CarbonImmutable
addWeeks() : CarbonImmutable
addYear() : CarbonImmutable
addYearNoOverflow() : CarbonImmutable
addYears() : CarbonImmutable
addYearsNoOverflow() : CarbonImmutable
addYearsWithNoOverflow() : CarbonImmutable
addYearsWithoutOverflow() : CarbonImmutable
addYearsWithOverflow() : CarbonImmutable
addYearWithNoOverflow() : CarbonImmutable
addYearWithoutOverflow() : CarbonImmutable
addYearWithOverflow() : CarbonImmutable
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() : CarbonImmutable
ceilCentury() : CarbonImmutable
ceilDay() : CarbonImmutable
ceilDays() : CarbonImmutable
ceilDecade() : CarbonImmutable
ceilDecades() : CarbonImmutable
ceilHour() : CarbonImmutable
ceilHours() : CarbonImmutable
ceilMicrosecond() : CarbonImmutable
ceilMicroseconds() : CarbonImmutable
ceilMillennia() : CarbonImmutable
ceilMillennium() : CarbonImmutable
ceilMillisecond() : CarbonImmutable
ceilMilliseconds() : CarbonImmutable
ceilMinute() : CarbonImmutable
ceilMinutes() : CarbonImmutable
ceilMonth() : CarbonImmutable
ceilMonths() : CarbonImmutable
ceilQuarter() : CarbonImmutable
ceilQuarters() : CarbonImmutable
ceilSecond() : CarbonImmutable
ceilSeconds() : CarbonImmutable
ceilYear() : CarbonImmutable
ceilYears() : CarbonImmutable
centuriesInMillennium() : int
centuriesUntil() : CarbonPeriod
centuryOfMillennium() : int|static
clone() : static
copy() : static
  Get a copy of the instance.
day() : CarbonImmutable
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() : CarbonImmutable
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
endOfTime() : static
  Create a very far date representing end of time.
floorCenturies() : CarbonImmutable
floorCentury() : CarbonImmutable
floorDay() : CarbonImmutable
floorDays() : CarbonImmutable
floorDecade() : CarbonImmutable
floorDecades() : CarbonImmutable
floorHour() : CarbonImmutable
floorHours() : CarbonImmutable
floorMicrosecond() : CarbonImmutable
floorMicroseconds() : CarbonImmutable
floorMillennia() : CarbonImmutable
floorMillennium() : CarbonImmutable
floorMillisecond() : CarbonImmutable
floorMilliseconds() : CarbonImmutable
floorMinute() : CarbonImmutable
floorMinutes() : CarbonImmutable
floorMonth() : CarbonImmutable
floorMonths() : CarbonImmutable
floorQuarter() : CarbonImmutable
floorQuarters() : CarbonImmutable
floorSecond() : CarbonImmutable
floorSeconds() : CarbonImmutable
floorYear() : CarbonImmutable
floorYears() : CarbonImmutable
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() : CarbonImmutable
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() : CarbonImmutable
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
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() : CarbonImmutable
micros() : CarbonImmutable
microsecond() : CarbonImmutable
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() : CarbonImmutable
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() : CarbonImmutable
millis() : CarbonImmutable
millisecond() : CarbonImmutable
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() : CarbonImmutable
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() : CarbonImmutable
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() : CarbonImmutable
minutesInCentury() : int
minutesInDay() : int
minutesInDecade() : int
minutesInHour() : int
minutesInMillennium() : int
minutesInMonth() : int
minutesInQuarter() : int
minutesInWeek() : int
minutesInYear() : int
minutesUntil() : CarbonPeriod
month() : CarbonImmutable
monthOfCentury() : int|static
monthOfDecade() : int|static
monthOfMillennium() : int|static
monthOfQuarter() : int|static
monthOfYear() : int|static
months() : CarbonImmutable
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() : CarbonImmutable
roundCentury() : CarbonImmutable
roundDay() : CarbonImmutable
roundDays() : CarbonImmutable
roundDecade() : CarbonImmutable
roundDecades() : CarbonImmutable
roundHour() : CarbonImmutable
roundHours() : CarbonImmutable
roundMicrosecond() : CarbonImmutable
roundMicroseconds() : CarbonImmutable
roundMillennia() : CarbonImmutable
roundMillennium() : CarbonImmutable
roundMillisecond() : CarbonImmutable
roundMilliseconds() : CarbonImmutable
roundMinute() : CarbonImmutable
roundMinutes() : CarbonImmutable
roundMonth() : CarbonImmutable
roundMonths() : CarbonImmutable
roundQuarter() : CarbonImmutable
roundQuarters() : CarbonImmutable
roundSecond() : CarbonImmutable
roundSeconds() : CarbonImmutable
roundYear() : CarbonImmutable
roundYears() : CarbonImmutable
second() : CarbonImmutable
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() : CarbonImmutable
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() : CarbonImmutable
setDays() : CarbonImmutable
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() : CarbonImmutable
setHours() : CarbonImmutable
setISODate() : static
  Set a date according to the ISO 8601 standard - using weeks and day offsets rather than specific dates.
setMicro() : CarbonImmutable
setMicros() : CarbonImmutable
setMicrosecond() : CarbonImmutable
setMicroseconds() : CarbonImmutable
setMilli() : CarbonImmutable
setMillis() : CarbonImmutable
setMillisecond() : CarbonImmutable
setMilliseconds() : CarbonImmutable
setMinute() : CarbonImmutable
setMinutes() : CarbonImmutable
setMonth() : CarbonImmutable
setMonths() : CarbonImmutable
setSecond() : CarbonImmutable
setSeconds() : CarbonImmutable
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() : CarbonImmutable
setYears() : CarbonImmutable
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
startOfTime() : static
  Create a very old date representing start of time.
subCenturies() : CarbonImmutable
subCenturiesNoOverflow() : CarbonImmutable
subCenturiesWithNoOverflow() : CarbonImmutable
subCenturiesWithoutOverflow() : CarbonImmutable
subCenturiesWithOverflow() : CarbonImmutable
subCentury() : CarbonImmutable
subCenturyNoOverflow() : CarbonImmutable
subCenturyWithNoOverflow() : CarbonImmutable
subCenturyWithoutOverflow() : CarbonImmutable
subCenturyWithOverflow() : CarbonImmutable
subDay() : CarbonImmutable
subDays() : CarbonImmutable
subDecade() : CarbonImmutable
subDecadeNoOverflow() : CarbonImmutable
subDecades() : CarbonImmutable
subDecadesNoOverflow() : CarbonImmutable
subDecadesWithNoOverflow() : CarbonImmutable
subDecadesWithoutOverflow() : CarbonImmutable
subDecadesWithOverflow() : CarbonImmutable
subDecadeWithNoOverflow() : CarbonImmutable
subDecadeWithoutOverflow() : CarbonImmutable
subDecadeWithOverflow() : CarbonImmutable
subHour() : CarbonImmutable
subHours() : CarbonImmutable
subMicro() : CarbonImmutable
subMicros() : CarbonImmutable
subMicrosecond() : CarbonImmutable
subMicroseconds() : CarbonImmutable
subMillennia() : CarbonImmutable
subMillenniaNoOverflow() : CarbonImmutable
subMillenniaWithNoOverflow() : CarbonImmutable
subMillenniaWithoutOverflow() : CarbonImmutable
subMillenniaWithOverflow() : CarbonImmutable
subMillennium() : CarbonImmutable
subMillenniumNoOverflow() : CarbonImmutable
subMillenniumWithNoOverflow() : CarbonImmutable
subMillenniumWithoutOverflow() : CarbonImmutable
subMillenniumWithOverflow() : CarbonImmutable
subMilli() : CarbonImmutable
subMillis() : CarbonImmutable
subMillisecond() : CarbonImmutable
subMilliseconds() : CarbonImmutable
subMinute() : CarbonImmutable
subMinutes() : CarbonImmutable
subMonth() : CarbonImmutable
subMonthNoOverflow() : CarbonImmutable
subMonths() : CarbonImmutable
subMonthsNoOverflow() : CarbonImmutable
subMonthsWithNoOverflow() : CarbonImmutable
subMonthsWithoutOverflow() : CarbonImmutable
subMonthsWithOverflow() : CarbonImmutable
subMonthWithNoOverflow() : CarbonImmutable
subMonthWithoutOverflow() : CarbonImmutable
subMonthWithOverflow() : CarbonImmutable
subQuarter() : CarbonImmutable
subQuarterNoOverflow() : CarbonImmutable
subQuarters() : CarbonImmutable
subQuartersNoOverflow() : CarbonImmutable
subQuartersWithNoOverflow() : CarbonImmutable
subQuartersWithoutOverflow() : CarbonImmutable
subQuartersWithOverflow() : CarbonImmutable
subQuarterWithNoOverflow() : CarbonImmutable
subQuarterWithoutOverflow() : CarbonImmutable
subQuarterWithOverflow() : CarbonImmutable
subSecond() : CarbonImmutable
subSeconds() : CarbonImmutable
subUnitNoOverflow() : static
  Subtract any unit to a new value without overflowing current other unit given.
subUTCCenturies() : CarbonImmutable
subUTCCentury() : CarbonImmutable
subUTCDay() : CarbonImmutable
subUTCDays() : CarbonImmutable
subUTCDecade() : CarbonImmutable
subUTCDecades() : CarbonImmutable
subUTCHour() : CarbonImmutable
subUTCHours() : CarbonImmutable
subUTCMicro() : CarbonImmutable
subUTCMicros() : CarbonImmutable
subUTCMicrosecond() : CarbonImmutable
subUTCMicroseconds() : CarbonImmutable
subUTCMillennia() : CarbonImmutable
subUTCMillennium() : CarbonImmutable
subUTCMilli() : CarbonImmutable
subUTCMillis() : CarbonImmutable
subUTCMillisecond() : CarbonImmutable
subUTCMilliseconds() : CarbonImmutable
subUTCMinute() : CarbonImmutable
subUTCMinutes() : CarbonImmutable
subUTCMonth() : CarbonImmutable
subUTCMonths() : CarbonImmutable
subUTCQuarter() : CarbonImmutable
subUTCQuarters() : CarbonImmutable
subUTCSecond() : CarbonImmutable
subUTCSeconds() : CarbonImmutable
subUTCWeek() : CarbonImmutable
subUTCWeeks() : CarbonImmutable
subUTCYear() : CarbonImmutable
subUTCYears() : CarbonImmutable
subWeek() : CarbonImmutable
subWeekday() : CarbonImmutable
subWeekdays() : CarbonImmutable
subWeeks() : CarbonImmutable
subYear() : CarbonImmutable
subYearNoOverflow() : CarbonImmutable
subYears() : CarbonImmutable
subYearsNoOverflow() : CarbonImmutable
subYearsWithNoOverflow() : CarbonImmutable
subYearsWithoutOverflow() : CarbonImmutable
subYearsWithOverflow() : CarbonImmutable
subYearWithNoOverflow() : CarbonImmutable
subYearWithoutOverflow() : CarbonImmutable
subYearWithOverflow() : CarbonImmutable
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() : CarbonImmutable
yearOfCentury() : int|static
yearOfDecade() : int|static
yearOfMillennium() : int|static
years() : CarbonImmutable
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
getEndOfTimeYear() : int
getStartOfTimeYear() : int
getUTCUnit() : string|null

### Properties

#### $age

CarbonImmutable.php : 0
`public int $age`

does a diffInYears() with default parameters

#### $centuriesInMillennium read-only

CarbonImmutable.php : 0
`public int $centuriesInMillennium`

The number of centuries contained in the current millennium

#### $century read-only

CarbonImmutable.php : 0
`public int $century`

the century of this instance

#### $centuryOfMillennium

CarbonImmutable.php : 0
`public int $centuryOfMillennium`

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

#### $day

CarbonImmutable.php : 0
`public int $day`

#### $dayName read-only

CarbonImmutable.php : 0
`public string $dayName`

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

#### $dayOfCentury

CarbonImmutable.php : 0
`public int $dayOfCentury`

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

#### $dayOfDecade

CarbonImmutable.php : 0
`public int $dayOfDecade`

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

#### $dayOfMillennium

CarbonImmutable.php : 0
`public int $dayOfMillennium`

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

#### $dayOfMonth

CarbonImmutable.php : 0
`public int $dayOfMonth`

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

#### $dayOfQuarter

CarbonImmutable.php : 0
`public int $dayOfQuarter`

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

#### $dayOfWeek

CarbonImmutable.php : 0
`public int $dayOfWeek`

0 (for Sunday) through 6 (for Saturday)

#### $dayOfWeekIso

CarbonImmutable.php : 0
`public int $dayOfWeekIso`

1 (for Monday) through 7 (for Sunday)

#### $dayOfYear

CarbonImmutable.php : 0
`public int $dayOfYear`

1 through 366

#### $daysInCentury read-only

CarbonImmutable.php : 0
`public int $daysInCentury`

The number of days contained in the current century

#### $daysInDecade read-only

CarbonImmutable.php : 0
`public int $daysInDecade`

The number of days contained in the current decade

#### $daysInMillennium read-only

CarbonImmutable.php : 0
`public int $daysInMillennium`

The number of days contained in the current millennium

#### $daysInMonth read-only

CarbonImmutable.php : 0
`public int $daysInMonth`

number of days in the given month

#### $daysInQuarter read-only

CarbonImmutable.php : 0
`public int $daysInQuarter`

The number of days contained in the current quarter

#### $daysInWeek read-only

CarbonImmutable.php : 0
`public int $daysInWeek`

The number of days contained in the current week

#### $daysInYear read-only

CarbonImmutable.php : 0
`public int $daysInYear`

365 or 366

#### $decade read-only

CarbonImmutable.php : 0
`public int $decade`

the decade of this instance

#### $decadeOfCentury

CarbonImmutable.php : 0
`public int $decadeOfCentury`

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

#### $decadeOfMillennium

CarbonImmutable.php : 0
`public int $decadeOfMillennium`

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

#### $decadesInCentury read-only

CarbonImmutable.php : 0
`public int $decadesInCentury`

The number of decades contained in the current century

#### $decadesInMillennium read-only

CarbonImmutable.php : 0
`public int $decadesInMillennium`

The number of decades contained in the current millennium

#### $dst read-only

CarbonImmutable.php : 0
`public bool $dst`

daylight savings time indicator, true if DST, false otherwise

#### $englishDayOfWeek

CarbonImmutable.php : 0
`public string $englishDayOfWeek`

the day of week in English

#### $englishMonth

CarbonImmutable.php : 0
`public string $englishMonth`

the month in English

#### $firstWeekDay read-only

CarbonImmutable.php : 0
`public int $firstWeekDay`

0 through 6

#### $hour

CarbonImmutable.php : 0
`public int $hour`

#### $hourOfCentury

CarbonImmutable.php : 0
`public int $hourOfCentury`

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

#### $hourOfDay

CarbonImmutable.php : 0
`public int $hourOfDay`

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

#### $hourOfDecade

CarbonImmutable.php : 0
`public int $hourOfDecade`

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

#### $hourOfMillennium

CarbonImmutable.php : 0
`public int $hourOfMillennium`

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

#### $hourOfMonth

CarbonImmutable.php : 0
`public int $hourOfMonth`

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

#### $hourOfQuarter

CarbonImmutable.php : 0
`public int $hourOfQuarter`

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

#### $hourOfWeek

CarbonImmutable.php : 0
`public int $hourOfWeek`

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

#### $hourOfYear

CarbonImmutable.php : 0
`public int $hourOfYear`

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

#### $hoursInCentury read-only

CarbonImmutable.php : 0
`public int $hoursInCentury`

The number of hours contained in the current century

#### $hoursInDay read-only

CarbonImmutable.php : 0
`public int $hoursInDay`

The number of hours contained in the current day

#### $hoursInDecade read-only

CarbonImmutable.php : 0
`public int $hoursInDecade`

The number of hours contained in the current decade

#### $hoursInMillennium read-only

CarbonImmutable.php : 0
`public int $hoursInMillennium`

The number of hours contained in the current millennium

#### $hoursInMonth read-only

CarbonImmutable.php : 0
`public int $hoursInMonth`

The number of hours contained in the current month

#### $hoursInQuarter read-only

CarbonImmutable.php : 0
`public int $hoursInQuarter`

The number of hours contained in the current quarter

#### $hoursInWeek read-only

CarbonImmutable.php : 0
`public int $hoursInWeek`

The number of hours contained in the current week

#### $hoursInYear read-only

CarbonImmutable.php : 0
`public int $hoursInYear`

The number of hours contained in the current year

#### $isoWeek

CarbonImmutable.php : 0
`public int $isoWeek`

1 through 53

#### $isoWeeksInYear read-only

CarbonImmutable.php : 0
`public int $isoWeeksInYear`

51 through 53

#### $isoWeekYear

CarbonImmutable.php : 0
`public int $isoWeekYear`

year according to ISO week format

#### $lastWeekDay read-only

CarbonImmutable.php : 0
`public int $lastWeekDay`

0 through 6

#### $latinMeridiem read-only

CarbonImmutable.php : 0
`public string $latinMeridiem`

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

#### $latinUpperMeridiem read-only

CarbonImmutable.php : 0
`public string $latinUpperMeridiem`

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

#### $local read-only

CarbonImmutable.php : 0
`public bool $local`

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

#### $locale read-only

CarbonImmutable.php : 0
`public string $locale`

locale of the current instance

#### $localeDayOfWeek

CarbonImmutable.php : 0
`public string $localeDayOfWeek`

the day of week in current locale

#### $localeMonth

CarbonImmutable.php : 0
`public string $localeMonth`

the month in current locale

#### $meridiem read-only

CarbonImmutable.php : 0
`public string $meridiem`

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

#### $micro

CarbonImmutable.php : 0
`public int $micro`

#### $microsecond

CarbonImmutable.php : 0
`public int $microsecond`

#### $microsecondOfCentury

CarbonImmutable.php : 0
`public int $microsecondOfCentury`

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

#### $microsecondOfDay

CarbonImmutable.php : 0
`public int $microsecondOfDay`

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

#### $microsecondOfDecade

CarbonImmutable.php : 0
`public int $microsecondOfDecade`

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

#### $microsecondOfHour

CarbonImmutable.php : 0
`public int $microsecondOfHour`

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

#### $microsecondOfMillennium

CarbonImmutable.php : 0
`public int $microsecondOfMillennium`

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

#### $microsecondOfMillisecond

CarbonImmutable.php : 0
`public int $microsecondOfMillisecond`

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

#### $microsecondOfMinute

CarbonImmutable.php : 0
`public int $microsecondOfMinute`

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

#### $microsecondOfMonth

CarbonImmutable.php : 0
`public int $microsecondOfMonth`

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

#### $microsecondOfQuarter

CarbonImmutable.php : 0
`public int $microsecondOfQuarter`

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

#### $microsecondOfSecond

CarbonImmutable.php : 0
`public int $microsecondOfSecond`

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

#### $microsecondOfWeek

CarbonImmutable.php : 0
`public int $microsecondOfWeek`

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

#### $microsecondOfYear

CarbonImmutable.php : 0
`public int $microsecondOfYear`

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

#### $microsecondsInCentury read-only

CarbonImmutable.php : 0
`public int $microsecondsInCentury`

The number of microseconds contained in the current century

#### $microsecondsInDay read-only

CarbonImmutable.php : 0
`public int $microsecondsInDay`

The number of microseconds contained in the current day

#### $microsecondsInDecade read-only

CarbonImmutable.php : 0
`public int $microsecondsInDecade`

The number of microseconds contained in the current decade

#### $microsecondsInHour read-only

CarbonImmutable.php : 0
`public int $microsecondsInHour`

The number of microseconds contained in the current hour

#### $microsecondsInMillennium read-only

CarbonImmutable.php : 0
`public int $microsecondsInMillennium`

The number of microseconds contained in the current millennium

#### $microsecondsInMillisecond read-only

CarbonImmutable.php : 0
`public int $microsecondsInMillisecond`

The number of microseconds contained in the current millisecond

#### $microsecondsInMinute read-only

CarbonImmutable.php : 0
`public int $microsecondsInMinute`

The number of microseconds contained in the current minute

#### $microsecondsInMonth read-only

CarbonImmutable.php : 0
`public int $microsecondsInMonth`

The number of microseconds contained in the current month

#### $microsecondsInQuarter read-only

CarbonImmutable.php : 0
`public int $microsecondsInQuarter`

The number of microseconds contained in the current quarter

#### $microsecondsInSecond read-only

CarbonImmutable.php : 0
`public int $microsecondsInSecond`

The number of microseconds contained in the current second

#### $microsecondsInWeek read-only

CarbonImmutable.php : 0
`public int $microsecondsInWeek`

The number of microseconds contained in the current week

#### $microsecondsInYear read-only

CarbonImmutable.php : 0
`public int $microsecondsInYear`

The number of microseconds contained in the current year

#### $millennium read-only

CarbonImmutable.php : 0
`public int $millennium`

the millennium of this instance

#### $milli

CarbonImmutable.php : 0
`public int $milli`

#### $millisecond

CarbonImmutable.php : 0
`public int $millisecond`

#### $millisecondOfCentury

CarbonImmutable.php : 0
`public int $millisecondOfCentury`

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

#### $millisecondOfDay

CarbonImmutable.php : 0
`public int $millisecondOfDay`

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

#### $millisecondOfDecade

CarbonImmutable.php : 0
`public int $millisecondOfDecade`

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

#### $millisecondOfHour

CarbonImmutable.php : 0
`public int $millisecondOfHour`

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

#### $millisecondOfMillennium

CarbonImmutable.php : 0
`public int $millisecondOfMillennium`

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

#### $millisecondOfMinute

CarbonImmutable.php : 0
`public int $millisecondOfMinute`

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

#### $millisecondOfMonth

CarbonImmutable.php : 0
`public int $millisecondOfMonth`

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

#### $millisecondOfQuarter

CarbonImmutable.php : 0
`public int $millisecondOfQuarter`

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

#### $millisecondOfSecond

CarbonImmutable.php : 0
`public int $millisecondOfSecond`

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

#### $millisecondOfWeek

CarbonImmutable.php : 0
`public int $millisecondOfWeek`

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

#### $millisecondOfYear

CarbonImmutable.php : 0
`public int $millisecondOfYear`

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

#### $milliseconds

CarbonImmutable.php : 0
`public int $milliseconds`

#### $millisecondsInCentury read-only

CarbonImmutable.php : 0
`public int $millisecondsInCentury`

The number of milliseconds contained in the current century

#### $millisecondsInDay read-only

CarbonImmutable.php : 0
`public int $millisecondsInDay`

The number of milliseconds contained in the current day

#### $millisecondsInDecade read-only

CarbonImmutable.php : 0
`public int $millisecondsInDecade`

The number of milliseconds contained in the current decade

#### $millisecondsInHour read-only

CarbonImmutable.php : 0
`public int $millisecondsInHour`

The number of milliseconds contained in the current hour

#### $millisecondsInMillennium read-only

CarbonImmutable.php : 0
`public int $millisecondsInMillennium`

The number of milliseconds contained in the current millennium

#### $millisecondsInMinute read-only

CarbonImmutable.php : 0
`public int $millisecondsInMinute`

The number of milliseconds contained in the current minute

#### $millisecondsInMonth read-only

CarbonImmutable.php : 0
`public int $millisecondsInMonth`

The number of milliseconds contained in the current month

#### $millisecondsInQuarter read-only

CarbonImmutable.php : 0
`public int $millisecondsInQuarter`

The number of milliseconds contained in the current quarter

#### $millisecondsInSecond read-only

CarbonImmutable.php : 0
`public int $millisecondsInSecond`

The number of milliseconds contained in the current second

#### $millisecondsInWeek read-only

CarbonImmutable.php : 0
`public int $millisecondsInWeek`

The number of milliseconds contained in the current week

#### $millisecondsInYear read-only

CarbonImmutable.php : 0
`public int $millisecondsInYear`

The number of milliseconds contained in the current year

#### $minDayName read-only

CarbonImmutable.php : 0
`public string $minDayName`

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

#### $minute

CarbonImmutable.php : 0
`public int $minute`

#### $minuteOfCentury

CarbonImmutable.php : 0
`public int $minuteOfCentury`

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

#### $minuteOfDay

CarbonImmutable.php : 0
`public int $minuteOfDay`

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

#### $minuteOfDecade

CarbonImmutable.php : 0
`public int $minuteOfDecade`

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

#### $minuteOfHour

CarbonImmutable.php : 0
`public int $minuteOfHour`

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

#### $minuteOfMillennium

CarbonImmutable.php : 0
`public int $minuteOfMillennium`

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

#### $minuteOfMonth

CarbonImmutable.php : 0
`public int $minuteOfMonth`

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

#### $minuteOfQuarter

CarbonImmutable.php : 0
`public int $minuteOfQuarter`

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

#### $minuteOfWeek

CarbonImmutable.php : 0
`public int $minuteOfWeek`

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

#### $minuteOfYear

CarbonImmutable.php : 0
`public int $minuteOfYear`

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

#### $minutesInCentury read-only

CarbonImmutable.php : 0
`public int $minutesInCentury`

The number of minutes contained in the current century

#### $minutesInDay read-only

CarbonImmutable.php : 0
`public int $minutesInDay`

The number of minutes contained in the current day

#### $minutesInDecade read-only

CarbonImmutable.php : 0
`public int $minutesInDecade`

The number of minutes contained in the current decade

#### $minutesInHour read-only

CarbonImmutable.php : 0
`public int $minutesInHour`

The number of minutes contained in the current hour

#### $minutesInMillennium read-only

CarbonImmutable.php : 0
`public int $minutesInMillennium`

The number of minutes contained in the current millennium

#### $minutesInMonth read-only

CarbonImmutable.php : 0
`public int $minutesInMonth`

The number of minutes contained in the current month

#### $minutesInQuarter read-only

CarbonImmutable.php : 0
`public int $minutesInQuarter`

The number of minutes contained in the current quarter

#### $minutesInWeek read-only

CarbonImmutable.php : 0
`public int $minutesInWeek`

The number of minutes contained in the current week

#### $minutesInYear read-only

CarbonImmutable.php : 0
`public int $minutesInYear`

The number of minutes contained in the current year

#### $month

CarbonImmutable.php : 0
`public int $month`

#### $monthName read-only

CarbonImmutable.php : 0
`public string $monthName`

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

#### $monthOfCentury

CarbonImmutable.php : 0
`public int $monthOfCentury`

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

#### $monthOfDecade

CarbonImmutable.php : 0
`public int $monthOfDecade`

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

#### $monthOfMillennium

CarbonImmutable.php : 0
`public int $monthOfMillennium`

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

#### $monthOfQuarter

CarbonImmutable.php : 0
`public int $monthOfQuarter`

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

#### $monthOfYear

CarbonImmutable.php : 0
`public int $monthOfYear`

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

#### $monthsInCentury read-only

CarbonImmutable.php : 0
`public int $monthsInCentury`

The number of months contained in the current century

#### $monthsInDecade read-only

CarbonImmutable.php : 0
`public int $monthsInDecade`

The number of months contained in the current decade

#### $monthsInMillennium read-only

CarbonImmutable.php : 0
`public int $monthsInMillennium`

The number of months contained in the current millennium

#### $monthsInQuarter read-only

CarbonImmutable.php : 0
`public int $monthsInQuarter`

The number of months contained in the current quarter

#### $monthsInYear read-only

CarbonImmutable.php : 0
`public int $monthsInYear`

The number of months contained in the current year

#### $noZeroHour read-only

CarbonImmutable.php : 0
`public int $noZeroHour`

current hour from 1 to 24

#### $offset

CarbonImmutable.php : 0
`public int $offset`

the timezone offset in seconds from UTC

#### $offsetHours

CarbonImmutable.php : 0
`public int $offsetHours`

the timezone offset in hours from UTC

#### $offsetMinutes

CarbonImmutable.php : 0
`public int $offsetMinutes`

the timezone offset in minutes from UTC

#### $quarter read-only

CarbonImmutable.php : 0
`public int $quarter`

the quarter of this instance, 1 - 4

#### $quarterOfCentury

CarbonImmutable.php : 0
`public int $quarterOfCentury`

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

#### $quarterOfDecade

CarbonImmutable.php : 0
`public int $quarterOfDecade`

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

#### $quarterOfMillennium

CarbonImmutable.php : 0
`public int $quarterOfMillennium`

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

#### $quarterOfYear

CarbonImmutable.php : 0
`public int $quarterOfYear`

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

#### $quartersInCentury read-only

CarbonImmutable.php : 0
`public int $quartersInCentury`

The number of quarters contained in the current century

#### $quartersInDecade read-only

CarbonImmutable.php : 0
`public int $quartersInDecade`

The number of quarters contained in the current decade

#### $quartersInMillennium read-only

CarbonImmutable.php : 0
`public int $quartersInMillennium`

The number of quarters contained in the current millennium

#### $quartersInYear read-only

CarbonImmutable.php : 0
`public int $quartersInYear`

The number of quarters contained in the current year

#### $second

CarbonImmutable.php : 0
`public int $second`

#### $secondOfCentury

CarbonImmutable.php : 0
`public int $secondOfCentury`

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

#### $secondOfDay

CarbonImmutable.php : 0
`public int $secondOfDay`

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

#### $secondOfDecade

CarbonImmutable.php : 0
`public int $secondOfDecade`

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

#### $secondOfHour

CarbonImmutable.php : 0
`public int $secondOfHour`

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

#### $secondOfMillennium

CarbonImmutable.php : 0
`public int $secondOfMillennium`

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

#### $secondOfMinute

CarbonImmutable.php : 0
`public int $secondOfMinute`

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

#### $secondOfMonth

CarbonImmutable.php : 0
`public int $secondOfMonth`

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

#### $secondOfQuarter

CarbonImmutable.php : 0
`public int $secondOfQuarter`

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

#### $secondOfWeek

CarbonImmutable.php : 0
`public int $secondOfWeek`

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

#### $secondOfYear

CarbonImmutable.php : 0
`public int $secondOfYear`

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

#### $secondsInCentury read-only

CarbonImmutable.php : 0
`public int $secondsInCentury`

The number of seconds contained in the current century

#### $secondsInDay read-only

CarbonImmutable.php : 0
`public int $secondsInDay`

The number of seconds contained in the current day

#### $secondsInDecade read-only

CarbonImmutable.php : 0
`public int $secondsInDecade`

The number of seconds contained in the current decade

#### $secondsInHour read-only

CarbonImmutable.php : 0
`public int $secondsInHour`

The number of seconds contained in the current hour

#### $secondsInMillennium read-only

CarbonImmutable.php : 0
`public int $secondsInMillennium`

The number of seconds contained in the current millennium

#### $secondsInMinute read-only

CarbonImmutable.php : 0
`public int $secondsInMinute`

The number of seconds contained in the current minute

#### $secondsInMonth read-only

CarbonImmutable.php : 0
`public int $secondsInMonth`

The number of seconds contained in the current month

#### $secondsInQuarter read-only

CarbonImmutable.php : 0
`public int $secondsInQuarter`

The number of seconds contained in the current quarter

#### $secondsInWeek read-only

CarbonImmutable.php : 0
`public int $secondsInWeek`

The number of seconds contained in the current week

#### $secondsInYear read-only

CarbonImmutable.php : 0
`public int $secondsInYear`

The number of seconds contained in the current year

#### $shortDayName read-only

CarbonImmutable.php : 0
`public string $shortDayName`

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

#### $shortEnglishDayOfWeek

CarbonImmutable.php : 0
`public string $shortEnglishDayOfWeek`

the abbreviated day of week in English

#### $shortEnglishMonth

CarbonImmutable.php : 0
`public string $shortEnglishMonth`

the abbreviated month in English

#### $shortLocaleDayOfWeek

CarbonImmutable.php : 0
`public string $shortLocaleDayOfWeek`

the abbreviated day of week in current locale

#### $shortLocaleMonth

CarbonImmutable.php : 0
`public string $shortLocaleMonth`

the abbreviated month in current locale

#### $shortMonthName read-only

CarbonImmutable.php : 0
`public string $shortMonthName`

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

#### $timestamp

CarbonImmutable.php : 0
`public int|float|string $timestamp`

seconds since the Unix Epoch

#### $timezone

CarbonImmutable.php : 0
`public CarbonTimeZone $timezone`

the current timezone

#### $timezoneAbbreviatedName read-only

CarbonImmutable.php : 0
`public string $timezoneAbbreviatedName`

the current timezone abbreviated name

#### $timezoneName read-only

CarbonImmutable.php : 0
`public string $timezoneName`

the current timezone name

#### $tz

CarbonImmutable.php : 0
`public CarbonTimeZone $tz`

alias of $timezone

#### $tzAbbrName read-only

CarbonImmutable.php : 0
`public string $tzAbbrName`

alias of $timezoneAbbreviatedName

#### $tzName read-only

CarbonImmutable.php : 0
`public string $tzName`

alias of $timezoneName

#### $upperMeridiem read-only

CarbonImmutable.php : 0
`public string $upperMeridiem`

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

#### $utc read-only

CarbonImmutable.php : 0
`public bool $utc`

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

#### $week

CarbonImmutable.php : 0
`public int $week`

1 through 53

#### $weekNumberInMonth read-only

CarbonImmutable.php : 0
`public int $weekNumberInMonth`

1 through 5

#### $weekOfCentury

CarbonImmutable.php : 0
`public int $weekOfCentury`

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

#### $weekOfDecade

CarbonImmutable.php : 0
`public int $weekOfDecade`

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

#### $weekOfMillennium

CarbonImmutable.php : 0
`public int $weekOfMillennium`

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

#### $weekOfMonth

CarbonImmutable.php : 0
`public int $weekOfMonth`

1 through 5

#### $weekOfQuarter

CarbonImmutable.php : 0
`public int $weekOfQuarter`

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

#### $weekOfYear

CarbonImmutable.php : 0
`public int $weekOfYear`

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

#### $weeksInCentury read-only

CarbonImmutable.php : 0
`public int $weeksInCentury`

The number of weeks contained in the current century

#### $weeksInDecade read-only

CarbonImmutable.php : 0
`public int $weeksInDecade`

The number of weeks contained in the current decade

#### $weeksInMillennium read-only

CarbonImmutable.php : 0
`public int $weeksInMillennium`

The number of weeks contained in the current millennium

#### $weeksInMonth read-only

CarbonImmutable.php : 0
`public int $weeksInMonth`

The number of weeks contained in the current month

#### $weeksInQuarter read-only

CarbonImmutable.php : 0
`public int $weeksInQuarter`

The number of weeks contained in the current quarter

#### $weeksInYear read-only

CarbonImmutable.php : 0
`public int $weeksInYear`

51 through 53

#### $weekYear

CarbonImmutable.php : 0
`public int $weekYear`

year according to week format

#### $year

CarbonImmutable.php : 0
`public int $year`

#### $yearIso

CarbonImmutable.php : 0
`public int $yearIso`

#### $yearOfCentury

CarbonImmutable.php : 0
`public int $yearOfCentury`

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

#### $yearOfDecade

CarbonImmutable.php : 0
`public int $yearOfDecade`

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

#### $yearOfMillennium

CarbonImmutable.php : 0
`public int $yearOfMillennium`

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

#### $yearsInCentury read-only

CarbonImmutable.php : 0
`public int $yearsInCentury`

The number of years contained in the current century

#### $yearsInDecade read-only

CarbonImmutable.php : 0
`public int $yearsInDecade`

The number of years contained in the current decade

#### $yearsInMillennium read-only

CarbonImmutable.php : 0
`public int $yearsInMillennium`

The number of years contained in the current millennium

#### $days

Date.php : 888

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

Date.php : 910

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

Date.php : 2585

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

Date.php : 2471

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

#### __clone()

CarbonImmutable.php : 842

Update constructedObjectId on cloned.

`public __clone() : void`

#### __get()

Date.php : 1074

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

Date.php : 1359

Check if an attribute exists on the object

`public __isset(string $name) : bool`

##### Parameters

$name : string

##### Return values

bool

#### __set()

Date.php : 1380

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

CarbonImmutable.php : 0
`public addCenturies(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addCenturiesNoOverflow()

CarbonImmutable.php : 0
`public addCenturiesNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addCenturiesWithNoOverflow()

CarbonImmutable.php : 0
`public addCenturiesWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addCenturiesWithoutOverflow()

CarbonImmutable.php : 0
`public addCenturiesWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addCenturiesWithOverflow()

CarbonImmutable.php : 0
`public addCenturiesWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addCentury()

CarbonImmutable.php : 0
`public addCentury() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addCenturyNoOverflow()

CarbonImmutable.php : 0
`public addCenturyNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addCenturyWithNoOverflow()

CarbonImmutable.php : 0
`public addCenturyWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addCenturyWithoutOverflow()

CarbonImmutable.php : 0
`public addCenturyWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addCenturyWithOverflow()

CarbonImmutable.php : 0
`public addCenturyWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDay()

CarbonImmutable.php : 0
`public addDay() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDays()

CarbonImmutable.php : 0
`public addDays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecade()

CarbonImmutable.php : 0
`public addDecade() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDecadeNoOverflow()

CarbonImmutable.php : 0
`public addDecadeNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDecades()

CarbonImmutable.php : 0
`public addDecades(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecadesNoOverflow()

CarbonImmutable.php : 0
`public addDecadesNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecadesWithNoOverflow()

CarbonImmutable.php : 0
`public addDecadesWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecadesWithoutOverflow()

CarbonImmutable.php : 0
`public addDecadesWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecadesWithOverflow()

CarbonImmutable.php : 0
`public addDecadesWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addDecadeWithNoOverflow()

CarbonImmutable.php : 0
`public addDecadeWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDecadeWithoutOverflow()

CarbonImmutable.php : 0
`public addDecadeWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addDecadeWithOverflow()

CarbonImmutable.php : 0
`public addDecadeWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addHour()

CarbonImmutable.php : 0
`public addHour() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addHours()

CarbonImmutable.php : 0
`public addHours(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMicro()

CarbonImmutable.php : 0
`public addMicro() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMicros()

CarbonImmutable.php : 0
`public addMicros(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMicrosecond()

CarbonImmutable.php : 0
`public addMicrosecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMicroseconds()

CarbonImmutable.php : 0
`public addMicroseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillennia()

CarbonImmutable.php : 0
`public addMillennia(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillenniaNoOverflow()

CarbonImmutable.php : 0
`public addMillenniaNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillenniaWithNoOverflow()

CarbonImmutable.php : 0
`public addMillenniaWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillenniaWithoutOverflow()

CarbonImmutable.php : 0
`public addMillenniaWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillenniaWithOverflow()

CarbonImmutable.php : 0
`public addMillenniaWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillennium()

CarbonImmutable.php : 0
`public addMillennium() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMillenniumNoOverflow()

CarbonImmutable.php : 0
`public addMillenniumNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMillenniumWithNoOverflow()

CarbonImmutable.php : 0
`public addMillenniumWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMillenniumWithoutOverflow()

CarbonImmutable.php : 0
`public addMillenniumWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMillenniumWithOverflow()

CarbonImmutable.php : 0
`public addMillenniumWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMilli()

CarbonImmutable.php : 0
`public addMilli() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMillis()

CarbonImmutable.php : 0
`public addMillis(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMillisecond()

CarbonImmutable.php : 0
`public addMillisecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMilliseconds()

CarbonImmutable.php : 0
`public addMilliseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMinute()

CarbonImmutable.php : 0
`public addMinute() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMinutes()

CarbonImmutable.php : 0
`public addMinutes(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonth()

CarbonImmutable.php : 0
`public addMonth() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMonthNoOverflow()

CarbonImmutable.php : 0
`public addMonthNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMonths()

CarbonImmutable.php : 0
`public addMonths(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonthsNoOverflow()

CarbonImmutable.php : 0
`public addMonthsNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonthsWithNoOverflow()

CarbonImmutable.php : 0
`public addMonthsWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonthsWithoutOverflow()

CarbonImmutable.php : 0
`public addMonthsWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonthsWithOverflow()

CarbonImmutable.php : 0
`public addMonthsWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addMonthWithNoOverflow()

CarbonImmutable.php : 0
`public addMonthWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMonthWithoutOverflow()

CarbonImmutable.php : 0
`public addMonthWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addMonthWithOverflow()

CarbonImmutable.php : 0
`public addMonthWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addQuarter()

CarbonImmutable.php : 0
`public addQuarter() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addQuarterNoOverflow()

CarbonImmutable.php : 0
`public addQuarterNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addQuarters()

CarbonImmutable.php : 0
`public addQuarters(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addQuartersNoOverflow()

CarbonImmutable.php : 0
`public addQuartersNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addQuartersWithNoOverflow()

CarbonImmutable.php : 0
`public addQuartersWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addQuartersWithoutOverflow()

CarbonImmutable.php : 0
`public addQuartersWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addQuartersWithOverflow()

CarbonImmutable.php : 0
`public addQuartersWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addQuarterWithNoOverflow()

CarbonImmutable.php : 0
`public addQuarterWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addQuarterWithoutOverflow()

CarbonImmutable.php : 0
`public addQuarterWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addQuarterWithOverflow()

CarbonImmutable.php : 0
`public addQuarterWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addSecond()

CarbonImmutable.php : 0
`public addSecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addSeconds()

CarbonImmutable.php : 0
`public addSeconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUnitNoOverflow()

Date.php : 1730

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

CarbonImmutable.php : 0
`public addUTCCenturies(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCCentury()

CarbonImmutable.php : 0
`public addUTCCentury() : CarbonImmutable`

Add one century to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCDay()

CarbonImmutable.php : 0
`public addUTCDay() : CarbonImmutable`

Add one day to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCDays()

CarbonImmutable.php : 0
`public addUTCDays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCDecade()

CarbonImmutable.php : 0
`public addUTCDecade() : CarbonImmutable`

Add one decade to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCDecades()

CarbonImmutable.php : 0
`public addUTCDecades(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCHour()

CarbonImmutable.php : 0
`public addUTCHour() : CarbonImmutable`

Add one hour to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCHours()

CarbonImmutable.php : 0
`public addUTCHours(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMicro()

CarbonImmutable.php : 0
`public addUTCMicro() : CarbonImmutable`

Add one microsecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMicros()

CarbonImmutable.php : 0
`public addUTCMicros(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMicrosecond()

CarbonImmutable.php : 0
`public addUTCMicrosecond() : CarbonImmutable`

Add one microsecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMicroseconds()

CarbonImmutable.php : 0
`public addUTCMicroseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMillennia()

CarbonImmutable.php : 0
`public addUTCMillennia(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMillennium()

CarbonImmutable.php : 0
`public addUTCMillennium() : CarbonImmutable`

Add one millennium to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMilli()

CarbonImmutable.php : 0
`public addUTCMilli() : CarbonImmutable`

Add one millisecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMillis()

CarbonImmutable.php : 0
`public addUTCMillis(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMillisecond()

CarbonImmutable.php : 0
`public addUTCMillisecond() : CarbonImmutable`

Add one millisecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMilliseconds()

CarbonImmutable.php : 0
`public addUTCMilliseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMinute()

CarbonImmutable.php : 0
`public addUTCMinute() : CarbonImmutable`

Add one minute to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMinutes()

CarbonImmutable.php : 0
`public addUTCMinutes(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCMonth()

CarbonImmutable.php : 0
`public addUTCMonth() : CarbonImmutable`

Add one month to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCMonths()

CarbonImmutable.php : 0
`public addUTCMonths(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCQuarter()

CarbonImmutable.php : 0
`public addUTCQuarter() : CarbonImmutable`

Add one quarter to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCQuarters()

CarbonImmutable.php : 0
`public addUTCQuarters(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCSecond()

CarbonImmutable.php : 0
`public addUTCSecond() : CarbonImmutable`

Add one second to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCSeconds()

CarbonImmutable.php : 0
`public addUTCSeconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCWeek()

CarbonImmutable.php : 0
`public addUTCWeek() : CarbonImmutable`

Add one week to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCWeeks()

CarbonImmutable.php : 0
`public addUTCWeeks(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addUTCYear()

CarbonImmutable.php : 0
`public addUTCYear() : CarbonImmutable`

Add one year to the instance (using timestamp).

##### Return values

CarbonImmutable

#### addUTCYears()

CarbonImmutable.php : 0
`public addUTCYears(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addWeek()

CarbonImmutable.php : 0
`public addWeek() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addWeekday()

CarbonImmutable.php : 0
`public addWeekday() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addWeekdays()

CarbonImmutable.php : 0
`public addWeekdays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addWeeks()

CarbonImmutable.php : 0
`public addWeeks(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYear()

CarbonImmutable.php : 0
`public addYear() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addYearNoOverflow()

CarbonImmutable.php : 0
`public addYearNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addYears()

CarbonImmutable.php : 0
`public addYears(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYearsNoOverflow()

CarbonImmutable.php : 0
`public addYearsNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYearsWithNoOverflow()

CarbonImmutable.php : 0
`public addYearsWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYearsWithoutOverflow()

CarbonImmutable.php : 0
`public addYearsWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYearsWithOverflow()

CarbonImmutable.php : 0
`public addYearsWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### addYearWithNoOverflow()

CarbonImmutable.php : 0
`public addYearWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addYearWithoutOverflow()

CarbonImmutable.php : 0
`public addYearWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### addYearWithOverflow()

CarbonImmutable.php : 0
`public addYearWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### avoidMutation()

Date.php : 1021

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

Date.php : 1050

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

CarbonImmutable.php : 0
`public ceilCenturies(float $precision = 1) : CarbonImmutable`

Ceil the current instance century with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilCentury()

CarbonImmutable.php : 0
`public ceilCentury(float $precision = 1) : CarbonImmutable`

Ceil the current instance century with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilDay()

CarbonImmutable.php : 0
`public ceilDay(float $precision = 1) : CarbonImmutable`

Ceil the current instance day with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilDays()

CarbonImmutable.php : 0
`public ceilDays(float $precision = 1) : CarbonImmutable`

Ceil the current instance day with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilDecade()

CarbonImmutable.php : 0
`public ceilDecade(float $precision = 1) : CarbonImmutable`

Ceil the current instance decade with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilDecades()

CarbonImmutable.php : 0
`public ceilDecades(float $precision = 1) : CarbonImmutable`

Ceil the current instance decade with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilHour()

CarbonImmutable.php : 0
`public ceilHour(float $precision = 1) : CarbonImmutable`

Ceil the current instance hour with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilHours()

CarbonImmutable.php : 0
`public ceilHours(float $precision = 1) : CarbonImmutable`

Ceil the current instance hour with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMicrosecond()

CarbonImmutable.php : 0
`public ceilMicrosecond(float $precision = 1) : CarbonImmutable`

Ceil the current instance microsecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMicroseconds()

CarbonImmutable.php : 0
`public ceilMicroseconds(float $precision = 1) : CarbonImmutable`

Ceil the current instance microsecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMillennia()

CarbonImmutable.php : 0
`public ceilMillennia(float $precision = 1) : CarbonImmutable`

Ceil the current instance millennium with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMillennium()

CarbonImmutable.php : 0
`public ceilMillennium(float $precision = 1) : CarbonImmutable`

Ceil the current instance millennium with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMillisecond()

CarbonImmutable.php : 0
`public ceilMillisecond(float $precision = 1) : CarbonImmutable`

Ceil the current instance millisecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMilliseconds()

CarbonImmutable.php : 0
`public ceilMilliseconds(float $precision = 1) : CarbonImmutable`

Ceil the current instance millisecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMinute()

CarbonImmutable.php : 0
`public ceilMinute(float $precision = 1) : CarbonImmutable`

Ceil the current instance minute with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMinutes()

CarbonImmutable.php : 0
`public ceilMinutes(float $precision = 1) : CarbonImmutable`

Ceil the current instance minute with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMonth()

CarbonImmutable.php : 0
`public ceilMonth(float $precision = 1) : CarbonImmutable`

Ceil the current instance month with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilMonths()

CarbonImmutable.php : 0
`public ceilMonths(float $precision = 1) : CarbonImmutable`

Ceil the current instance month with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilQuarter()

CarbonImmutable.php : 0
`public ceilQuarter(float $precision = 1) : CarbonImmutable`

Ceil the current instance quarter with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilQuarters()

CarbonImmutable.php : 0
`public ceilQuarters(float $precision = 1) : CarbonImmutable`

Ceil the current instance quarter with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilSecond()

CarbonImmutable.php : 0
`public ceilSecond(float $precision = 1) : CarbonImmutable`

Ceil the current instance second with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilSeconds()

CarbonImmutable.php : 0
`public ceilSeconds(float $precision = 1) : CarbonImmutable`

Ceil the current instance second with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilYear()

CarbonImmutable.php : 0
`public ceilYear(float $precision = 1) : CarbonImmutable`

Ceil the current instance year with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### ceilYears()

CarbonImmutable.php : 0
`public ceilYears(float $precision = 1) : CarbonImmutable`

Ceil the current instance year with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### centuriesInMillennium()

CarbonImmutable.php : 0
`public centuriesInMillennium() : int`

Return the number of centuries contained in the current millennium

##### Return values

int

#### centuriesUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

Date.php : 1008
`public clone() : static`

##### Tags

alias

  copy

  Get a copy of the instance.

##### Return values

static

#### copy()

Date.php : 996

Get a copy of the instance.

`public copy() : static`

##### Return values

static

#### day()

CarbonImmutable.php : 0
`public day(int $value) : CarbonImmutable`

Set current instance day to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### dayOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

Date.php : 1630

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

CarbonImmutable.php : 0
`public days(int $value) : CarbonImmutable`

Set current instance day to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### daysInCentury()

CarbonImmutable.php : 0
`public daysInCentury() : int`

Return the number of days contained in the current century

##### Return values

int

#### daysInDecade()

CarbonImmutable.php : 0
`public daysInDecade() : int`

Return the number of days contained in the current decade

##### Return values

int

#### daysInMillennium()

CarbonImmutable.php : 0
`public daysInMillennium() : int`

Return the number of days contained in the current millennium

##### Return values

int

#### daysInMonth()

CarbonImmutable.php : 0
`public daysInMonth() : int`

Return the number of days contained in the current month

##### Return values

int

#### daysInQuarter()

CarbonImmutable.php : 0
`public daysInQuarter() : int`

Return the number of days contained in the current quarter

##### Return values

int

#### daysInWeek()

CarbonImmutable.php : 0
`public daysInWeek() : int`

Return the number of days contained in the current week

##### Return values

int

#### daysInYear()

CarbonImmutable.php : 0
`public daysInYear() : int`

Return the number of days contained in the current year

##### Return values

int

#### daysUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public decadesInCentury() : int`

Return the number of decades contained in the current century

##### Return values

int

#### decadesInMillennium()

CarbonImmutable.php : 0
`public decadesInMillennium() : int`

Return the number of decades contained in the current millennium

##### Return values

int

#### decadesUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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

#### endOfTime()

CarbonImmutable.php : 867

Create a very far date representing end of time.

`public static endOfTime() : static`

##### Return values

static

#### floorCenturies()

CarbonImmutable.php : 0
`public floorCenturies(float $precision = 1) : CarbonImmutable`

Truncate the current instance century with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorCentury()

CarbonImmutable.php : 0
`public floorCentury(float $precision = 1) : CarbonImmutable`

Truncate the current instance century with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorDay()

CarbonImmutable.php : 0
`public floorDay(float $precision = 1) : CarbonImmutable`

Truncate the current instance day with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorDays()

CarbonImmutable.php : 0
`public floorDays(float $precision = 1) : CarbonImmutable`

Truncate the current instance day with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorDecade()

CarbonImmutable.php : 0
`public floorDecade(float $precision = 1) : CarbonImmutable`

Truncate the current instance decade with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorDecades()

CarbonImmutable.php : 0
`public floorDecades(float $precision = 1) : CarbonImmutable`

Truncate the current instance decade with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorHour()

CarbonImmutable.php : 0
`public floorHour(float $precision = 1) : CarbonImmutable`

Truncate the current instance hour with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorHours()

CarbonImmutable.php : 0
`public floorHours(float $precision = 1) : CarbonImmutable`

Truncate the current instance hour with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMicrosecond()

CarbonImmutable.php : 0
`public floorMicrosecond(float $precision = 1) : CarbonImmutable`

Truncate the current instance microsecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMicroseconds()

CarbonImmutable.php : 0
`public floorMicroseconds(float $precision = 1) : CarbonImmutable`

Truncate the current instance microsecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMillennia()

CarbonImmutable.php : 0
`public floorMillennia(float $precision = 1) : CarbonImmutable`

Truncate the current instance millennium with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMillennium()

CarbonImmutable.php : 0
`public floorMillennium(float $precision = 1) : CarbonImmutable`

Truncate the current instance millennium with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMillisecond()

CarbonImmutable.php : 0
`public floorMillisecond(float $precision = 1) : CarbonImmutable`

Truncate the current instance millisecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMilliseconds()

CarbonImmutable.php : 0
`public floorMilliseconds(float $precision = 1) : CarbonImmutable`

Truncate the current instance millisecond with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMinute()

CarbonImmutable.php : 0
`public floorMinute(float $precision = 1) : CarbonImmutable`

Truncate the current instance minute with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMinutes()

CarbonImmutable.php : 0
`public floorMinutes(float $precision = 1) : CarbonImmutable`

Truncate the current instance minute with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMonth()

CarbonImmutable.php : 0
`public floorMonth(float $precision = 1) : CarbonImmutable`

Truncate the current instance month with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorMonths()

CarbonImmutable.php : 0
`public floorMonths(float $precision = 1) : CarbonImmutable`

Truncate the current instance month with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorQuarter()

CarbonImmutable.php : 0
`public floorQuarter(float $precision = 1) : CarbonImmutable`

Truncate the current instance quarter with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorQuarters()

CarbonImmutable.php : 0
`public floorQuarters(float $precision = 1) : CarbonImmutable`

Truncate the current instance quarter with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorSecond()

CarbonImmutable.php : 0
`public floorSecond(float $precision = 1) : CarbonImmutable`

Truncate the current instance second with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorSeconds()

CarbonImmutable.php : 0
`public floorSeconds(float $precision = 1) : CarbonImmutable`

Truncate the current instance second with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorYear()

CarbonImmutable.php : 0
`public floorYear(float $precision = 1) : CarbonImmutable`

Truncate the current instance year with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### floorYears()

CarbonImmutable.php : 0
`public floorYears(float $precision = 1) : CarbonImmutable`

Truncate the current instance year with given precision.

##### Parameters

$precision = 1 : float

##### Return values

CarbonImmutable

#### get()

Date.php : 1086

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

Date.php : 2218

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

Date.php : 2028

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

Date.php : 1909

Get the days of the week.

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

##### Return values

array<string|int, mixed>

#### getDaysFromStartOfWeek()

Date.php : 1674

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

Date.php : 2319

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

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

##### Return values

array<string|int, mixed>

#### getIsoFormats()

Date.php : 2007

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

Date.php : 2043

Returns list of locale units for ISO formatting.

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

##### Return values

array<string|int, mixed>

#### getOffsetString()

Date.php : 2452

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

Date.php : 2156

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

#### getTimezone()

Date.php : 965

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

`public getTimezone() : CarbonTimeZone`

##### Tags

link
  https://php.net/manual/en/datetime.gettimezone.php

##### Return values

CarbonTimeZone

#### getTranslatedDayName()

Date.php : 1564

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

Date.php : 1587

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

Date.php : 1599

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

Date.php : 1577

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

Date.php : 1612

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

Date.php : 1946

Get weekend days

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

##### Return values

array<string|int, mixed>

#### getWeekEndsAt()

Date.php : 1938

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

Date.php : 1923

Get the first day of week.

`public static getWeekStartsAt([string|null $locale = null ]) : int`

##### Parameters

$locale : string|null = null

##### Return values

int

#### hasRelativeKeywords()

Date.php : 1984

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

CarbonImmutable.php : 0
`public hour(int $value) : CarbonImmutable`

Set current instance hour to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### hourOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public hours(int $value) : CarbonImmutable`

Set current instance hour to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### hoursInCentury()

CarbonImmutable.php : 0
`public hoursInCentury() : int`

Return the number of hours contained in the current century

##### Return values

int

#### hoursInDay()

CarbonImmutable.php : 0
`public hoursInDay() : int`

Return the number of hours contained in the current day

##### Return values

int

#### hoursInDecade()

CarbonImmutable.php : 0
`public hoursInDecade() : int`

Return the number of hours contained in the current decade

##### Return values

int

#### hoursInMillennium()

CarbonImmutable.php : 0
`public hoursInMillennium() : int`

Return the number of hours contained in the current millennium

##### Return values

int

#### hoursInMonth()

CarbonImmutable.php : 0
`public hoursInMonth() : int`

Return the number of hours contained in the current month

##### Return values

int

#### hoursInQuarter()

CarbonImmutable.php : 0
`public hoursInQuarter() : int`

Return the number of hours contained in the current quarter

##### Return values

int

#### hoursInWeek()

CarbonImmutable.php : 0
`public hoursInWeek() : int`

Return the number of hours contained in the current week

##### Return values

int

#### hoursInYear()

CarbonImmutable.php : 0
`public hoursInYear() : int`

Return the number of hours contained in the current year

##### Return values

int

#### hoursUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public isCurrentCentury() : bool`

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

##### Return values

bool

#### isCurrentDay()

CarbonImmutable.php : 0
`public isCurrentDay() : bool`

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

##### Return values

bool

#### isCurrentDecade()

CarbonImmutable.php : 0
`public isCurrentDecade() : bool`

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

##### Return values

bool

#### isCurrentHour()

CarbonImmutable.php : 0
`public isCurrentHour() : bool`

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

##### Return values

bool

#### isCurrentMicro()

CarbonImmutable.php : 0
`public isCurrentMicro() : bool`

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

##### Return values

bool

#### isCurrentMicrosecond()

CarbonImmutable.php : 0
`public isCurrentMicrosecond() : bool`

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

##### Return values

bool

#### isCurrentMillennium()

CarbonImmutable.php : 0
`public isCurrentMillennium() : bool`

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

##### Return values

bool

#### isCurrentMilli()

CarbonImmutable.php : 0
`public isCurrentMilli() : bool`

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

##### Return values

bool

#### isCurrentMillisecond()

CarbonImmutable.php : 0
`public isCurrentMillisecond() : bool`

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

##### Return values

bool

#### isCurrentMinute()

CarbonImmutable.php : 0
`public isCurrentMinute() : bool`

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

##### Return values

bool

#### isCurrentMonth()

CarbonImmutable.php : 0
`public isCurrentMonth() : bool`

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

##### Return values

bool

#### isCurrentQuarter()

CarbonImmutable.php : 0
`public isCurrentQuarter() : bool`

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

##### Return values

bool

#### isCurrentSecond()

CarbonImmutable.php : 0
`public isCurrentSecond() : bool`

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

##### Return values

bool

#### isCurrentWeek()

CarbonImmutable.php : 0
`public isCurrentWeek() : bool`

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

##### Return values

bool

#### isCurrentYear()

CarbonImmutable.php : 0
`public isCurrentYear() : bool`

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

##### Return values

bool

#### isDST()

CarbonImmutable.php : 0
`public isDST() : bool`

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

##### Return values

bool

#### isFriday()

CarbonImmutable.php : 0
`public isFriday() : bool`

Checks if the instance day is friday.

##### Return values

bool

#### isLastCentury()

CarbonImmutable.php : 0
`public isLastCentury() : bool`

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

##### Return values

bool

#### isLastDay()

CarbonImmutable.php : 0
`public isLastDay() : bool`

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

##### Return values

bool

#### isLastDecade()

CarbonImmutable.php : 0
`public isLastDecade() : bool`

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

##### Return values

bool

#### isLastHour()

CarbonImmutable.php : 0
`public isLastHour() : bool`

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

##### Return values

bool

#### isLastMicro()

CarbonImmutable.php : 0
`public isLastMicro() : bool`

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

##### Return values

bool

#### isLastMicrosecond()

CarbonImmutable.php : 0
`public isLastMicrosecond() : bool`

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

##### Return values

bool

#### isLastMillennium()

CarbonImmutable.php : 0
`public isLastMillennium() : bool`

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

##### Return values

bool

#### isLastMilli()

CarbonImmutable.php : 0
`public isLastMilli() : bool`

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

##### Return values

bool

#### isLastMillisecond()

CarbonImmutable.php : 0
`public isLastMillisecond() : bool`

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

##### Return values

bool

#### isLastMinute()

CarbonImmutable.php : 0
`public isLastMinute() : bool`

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

##### Return values

bool

#### isLastMonth()

CarbonImmutable.php : 0
`public isLastMonth() : bool`

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

##### Return values

bool

#### isLastQuarter()

CarbonImmutable.php : 0
`public isLastQuarter() : bool`

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

##### Return values

bool

#### isLastSecond()

CarbonImmutable.php : 0
`public isLastSecond() : bool`

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

##### Return values

bool

#### isLastWeek()

CarbonImmutable.php : 0
`public isLastWeek() : bool`

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

##### Return values

bool

#### isLastYear()

CarbonImmutable.php : 0
`public isLastYear() : bool`

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

##### Return values

bool

#### isLocal()

CarbonImmutable.php : 0
`public isLocal() : bool`

Check if the current instance has non-UTC timezone.

##### Return values

bool

#### isMonday()

CarbonImmutable.php : 0
`public isMonday() : bool`

Checks if the instance day is monday.

##### Return values

bool

#### isNextCentury()

CarbonImmutable.php : 0
`public isNextCentury() : bool`

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

##### Return values

bool

#### isNextDay()

CarbonImmutable.php : 0
`public isNextDay() : bool`

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

##### Return values

bool

#### isNextDecade()

CarbonImmutable.php : 0
`public isNextDecade() : bool`

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

##### Return values

bool

#### isNextHour()

CarbonImmutable.php : 0
`public isNextHour() : bool`

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

##### Return values

bool

#### isNextMicro()

CarbonImmutable.php : 0
`public isNextMicro() : bool`

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

##### Return values

bool

#### isNextMicrosecond()

CarbonImmutable.php : 0
`public isNextMicrosecond() : bool`

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

##### Return values

bool

#### isNextMillennium()

CarbonImmutable.php : 0
`public isNextMillennium() : bool`

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

##### Return values

bool

#### isNextMilli()

CarbonImmutable.php : 0
`public isNextMilli() : bool`

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

##### Return values

bool

#### isNextMillisecond()

CarbonImmutable.php : 0
`public isNextMillisecond() : bool`

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

##### Return values

bool

#### isNextMinute()

CarbonImmutable.php : 0
`public isNextMinute() : bool`

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

##### Return values

bool

#### isNextMonth()

CarbonImmutable.php : 0
`public isNextMonth() : bool`

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

##### Return values

bool

#### isNextQuarter()

CarbonImmutable.php : 0
`public isNextQuarter() : bool`

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

##### Return values

bool

#### isNextSecond()

CarbonImmutable.php : 0
`public isNextSecond() : bool`

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

##### Return values

bool

#### isNextWeek()

CarbonImmutable.php : 0
`public isNextWeek() : bool`

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

##### Return values

bool

#### isNextYear()

CarbonImmutable.php : 0
`public isNextYear() : bool`

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

##### Return values

bool

#### isoFormat()

Date.php : 2228

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

Date.php : 1659

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

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public isSaturday() : bool`

Checks if the instance day is saturday.

##### Return values

bool

#### isSunday()

CarbonImmutable.php : 0
`public isSunday() : bool`

Checks if the instance day is sunday.

##### Return values

bool

#### isThursday()

CarbonImmutable.php : 0
`public isThursday() : bool`

Checks if the instance day is thursday.

##### Return values

bool

#### isTuesday()

CarbonImmutable.php : 0
`public isTuesday() : bool`

Checks if the instance day is tuesday.

##### Return values

bool

#### isUtc()

CarbonImmutable.php : 0
`public isUtc() : bool`

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

##### Return values

bool

#### isValid()

CarbonImmutable.php : 0
`public isValid() : bool`

Check if the current instance is a valid date.

##### Return values

bool

#### isWednesday()

CarbonImmutable.php : 0
`public isWednesday() : bool`

Checks if the instance day is wednesday.

##### Return values

bool

#### longAbsoluteDiffForHumans()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

Date.php : 2180

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

CarbonImmutable.php : 0
`public micro(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### micros()

CarbonImmutable.php : 0
`public micros(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### microsecond()

CarbonImmutable.php : 0
`public microsecond(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### microsecondOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public microseconds(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### microsecondsInCentury()

CarbonImmutable.php : 0
`public microsecondsInCentury() : int`

Return the number of microseconds contained in the current century

##### Return values

int

#### microsecondsInDay()

CarbonImmutable.php : 0
`public microsecondsInDay() : int`

Return the number of microseconds contained in the current day

##### Return values

int

#### microsecondsInDecade()

CarbonImmutable.php : 0
`public microsecondsInDecade() : int`

Return the number of microseconds contained in the current decade

##### Return values

int

#### microsecondsInHour()

CarbonImmutable.php : 0
`public microsecondsInHour() : int`

Return the number of microseconds contained in the current hour

##### Return values

int

#### microsecondsInMillennium()

CarbonImmutable.php : 0
`public microsecondsInMillennium() : int`

Return the number of microseconds contained in the current millennium

##### Return values

int

#### microsecondsInMillisecond()

CarbonImmutable.php : 0
`public microsecondsInMillisecond() : int`

Return the number of microseconds contained in the current millisecond

##### Return values

int

#### microsecondsInMinute()

CarbonImmutable.php : 0
`public microsecondsInMinute() : int`

Return the number of microseconds contained in the current minute

##### Return values

int

#### microsecondsInMonth()

CarbonImmutable.php : 0
`public microsecondsInMonth() : int`

Return the number of microseconds contained in the current month

##### Return values

int

#### microsecondsInQuarter()

CarbonImmutable.php : 0
`public microsecondsInQuarter() : int`

Return the number of microseconds contained in the current quarter

##### Return values

int

#### microsecondsInSecond()

CarbonImmutable.php : 0
`public microsecondsInSecond() : int`

Return the number of microseconds contained in the current second

##### Return values

int

#### microsecondsInWeek()

CarbonImmutable.php : 0
`public microsecondsInWeek() : int`

Return the number of microseconds contained in the current week

##### Return values

int

#### microsecondsInYear()

CarbonImmutable.php : 0
`public microsecondsInYear() : int`

Return the number of microseconds contained in the current year

##### Return values

int

#### microsecondsUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public milli(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### millis()

CarbonImmutable.php : 0
`public millis(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### millisecond()

CarbonImmutable.php : 0
`public millisecond(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### millisecondOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public milliseconds(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### millisecondsInCentury()

CarbonImmutable.php : 0
`public millisecondsInCentury() : int`

Return the number of milliseconds contained in the current century

##### Return values

int

#### millisecondsInDay()

CarbonImmutable.php : 0
`public millisecondsInDay() : int`

Return the number of milliseconds contained in the current day

##### Return values

int

#### millisecondsInDecade()

CarbonImmutable.php : 0
`public millisecondsInDecade() : int`

Return the number of milliseconds contained in the current decade

##### Return values

int

#### millisecondsInHour()

CarbonImmutable.php : 0
`public millisecondsInHour() : int`

Return the number of milliseconds contained in the current hour

##### Return values

int

#### millisecondsInMillennium()

CarbonImmutable.php : 0
`public millisecondsInMillennium() : int`

Return the number of milliseconds contained in the current millennium

##### Return values

int

#### millisecondsInMinute()

CarbonImmutable.php : 0
`public millisecondsInMinute() : int`

Return the number of milliseconds contained in the current minute

##### Return values

int

#### millisecondsInMonth()

CarbonImmutable.php : 0
`public millisecondsInMonth() : int`

Return the number of milliseconds contained in the current month

##### Return values

int

#### millisecondsInQuarter()

CarbonImmutable.php : 0
`public millisecondsInQuarter() : int`

Return the number of milliseconds contained in the current quarter

##### Return values

int

#### millisecondsInSecond()

CarbonImmutable.php : 0
`public millisecondsInSecond() : int`

Return the number of milliseconds contained in the current second

##### Return values

int

#### millisecondsInWeek()

CarbonImmutable.php : 0
`public millisecondsInWeek() : int`

Return the number of milliseconds contained in the current week

##### Return values

int

#### millisecondsInYear()

CarbonImmutable.php : 0
`public millisecondsInYear() : int`

Return the number of milliseconds contained in the current year

##### Return values

int

#### millisecondsUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public minute(int $value) : CarbonImmutable`

Set current instance minute to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### minuteOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public minutes(int $value) : CarbonImmutable`

Set current instance minute to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### minutesInCentury()

CarbonImmutable.php : 0
`public minutesInCentury() : int`

Return the number of minutes contained in the current century

##### Return values

int

#### minutesInDay()

CarbonImmutable.php : 0
`public minutesInDay() : int`

Return the number of minutes contained in the current day

##### Return values

int

#### minutesInDecade()

CarbonImmutable.php : 0
`public minutesInDecade() : int`

Return the number of minutes contained in the current decade

##### Return values

int

#### minutesInHour()

CarbonImmutable.php : 0
`public minutesInHour() : int`

Return the number of minutes contained in the current hour

##### Return values

int

#### minutesInMillennium()

CarbonImmutable.php : 0
`public minutesInMillennium() : int`

Return the number of minutes contained in the current millennium

##### Return values

int

#### minutesInMonth()

CarbonImmutable.php : 0
`public minutesInMonth() : int`

Return the number of minutes contained in the current month

##### Return values

int

#### minutesInQuarter()

CarbonImmutable.php : 0
`public minutesInQuarter() : int`

Return the number of minutes contained in the current quarter

##### Return values

int

#### minutesInWeek()

CarbonImmutable.php : 0
`public minutesInWeek() : int`

Return the number of minutes contained in the current week

##### Return values

int

#### minutesInYear()

CarbonImmutable.php : 0
`public minutesInYear() : int`

Return the number of minutes contained in the current year

##### Return values

int

#### minutesUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public month(Month|int $value) : CarbonImmutable`

Set current instance month to the given value.

##### Parameters

$value : Month|int

##### Return values

CarbonImmutable

#### monthOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public months(Month|int $value) : CarbonImmutable`

Set current instance month to the given value.

##### Parameters

$value : Month|int

##### Return values

CarbonImmutable

#### monthsInCentury()

CarbonImmutable.php : 0
`public monthsInCentury() : int`

Return the number of months contained in the current century

##### Return values

int

#### monthsInDecade()

CarbonImmutable.php : 0
`public monthsInDecade() : int`

Return the number of months contained in the current decade

##### Return values

int

#### monthsInMillennium()

CarbonImmutable.php : 0
`public monthsInMillennium() : int`

Return the number of months contained in the current millennium

##### Return values

int

#### monthsInQuarter()

CarbonImmutable.php : 0
`public monthsInQuarter() : int`

Return the number of months contained in the current quarter

##### Return values

int

#### monthsInYear()

CarbonImmutable.php : 0
`public monthsInYear() : int`

Return the number of months contained in the current year

##### Return values

int

#### monthsUntil()

CarbonImmutable.php : 0
`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()

Date.php : 1035

Returns a present instance in the same timezone.

`public nowWithSameTz() : static`

##### Return values

static

#### ordinal()

Date.php : 2164

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

Date.php : 2555

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

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public quartersInCentury() : int`

Return the number of quarters contained in the current century

##### Return values

int

#### quartersInDecade()

CarbonImmutable.php : 0
`public quartersInDecade() : int`

Return the number of quarters contained in the current decade

##### Return values

int

#### quartersInMillennium()

CarbonImmutable.php : 0
`public quartersInMillennium() : int`

Return the number of quarters contained in the current millennium

##### Return values

int

#### quartersInYear()

CarbonImmutable.php : 0
`public quartersInYear() : int`

Return the number of quarters contained in the current year

##### Return values

int

#### quartersUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public roundCenturies(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundCentury()

CarbonImmutable.php : 0
`public roundCentury(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundDay()

CarbonImmutable.php : 0
`public roundDay(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundDays()

CarbonImmutable.php : 0
`public roundDays(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundDecade()

CarbonImmutable.php : 0
`public roundDecade(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundDecades()

CarbonImmutable.php : 0
`public roundDecades(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundHour()

CarbonImmutable.php : 0
`public roundHour(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundHours()

CarbonImmutable.php : 0
`public roundHours(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMicrosecond()

CarbonImmutable.php : 0
`public roundMicrosecond(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMicroseconds()

CarbonImmutable.php : 0
`public roundMicroseconds(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMillennia()

CarbonImmutable.php : 0
`public roundMillennia(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMillennium()

CarbonImmutable.php : 0
`public roundMillennium(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMillisecond()

CarbonImmutable.php : 0
`public roundMillisecond(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMilliseconds()

CarbonImmutable.php : 0
`public roundMilliseconds(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMinute()

CarbonImmutable.php : 0
`public roundMinute(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMinutes()

CarbonImmutable.php : 0
`public roundMinutes(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMonth()

CarbonImmutable.php : 0
`public roundMonth(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundMonths()

CarbonImmutable.php : 0
`public roundMonths(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundQuarter()

CarbonImmutable.php : 0
`public roundQuarter(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundQuarters()

CarbonImmutable.php : 0
`public roundQuarters(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundSecond()

CarbonImmutable.php : 0
`public roundSecond(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundSeconds()

CarbonImmutable.php : 0
`public roundSeconds(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundYear()

CarbonImmutable.php : 0
`public roundYear(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### roundYears()

CarbonImmutable.php : 0
`public roundYears(float $precision = 1, string $function = "round") : CarbonImmutable`

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

##### Parameters

$precision = 1 : float
$function = "round" : string

##### Return values

CarbonImmutable

#### second()

CarbonImmutable.php : 0
`public second(int $value) : CarbonImmutable`

Set current instance second to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### secondOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public seconds(int $value) : CarbonImmutable`

Set current instance second to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### secondsInCentury()

CarbonImmutable.php : 0
`public secondsInCentury() : int`

Return the number of seconds contained in the current century

##### Return values

int

#### secondsInDay()

CarbonImmutable.php : 0
`public secondsInDay() : int`

Return the number of seconds contained in the current day

##### Return values

int

#### secondsInDecade()

CarbonImmutable.php : 0
`public secondsInDecade() : int`

Return the number of seconds contained in the current decade

##### Return values

int

#### secondsInHour()

CarbonImmutable.php : 0
`public secondsInHour() : int`

Return the number of seconds contained in the current hour

##### Return values

int

#### secondsInMillennium()

CarbonImmutable.php : 0
`public secondsInMillennium() : int`

Return the number of seconds contained in the current millennium

##### Return values

int

#### secondsInMinute()

CarbonImmutable.php : 0
`public secondsInMinute() : int`

Return the number of seconds contained in the current minute

##### Return values

int

#### secondsInMonth()

CarbonImmutable.php : 0
`public secondsInMonth() : int`

Return the number of seconds contained in the current month

##### Return values

int

#### secondsInQuarter()

CarbonImmutable.php : 0
`public secondsInQuarter() : int`

Return the number of seconds contained in the current quarter

##### Return values

int

#### secondsInWeek()

CarbonImmutable.php : 0
`public secondsInWeek() : int`

Return the number of seconds contained in the current week

##### Return values

int

#### secondsInYear()

CarbonImmutable.php : 0
`public secondsInYear() : int`

Return the number of seconds contained in the current year

##### Return values

int

#### secondsUntil()

CarbonImmutable.php : 0
`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()

Date.php : 1398

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

#### setDate()

Date.php : 1764

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

`public setDate(int $year, int $month, int $day) : static`

##### Parameters

$year : int
$month : int
$day : int

##### Tags

see
  https://php.net/manual/en/datetime.setdate.php

##### Return values

static

#### setDateFrom()

Date.php : 1879

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

Date.php : 1782

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

Date.php : 1899

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

CarbonImmutable.php : 0
`public setDay(int $value) : CarbonImmutable`

Set current instance day to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setDays()

CarbonImmutable.php : 0
`public setDays(int $value) : CarbonImmutable`

Set current instance day to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setDaysFromStartOfWeek()

Date.php : 1690

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

CarbonImmutable.php : 0
`public setHour(int $value) : CarbonImmutable`

Set current instance hour to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setHours()

CarbonImmutable.php : 0
`public setHours(int $value) : CarbonImmutable`

Set current instance hour to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setISODate()

Date.php : 1774

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

CarbonImmutable.php : 0
`public setMicro(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMicros()

CarbonImmutable.php : 0
`public setMicros(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMicrosecond()

CarbonImmutable.php : 0
`public setMicrosecond(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMicroseconds()

CarbonImmutable.php : 0
`public setMicroseconds(int $value) : CarbonImmutable`

Set current instance microsecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMilli()

CarbonImmutable.php : 0
`public setMilli(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMillis()

CarbonImmutable.php : 0
`public setMillis(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMillisecond()

CarbonImmutable.php : 0
`public setMillisecond(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMilliseconds()

CarbonImmutable.php : 0
`public setMilliseconds(int $value) : CarbonImmutable`

Set current instance millisecond to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMinute()

CarbonImmutable.php : 0
`public setMinute(int $value) : CarbonImmutable`

Set current instance minute to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMinutes()

CarbonImmutable.php : 0
`public setMinutes(int $value) : CarbonImmutable`

Set current instance minute to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setMonth()

CarbonImmutable.php : 0
`public setMonth(Month|int $value) : CarbonImmutable`

Set current instance month to the given value.

##### Parameters

$value : Month|int

##### Return values

CarbonImmutable

#### setMonths()

CarbonImmutable.php : 0
`public setMonths(Month|int $value) : CarbonImmutable`

Set current instance month to the given value.

##### Parameters

$value : Month|int

##### Return values

CarbonImmutable

#### setSecond()

CarbonImmutable.php : 0
`public setSecond(int $value) : CarbonImmutable`

Set current instance second to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setSeconds()

CarbonImmutable.php : 0
`public setSeconds(int $value) : CarbonImmutable`

Set current instance second to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setTime()

Date.php : 1799

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

Date.php : 1889

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

Date.php : 1819

Set the time by time string.

`public setTimeFromTimeString(string $time) : static`

##### Parameters

$time : string

##### Return values

static

#### setTimestamp()

Date.php : 1809

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

Date.php : 1851

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

Date.php : 2498

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

Date.php : 1702

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

Date.php : 1974
`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()

CarbonImmutable.php : 0
`public setYear(int $value) : CarbonImmutable`

Set current instance year to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### setYears()

CarbonImmutable.php : 0
`public setYears(int $value) : CarbonImmutable`

Set current instance year to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### shiftTimezone()

Date.php : 1859

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

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

Date.php : 2541

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

Date.php : 2566
`public static sleep(int|float $seconds) : void`

##### Parameters

$seconds : int|float

#### startOfTime()

CarbonImmutable.php : 854

Create a very old date representing start of time.

`public static startOfTime() : static`

##### Return values

static

#### subCenturies()

CarbonImmutable.php : 0
`public subCenturies(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subCenturiesNoOverflow()

CarbonImmutable.php : 0
`public subCenturiesNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subCenturiesWithNoOverflow()

CarbonImmutable.php : 0
`public subCenturiesWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subCenturiesWithoutOverflow()

CarbonImmutable.php : 0
`public subCenturiesWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subCenturiesWithOverflow()

CarbonImmutable.php : 0
`public subCenturiesWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subCentury()

CarbonImmutable.php : 0
`public subCentury() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subCenturyNoOverflow()

CarbonImmutable.php : 0
`public subCenturyNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subCenturyWithNoOverflow()

CarbonImmutable.php : 0
`public subCenturyWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subCenturyWithoutOverflow()

CarbonImmutable.php : 0
`public subCenturyWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subCenturyWithOverflow()

CarbonImmutable.php : 0
`public subCenturyWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDay()

CarbonImmutable.php : 0
`public subDay() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDays()

CarbonImmutable.php : 0
`public subDays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecade()

CarbonImmutable.php : 0
`public subDecade() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDecadeNoOverflow()

CarbonImmutable.php : 0
`public subDecadeNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDecades()

CarbonImmutable.php : 0
`public subDecades(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecadesNoOverflow()

CarbonImmutable.php : 0
`public subDecadesNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecadesWithNoOverflow()

CarbonImmutable.php : 0
`public subDecadesWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecadesWithoutOverflow()

CarbonImmutable.php : 0
`public subDecadesWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecadesWithOverflow()

CarbonImmutable.php : 0
`public subDecadesWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subDecadeWithNoOverflow()

CarbonImmutable.php : 0
`public subDecadeWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDecadeWithoutOverflow()

CarbonImmutable.php : 0
`public subDecadeWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subDecadeWithOverflow()

CarbonImmutable.php : 0
`public subDecadeWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subHour()

CarbonImmutable.php : 0
`public subHour() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subHours()

CarbonImmutable.php : 0
`public subHours(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMicro()

CarbonImmutable.php : 0
`public subMicro() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMicros()

CarbonImmutable.php : 0
`public subMicros(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMicrosecond()

CarbonImmutable.php : 0
`public subMicrosecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMicroseconds()

CarbonImmutable.php : 0
`public subMicroseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillennia()

CarbonImmutable.php : 0
`public subMillennia(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillenniaNoOverflow()

CarbonImmutable.php : 0
`public subMillenniaNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillenniaWithNoOverflow()

CarbonImmutable.php : 0
`public subMillenniaWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillenniaWithoutOverflow()

CarbonImmutable.php : 0
`public subMillenniaWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillenniaWithOverflow()

CarbonImmutable.php : 0
`public subMillenniaWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillennium()

CarbonImmutable.php : 0
`public subMillennium() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMillenniumNoOverflow()

CarbonImmutable.php : 0
`public subMillenniumNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMillenniumWithNoOverflow()

CarbonImmutable.php : 0
`public subMillenniumWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMillenniumWithoutOverflow()

CarbonImmutable.php : 0
`public subMillenniumWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMillenniumWithOverflow()

CarbonImmutable.php : 0
`public subMillenniumWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMilli()

CarbonImmutable.php : 0
`public subMilli() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMillis()

CarbonImmutable.php : 0
`public subMillis(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMillisecond()

CarbonImmutable.php : 0
`public subMillisecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMilliseconds()

CarbonImmutable.php : 0
`public subMilliseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMinute()

CarbonImmutable.php : 0
`public subMinute() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMinutes()

CarbonImmutable.php : 0
`public subMinutes(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonth()

CarbonImmutable.php : 0
`public subMonth() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMonthNoOverflow()

CarbonImmutable.php : 0
`public subMonthNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMonths()

CarbonImmutable.php : 0
`public subMonths(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonthsNoOverflow()

CarbonImmutable.php : 0
`public subMonthsNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonthsWithNoOverflow()

CarbonImmutable.php : 0
`public subMonthsWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonthsWithoutOverflow()

CarbonImmutable.php : 0
`public subMonthsWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonthsWithOverflow()

CarbonImmutable.php : 0
`public subMonthsWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subMonthWithNoOverflow()

CarbonImmutable.php : 0
`public subMonthWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMonthWithoutOverflow()

CarbonImmutable.php : 0
`public subMonthWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subMonthWithOverflow()

CarbonImmutable.php : 0
`public subMonthWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subQuarter()

CarbonImmutable.php : 0
`public subQuarter() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subQuarterNoOverflow()

CarbonImmutable.php : 0
`public subQuarterNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subQuarters()

CarbonImmutable.php : 0
`public subQuarters(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subQuartersNoOverflow()

CarbonImmutable.php : 0
`public subQuartersNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subQuartersWithNoOverflow()

CarbonImmutable.php : 0
`public subQuartersWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subQuartersWithoutOverflow()

CarbonImmutable.php : 0
`public subQuartersWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subQuartersWithOverflow()

CarbonImmutable.php : 0
`public subQuartersWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subQuarterWithNoOverflow()

CarbonImmutable.php : 0
`public subQuarterWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subQuarterWithoutOverflow()

CarbonImmutable.php : 0
`public subQuarterWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subQuarterWithOverflow()

CarbonImmutable.php : 0
`public subQuarterWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subSecond()

CarbonImmutable.php : 0
`public subSecond() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subSeconds()

CarbonImmutable.php : 0
`public subSeconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUnitNoOverflow()

Date.php : 1742

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

CarbonImmutable.php : 0
`public subUTCCenturies(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCCentury()

CarbonImmutable.php : 0
`public subUTCCentury() : CarbonImmutable`

Sub one century to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCDay()

CarbonImmutable.php : 0
`public subUTCDay() : CarbonImmutable`

Sub one day to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCDays()

CarbonImmutable.php : 0
`public subUTCDays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCDecade()

CarbonImmutable.php : 0
`public subUTCDecade() : CarbonImmutable`

Sub one decade to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCDecades()

CarbonImmutable.php : 0
`public subUTCDecades(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCHour()

CarbonImmutable.php : 0
`public subUTCHour() : CarbonImmutable`

Sub one hour to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCHours()

CarbonImmutable.php : 0
`public subUTCHours(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMicro()

CarbonImmutable.php : 0
`public subUTCMicro() : CarbonImmutable`

Sub one microsecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMicros()

CarbonImmutable.php : 0
`public subUTCMicros(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMicrosecond()

CarbonImmutable.php : 0
`public subUTCMicrosecond() : CarbonImmutable`

Sub one microsecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMicroseconds()

CarbonImmutable.php : 0
`public subUTCMicroseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMillennia()

CarbonImmutable.php : 0
`public subUTCMillennia(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMillennium()

CarbonImmutable.php : 0
`public subUTCMillennium() : CarbonImmutable`

Sub one millennium to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMilli()

CarbonImmutable.php : 0
`public subUTCMilli() : CarbonImmutable`

Sub one millisecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMillis()

CarbonImmutable.php : 0
`public subUTCMillis(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMillisecond()

CarbonImmutable.php : 0
`public subUTCMillisecond() : CarbonImmutable`

Sub one millisecond to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMilliseconds()

CarbonImmutable.php : 0
`public subUTCMilliseconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMinute()

CarbonImmutable.php : 0
`public subUTCMinute() : CarbonImmutable`

Sub one minute to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMinutes()

CarbonImmutable.php : 0
`public subUTCMinutes(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCMonth()

CarbonImmutable.php : 0
`public subUTCMonth() : CarbonImmutable`

Sub one month to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCMonths()

CarbonImmutable.php : 0
`public subUTCMonths(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCQuarter()

CarbonImmutable.php : 0
`public subUTCQuarter() : CarbonImmutable`

Sub one quarter to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCQuarters()

CarbonImmutable.php : 0
`public subUTCQuarters(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCSecond()

CarbonImmutable.php : 0
`public subUTCSecond() : CarbonImmutable`

Sub one second to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCSeconds()

CarbonImmutable.php : 0
`public subUTCSeconds(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCWeek()

CarbonImmutable.php : 0
`public subUTCWeek() : CarbonImmutable`

Sub one week to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCWeeks()

CarbonImmutable.php : 0
`public subUTCWeeks(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subUTCYear()

CarbonImmutable.php : 0
`public subUTCYear() : CarbonImmutable`

Sub one year to the instance (using timestamp).

##### Return values

CarbonImmutable

#### subUTCYears()

CarbonImmutable.php : 0
`public subUTCYears(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subWeek()

CarbonImmutable.php : 0
`public subWeek() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subWeekday()

CarbonImmutable.php : 0
`public subWeekday() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subWeekdays()

CarbonImmutable.php : 0
`public subWeekdays(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subWeeks()

CarbonImmutable.php : 0
`public subWeeks(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYear()

CarbonImmutable.php : 0
`public subYear() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subYearNoOverflow()

CarbonImmutable.php : 0
`public subYearNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subYears()

CarbonImmutable.php : 0
`public subYears(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYearsNoOverflow()

CarbonImmutable.php : 0
`public subYearsNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYearsWithNoOverflow()

CarbonImmutable.php : 0
`public subYearsWithNoOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYearsWithoutOverflow()

CarbonImmutable.php : 0
`public subYearsWithoutOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYearsWithOverflow()

CarbonImmutable.php : 0
`public subYearsWithOverflow(int|float $value = 1) : CarbonImmutable`

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

##### Parameters

$value = 1 : int|float

##### Return values

CarbonImmutable

#### subYearWithNoOverflow()

CarbonImmutable.php : 0
`public subYearWithNoOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subYearWithoutOverflow()

CarbonImmutable.php : 0
`public subYearWithoutOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### subYearWithOverflow()

CarbonImmutable.php : 0
`public subYearWithOverflow() : CarbonImmutable`

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

##### Return values

CarbonImmutable

#### timezone()

Date.php : 1831
`public timezone(DateTimeZone|string|int $value) : static`

##### Parameters

$value : DateTimeZone|string|int

##### Tags

alias

  setTimezone

##### Return values

static

#### translatedFormat()

Date.php : 2371

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

Date.php : 1839

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

Date.php : 1871

Set the instance's timezone to UTC.

`public utc() : static`

##### Return values

static

#### utcOffset()

Date.php : 1750

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

Date.php : 1642

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

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public weeksInCentury() : int`

Return the number of weeks contained in the current century

##### Return values

int

#### weeksInDecade()

CarbonImmutable.php : 0
`public weeksInDecade() : int`

Return the number of weeks contained in the current decade

##### Return values

int

#### weeksInMillennium()

CarbonImmutable.php : 0
`public weeksInMillennium() : int`

Return the number of weeks contained in the current millennium

##### Return values

int

#### weeksInMonth()

CarbonImmutable.php : 0
`public weeksInMonth() : int`

Return the number of weeks contained in the current month

##### Return values

int

#### weeksInQuarter()

CarbonImmutable.php : 0
`public weeksInQuarter() : int`

Return the number of weeks contained in the current quarter

##### Return values

int

#### weeksUntil()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public year(int $value) : CarbonImmutable`

Set current instance year to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### yearOfCentury()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`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()

CarbonImmutable.php : 0
`public years(int $value) : CarbonImmutable`

Set current instance year to the given value.

##### Parameters

$value : int

##### Return values

CarbonImmutable

#### yearsInCentury()

CarbonImmutable.php : 0
`public yearsInCentury() : int`

Return the number of years contained in the current century

##### Return values

int

#### yearsInDecade()

CarbonImmutable.php : 0
`public yearsInDecade() : int`

Return the number of years contained in the current decade

##### Return values

int

#### yearsInMillennium()

CarbonImmutable.php : 0
`public yearsInMillennium() : int`

Return the number of years contained in the current millennium

##### Return values

int

#### yearsUntil()

CarbonImmutable.php : 0
`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()

Date.php : 2621
`protected executeCallable(callable $macro, mixed ...$parameters) : mixed`

##### Parameters

$macro : callable
$parameters : mixed

#### executeCallableWithContext()

Date.php : 2632
`protected executeCallableWithContext(callable $macro, mixed ...$parameters) : mixed`

##### Parameters

$macro : callable
$parameters : mixed

#### executeStaticCallable()

Date.php : 2654
`protected static executeStaticCallable(callable $macro, mixed ...$parameters) : mixed`

##### Parameters

$macro : callable
$parameters : mixed

#### getAllGenericMacros()

Date.php : 2639
`protected getAllGenericMacros() : Generator`

##### Return values

Generator

#### getGenericMacros()

Date.php : 2645
`protected static getGenericMacros() : Generator`

##### Return values

Generator

#### getRangesByUnit()

Date.php : 973

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

Date.php : 2667
`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()

Date.php : 2603

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

Date.php : 953

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

Date.php : 2616
`protected static weekRotate(int $day, int $rotation) : int`

##### Parameters

$day : int
$rotation : int

##### Return values

int

#### callComparatorMethod()

Date.php : 2833
`private callComparatorMethod(string $unit, array<string|int, mixed> $parameters) : bool|null`

##### Parameters

$unit : string
$parameters : array<string|int, mixed>

##### Return values

bool|null

#### callDiffAlias()

Date.php : 2731
`private callDiffAlias(string $method, array<string|int, mixed> $parameters) : mixed`

##### Parameters

$method : string
$parameters : array<string|int, mixed>

#### callGetOrSet()

Date.php : 2705
`private callGetOrSet(string $name, mixed $value) : mixed`

##### Parameters

$name : string
$value : mixed

#### callGetOrSetMethod()

Date.php : 2687
`private callGetOrSetMethod(string $method, array<string|int, mixed> $parameters) : mixed`

##### Parameters

$method : string
$parameters : array<string|int, mixed>

#### callHumanDiffAlias()

Date.php : 2769
`private callHumanDiffAlias(string $method, array<string|int, mixed> $parameters) : string|null`

##### Parameters

$method : string
$parameters : array<string|int, mixed>

##### Return values

string|null

#### callIsMethod()

Date.php : 2808
`private callIsMethod(string $unit, array<string|int, mixed> $parameters) : bool|null`

##### Parameters

$unit : string
$parameters : array<string|int, mixed>

##### Return values

bool|null

#### callMacroMethod()

Date.php : 2927
`private callMacroMethod(string $method, array<string|int, mixed> $parameters) : mixed`

##### Parameters

$method : string
$parameters : array<string|int, mixed>

#### callModifierMethod()

Date.php : 2870
`private callModifierMethod(string $unit, array<string|int, mixed> $parameters) : static|null`

##### Parameters

$unit : string
$parameters : array<string|int, mixed>

##### Return values

static|null

#### callPeriodMethod()

Date.php : 2908
`private callPeriodMethod(string $method, array<string|int, mixed> $parameters) : CarbonPeriod|null`

##### Parameters

$method : string
$parameters : array<string|int, mixed>

##### Return values

CarbonPeriod|null

#### floorZeroPad()

Date.php : 2952
`private static floorZeroPad(int|float $value, int $length) : string`

##### Parameters

$value : int|float
$length : int

##### Return values

string

#### getEndOfTimeYear()

CarbonImmutable.php : 878
`private static getEndOfTimeYear() : int`

##### Tags

codeCoverageIgnore

##### Return values

int

#### getStartOfTimeYear()

CarbonImmutable.php : 886
`private static getStartOfTimeYear() : int`

##### Tags

codeCoverageIgnore

##### Return values

int

#### getUTCUnit()

Date.php : 2718
`private getUTCUnit(string $unit) : string|null`

##### Parameters

$unit : string

##### Return values

string|null

## Search results