FileAccess Orion

Carbon extends DateTime

in package

• Application

implements CarbonInterface Uses Date

A simple API extension for DateTime.

Interfaces, Classes, Traits and Enums

CarbonInterface

Common interface for Carbon and CarbonImmutable.

Table of Contents

$age  : int

$century  : int

$day  : int

$dayName  : string

$dayOfWeek  : int

$dayOfWeekIso  : int

$dayOfYear  : int

$daysInMonth  : int

$daysInYear  : int

$decade  : int

$dst  : bool

$englishDayOfWeek  : string

$englishMonth  : string

$firstWeekDay  : int

$hour  : 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

$millennium  : int

$milli  : int

$millisecond  : int

$milliseconds  : int

$minDayName  : string

$minute  : int

$month  : int

$monthName  : string

$noZeroHour  : int

$offset  : int

$offsetHours  : int

$offsetMinutes  : int

$quarter  : int

$second  : int

$shortDayName  : string

$shortEnglishDayOfWeek  : string

$shortEnglishMonth  : string

$shortLocaleDayOfWeek  : string

$shortLocaleMonth  : string

$shortMonthName  : string

$timestamp  : int

$timezone  : CarbonTimeZone

$timezoneAbbreviatedName  : string

$timezoneName  : string

$tz  : CarbonTimeZone

$tzAbbrName  : string

$tzName  : string

$upperMeridiem  : string

$utc  : bool

$week  : int

$weekNumberInMonth  : int

$weekOfMonth  : int

$weekOfYear  : int

$weeksInYear  : int

$weekYear  : int

$year  : int

$yearIso  : 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.

$utf8  : bool

Will UTF8 encoding be used to print localized date/time ?

__call()  : mixed

Dynamically handle calls to the class.

__callStatic()  : mixed

Dynamically handle calls to the class.

__get()  : string|int|bool|DateTimeZone|null

Get a part of the Carbon object

__isset()  : bool

Check if an attribute exists on the object

__set()  : void

Set a part of the Carbon object

__set_state()  : static

The __set_state handler.

addCenturies()  : Carbon

addCenturiesNoOverflow()  : Carbon

addCenturiesWithNoOverflow()  : Carbon

addCenturiesWithoutOverflow()  : Carbon

addCenturiesWithOverflow()  : Carbon

addCentury()  : Carbon

addCenturyNoOverflow()  : Carbon

addCenturyWithNoOverflow()  : Carbon

addCenturyWithoutOverflow()  : Carbon

addCenturyWithOverflow()  : Carbon

addDay()  : Carbon

addDays()  : Carbon

addDecade()  : Carbon

addDecadeNoOverflow()  : Carbon

addDecades()  : Carbon

addDecadesNoOverflow()  : Carbon

addDecadesWithNoOverflow()  : Carbon

addDecadesWithoutOverflow()  : Carbon

addDecadesWithOverflow()  : Carbon

addDecadeWithNoOverflow()  : Carbon

addDecadeWithoutOverflow()  : Carbon

addDecadeWithOverflow()  : Carbon

addHour()  : Carbon

addHours()  : Carbon

addMicro()  : Carbon

addMicros()  : Carbon

addMicrosecond()  : Carbon

addMicroseconds()  : Carbon

addMillennia()  : Carbon

addMillenniaNoOverflow()  : Carbon

addMillenniaWithNoOverflow()  : Carbon

addMillenniaWithoutOverflow()  : Carbon

addMillenniaWithOverflow()  : Carbon

addMillennium()  : Carbon

addMillenniumNoOverflow()  : Carbon

addMillenniumWithNoOverflow()  : Carbon

addMillenniumWithoutOverflow()  : Carbon

addMillenniumWithOverflow()  : Carbon

addMilli()  : Carbon

addMillis()  : Carbon

addMillisecond()  : Carbon

addMilliseconds()  : Carbon

addMinute()  : Carbon

addMinutes()  : Carbon

addMonth()  : Carbon

addMonthNoOverflow()  : Carbon

addMonths()  : Carbon

addMonthsNoOverflow()  : Carbon

addMonthsWithNoOverflow()  : Carbon

addMonthsWithoutOverflow()  : Carbon

addMonthsWithOverflow()  : Carbon

addMonthWithNoOverflow()  : Carbon

addMonthWithoutOverflow()  : Carbon

addMonthWithOverflow()  : Carbon

addQuarter()  : Carbon

addQuarterNoOverflow()  : Carbon

addQuarters()  : Carbon

addQuartersNoOverflow()  : Carbon

addQuartersWithNoOverflow()  : Carbon

addQuartersWithoutOverflow()  : Carbon

addQuartersWithOverflow()  : Carbon

addQuarterWithNoOverflow()  : Carbon

addQuarterWithoutOverflow()  : Carbon

addQuarterWithOverflow()  : Carbon

addRealCenturies()  : Carbon

addRealCentury()  : Carbon

addRealDay()  : Carbon

addRealDays()  : Carbon

addRealDecade()  : Carbon

addRealDecades()  : Carbon

addRealHour()  : Carbon

addRealHours()  : Carbon

addRealMicro()  : Carbon

addRealMicros()  : Carbon

addRealMicrosecond()  : Carbon

addRealMicroseconds()  : Carbon

addRealMillennia()  : Carbon

addRealMillennium()  : Carbon

addRealMilli()  : Carbon

addRealMillis()  : Carbon

addRealMillisecond()  : Carbon

addRealMilliseconds()  : Carbon

addRealMinute()  : Carbon

addRealMinutes()  : Carbon

addRealMonth()  : Carbon

addRealMonths()  : Carbon

addRealQuarter()  : Carbon

addRealQuarters()  : Carbon

addRealSecond()  : Carbon

addRealSeconds()  : Carbon

addRealWeek()  : Carbon

addRealWeeks()  : Carbon

addRealYear()  : Carbon

addRealYears()  : Carbon

addSecond()  : Carbon

addSeconds()  : Carbon

addUnitNoOverflow()  : static

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

addWeek()  : Carbon

addWeekday()  : Carbon

addWeekdays()  : Carbon

addWeeks()  : Carbon

addYear()  : Carbon

addYearNoOverflow()  : Carbon

addYears()  : Carbon

addYearsNoOverflow()  : Carbon

addYearsWithNoOverflow()  : Carbon

addYearsWithoutOverflow()  : Carbon

addYearsWithOverflow()  : Carbon

addYearWithNoOverflow()  : Carbon

addYearWithoutOverflow()  : Carbon

addYearWithOverflow()  : Carbon

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

ceilCentury()  : Carbon

ceilDay()  : Carbon

ceilDays()  : Carbon

ceilDecade()  : Carbon

ceilDecades()  : Carbon

ceilHour()  : Carbon

ceilHours()  : Carbon

ceilMicrosecond()  : Carbon

ceilMicroseconds()  : Carbon

ceilMillennia()  : Carbon

ceilMillennium()  : Carbon

ceilMillisecond()  : Carbon

ceilMilliseconds()  : Carbon

ceilMinute()  : Carbon

ceilMinutes()  : Carbon

ceilMonth()  : Carbon

ceilMonths()  : Carbon

ceilQuarter()  : Carbon

ceilQuarters()  : Carbon

ceilSecond()  : Carbon

ceilSeconds()  : Carbon

ceilYear()  : Carbon

ceilYears()  : Carbon

centuriesUntil()  : CarbonPeriod

clone()  : static

copy()  : static

Get a copy of the instance.

createFromFormat()  : static|false

Create a Carbon instance from a specific format.

createFromImmutable()  : Carbon

day()  : Carbon

dayOfYear()  : static|int

Get/set the day of year.

days()  : Carbon

daysUntil()  : CarbonPeriod

decadesUntil()  : CarbonPeriod

floorCenturies()  : Carbon

floorCentury()  : Carbon

floorDay()  : Carbon

floorDays()  : Carbon

floorDecade()  : Carbon

floorDecades()  : Carbon

floorHour()  : Carbon

floorHours()  : Carbon

floorMicrosecond()  : Carbon

floorMicroseconds()  : Carbon

floorMillennia()  : Carbon

floorMillennium()  : Carbon

floorMillisecond()  : Carbon

floorMilliseconds()  : Carbon

floorMinute()  : Carbon

floorMinutes()  : Carbon

floorMonth()  : Carbon

floorMonths()  : Carbon

floorQuarter()  : Carbon

floorQuarters()  : Carbon

floorSecond()  : Carbon

floorSeconds()  : Carbon

floorYear()  : Carbon

floorYears()  : Carbon

formatLocalized()  : string

Format the instance with the current locale. You can set the current locale using setlocale() http://php.net/setlocale.

get()  : string|int|bool|DateTimeZone|null

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

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

hours()  : Carbon

hoursUntil()  : CarbonPeriod

isCurrentCentury()  : bool

isCurrentDay()  : bool

isCurrentDecade()  : bool

isCurrentHour()  : bool

isCurrentMicro()  : bool

isCurrentMicrosecond()  : bool

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

isLastMinute()  : bool

isLastMonth()  : bool

isLastQuarter()  : bool

isLastSecond()  : bool

isLastWeek()  : bool

isLastYear()  : bool

isLocal()  : bool

isMonday()  : bool

isMutable()  : bool

Returns true if the current class/instance is mutable.

isNextCentury()  : bool

isNextDay()  : bool

isNextDecade()  : bool

isNextHour()  : bool

isNextMicro()  : bool

isNextMicrosecond()  : bool

isNextMillennium()  : bool

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

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

micros()  : Carbon

microsecond()  : Carbon

microseconds()  : Carbon

microsecondsUntil()  : CarbonPeriod

microsUntil()  : CarbonPeriod

millenniaUntil()  : CarbonPeriod

milli()  : Carbon

millis()  : Carbon

millisecond()  : Carbon

milliseconds()  : Carbon

millisecondsUntil()  : CarbonPeriod

millisUntil()  : CarbonPeriod

minute()  : Carbon

minutes()  : Carbon

minutesUntil()  : CarbonPeriod

month()  : Carbon

months()  : Carbon

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

quartersUntil()  : CarbonPeriod

roundCenturies()  : Carbon

roundCentury()  : Carbon

roundDay()  : Carbon

roundDays()  : Carbon

roundDecade()  : Carbon

roundDecades()  : Carbon

roundHour()  : Carbon

roundHours()  : Carbon

roundMicrosecond()  : Carbon

roundMicroseconds()  : Carbon

roundMillennia()  : Carbon

roundMillennium()  : Carbon

roundMillisecond()  : Carbon

roundMilliseconds()  : Carbon

roundMinute()  : Carbon

roundMinutes()  : Carbon

roundMonth()  : Carbon

roundMonths()  : Carbon

roundQuarter()  : Carbon

roundQuarters()  : Carbon

roundSecond()  : Carbon

roundSeconds()  : Carbon

roundYear()  : Carbon

roundYears()  : Carbon

second()  : Carbon

seconds()  : Carbon

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

setDays()  : Carbon

setHour()  : Carbon

setHours()  : Carbon

setISODate()  : static

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

setMicro()  : Carbon

setMicros()  : Carbon

setMicrosecond()  : Carbon

setMicroseconds()  : Carbon

setMilli()  : Carbon

setMillis()  : Carbon

setMillisecond()  : Carbon

setMilliseconds()  : Carbon

setMinute()  : Carbon

setMinutes()  : Carbon

setMonth()  : Carbon

setMonths()  : Carbon

setSecond()  : Carbon

setSeconds()  : Carbon

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

Sets the date and time based on an Unix 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.

setUtf8()  : mixed

setWeekendDays()  : void

setWeekEndsAt()  : void

setWeekStartsAt()  : void

setYear()  : Carbon

setYears()  : Carbon

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

subCenturies()  : Carbon

subCenturiesNoOverflow()  : Carbon

subCenturiesWithNoOverflow()  : Carbon

subCenturiesWithoutOverflow()  : Carbon

subCenturiesWithOverflow()  : Carbon

subCentury()  : Carbon

subCenturyNoOverflow()  : Carbon

subCenturyWithNoOverflow()  : Carbon

subCenturyWithoutOverflow()  : Carbon

subCenturyWithOverflow()  : Carbon

subDay()  : Carbon

subDays()  : Carbon

subDecade()  : Carbon

subDecadeNoOverflow()  : Carbon

subDecades()  : Carbon

subDecadesNoOverflow()  : Carbon

subDecadesWithNoOverflow()  : Carbon

subDecadesWithoutOverflow()  : Carbon

subDecadesWithOverflow()  : Carbon

subDecadeWithNoOverflow()  : Carbon

subDecadeWithoutOverflow()  : Carbon

subDecadeWithOverflow()  : Carbon

subHour()  : Carbon

subHours()  : Carbon

subMicro()  : Carbon

subMicros()  : Carbon

subMicrosecond()  : Carbon

subMicroseconds()  : Carbon

subMillennia()  : Carbon

subMillenniaNoOverflow()  : Carbon

subMillenniaWithNoOverflow()  : Carbon

subMillenniaWithoutOverflow()  : Carbon

subMillenniaWithOverflow()  : Carbon

subMillennium()  : Carbon

subMillenniumNoOverflow()  : Carbon

subMillenniumWithNoOverflow()  : Carbon

subMillenniumWithoutOverflow()  : Carbon

subMillenniumWithOverflow()  : Carbon

subMilli()  : Carbon

subMillis()  : Carbon

subMillisecond()  : Carbon

subMilliseconds()  : Carbon

subMinute()  : Carbon

subMinutes()  : Carbon

subMonth()  : Carbon

subMonthNoOverflow()  : Carbon

subMonths()  : Carbon

subMonthsNoOverflow()  : Carbon

subMonthsWithNoOverflow()  : Carbon

subMonthsWithoutOverflow()  : Carbon

subMonthsWithOverflow()  : Carbon

subMonthWithNoOverflow()  : Carbon

subMonthWithoutOverflow()  : Carbon

subMonthWithOverflow()  : Carbon

subQuarter()  : Carbon

subQuarterNoOverflow()  : Carbon

subQuarters()  : Carbon

subQuartersNoOverflow()  : Carbon

subQuartersWithNoOverflow()  : Carbon

subQuartersWithoutOverflow()  : Carbon

subQuartersWithOverflow()  : Carbon

subQuarterWithNoOverflow()  : Carbon

subQuarterWithoutOverflow()  : Carbon

subQuarterWithOverflow()  : Carbon

subRealCenturies()  : Carbon

subRealCentury()  : Carbon

subRealDay()  : Carbon

subRealDays()  : Carbon

subRealDecade()  : Carbon

subRealDecades()  : Carbon

subRealHour()  : Carbon

subRealHours()  : Carbon

subRealMicro()  : Carbon

subRealMicros()  : Carbon

subRealMicrosecond()  : Carbon

subRealMicroseconds()  : Carbon

subRealMillennia()  : Carbon

subRealMillennium()  : Carbon

subRealMilli()  : Carbon

subRealMillis()  : Carbon

subRealMillisecond()  : Carbon

subRealMilliseconds()  : Carbon

subRealMinute()  : Carbon

subRealMinutes()  : Carbon

subRealMonth()  : Carbon

subRealMonths()  : Carbon

subRealQuarter()  : Carbon

subRealQuarters()  : Carbon

subRealSecond()  : Carbon

subRealSeconds()  : Carbon

subRealWeek()  : Carbon

subRealWeeks()  : Carbon

subRealYear()  : Carbon

subRealYears()  : Carbon

subSecond()  : Carbon

subSeconds()  : Carbon

subUnitNoOverflow()  : static

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

subWeek()  : Carbon

subWeekday()  : Carbon

subWeekdays()  : Carbon

subWeeks()  : Carbon

subYear()  : Carbon

subYearNoOverflow()  : Carbon

subYears()  : Carbon

subYearsNoOverflow()  : Carbon

subYearsWithNoOverflow()  : Carbon

subYearsWithoutOverflow()  : Carbon

subYearsWithOverflow()  : Carbon

subYearWithNoOverflow()  : Carbon

subYearWithoutOverflow()  : Carbon

subYearWithOverflow()  : Carbon

timezone()  : static

translatedFormat()  : string

Format as ->format() do (using date replacements patterns from http://php.net/manual/fr/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()  : int|static

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

weeksUntil()  : CarbonPeriod

year()  : Carbon

years()  : Carbon

yearsUntil()  : CarbonPeriod

executeCallable()  : mixed

executeCallableWithContext()  : mixed

executeStaticCallable()  : mixed

expectDateTime()  : mixed

Throws an exception if the given object is not a DateTime and does not implement DateTimeInterface.

getGenericMacros()  : mixed

getRangesByUnit()  : array<string|int, mixed>

List of minimum and maximums for each unit.

getTranslatedFormByRegExp()  : mixed

resolveCarbon()  : static

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|false

Creates a DateTimeZone from a string, DateTimeZone or integer offset.