FileAccess Orion

Date

A simple API extension for DateTime.

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

addCenturies()  : CarbonInterface

addCenturiesNoOverflow()  : CarbonInterface

addCenturiesWithNoOverflow()  : CarbonInterface

addCenturiesWithoutOverflow()  : CarbonInterface

addCenturiesWithOverflow()  : CarbonInterface

addCentury()  : CarbonInterface

addCenturyNoOverflow()  : CarbonInterface

addCenturyWithNoOverflow()  : CarbonInterface

addCenturyWithoutOverflow()  : CarbonInterface

addCenturyWithOverflow()  : CarbonInterface

addDay()  : CarbonInterface

addDays()  : CarbonInterface

addDecade()  : CarbonInterface

addDecadeNoOverflow()  : CarbonInterface

addDecades()  : CarbonInterface

addDecadesNoOverflow()  : CarbonInterface

addDecadesWithNoOverflow()  : CarbonInterface

addDecadesWithoutOverflow()  : CarbonInterface

addDecadesWithOverflow()  : CarbonInterface

addDecadeWithNoOverflow()  : CarbonInterface

addDecadeWithoutOverflow()  : CarbonInterface

addDecadeWithOverflow()  : CarbonInterface

addHour()  : CarbonInterface

addHours()  : CarbonInterface

addMicro()  : CarbonInterface

addMicros()  : CarbonInterface

addMicrosecond()  : CarbonInterface

addMicroseconds()  : CarbonInterface

addMillennia()  : CarbonInterface

addMillenniaNoOverflow()  : CarbonInterface

addMillenniaWithNoOverflow()  : CarbonInterface

addMillenniaWithoutOverflow()  : CarbonInterface

addMillenniaWithOverflow()  : CarbonInterface

addMillennium()  : CarbonInterface

addMillenniumNoOverflow()  : CarbonInterface

addMillenniumWithNoOverflow()  : CarbonInterface

addMillenniumWithoutOverflow()  : CarbonInterface

addMillenniumWithOverflow()  : CarbonInterface

addMilli()  : CarbonInterface

addMillis()  : CarbonInterface

addMillisecond()  : CarbonInterface

addMilliseconds()  : CarbonInterface

addMinute()  : CarbonInterface

addMinutes()  : CarbonInterface

addMonth()  : CarbonInterface

addMonthNoOverflow()  : CarbonInterface

addMonths()  : CarbonInterface

addMonthsNoOverflow()  : CarbonInterface

addMonthsWithNoOverflow()  : CarbonInterface

addMonthsWithoutOverflow()  : CarbonInterface

addMonthsWithOverflow()  : CarbonInterface

addMonthWithNoOverflow()  : CarbonInterface

addMonthWithoutOverflow()  : CarbonInterface

addMonthWithOverflow()  : CarbonInterface

addQuarter()  : CarbonInterface

addQuarterNoOverflow()  : CarbonInterface

addQuarters()  : CarbonInterface

addQuartersNoOverflow()  : CarbonInterface

addQuartersWithNoOverflow()  : CarbonInterface

addQuartersWithoutOverflow()  : CarbonInterface

addQuartersWithOverflow()  : CarbonInterface

addQuarterWithNoOverflow()  : CarbonInterface

addQuarterWithoutOverflow()  : CarbonInterface

addQuarterWithOverflow()  : CarbonInterface

addRealCenturies()  : CarbonInterface

addRealCentury()  : CarbonInterface

addRealDay()  : CarbonInterface

addRealDays()  : CarbonInterface

addRealDecade()  : CarbonInterface

addRealDecades()  : CarbonInterface

addRealHour()  : CarbonInterface

addRealHours()  : CarbonInterface

addRealMicro()  : CarbonInterface

addRealMicros()  : CarbonInterface

addRealMicrosecond()  : CarbonInterface

addRealMicroseconds()  : CarbonInterface

addRealMillennia()  : CarbonInterface

addRealMillennium()  : CarbonInterface

addRealMilli()  : CarbonInterface

addRealMillis()  : CarbonInterface

addRealMillisecond()  : CarbonInterface

addRealMilliseconds()  : CarbonInterface

addRealMinute()  : CarbonInterface

addRealMinutes()  : CarbonInterface

addRealMonth()  : CarbonInterface

addRealMonths()  : CarbonInterface

addRealQuarter()  : CarbonInterface

addRealQuarters()  : CarbonInterface

addRealSecond()  : CarbonInterface

addRealSeconds()  : CarbonInterface

addRealWeek()  : CarbonInterface

addRealWeeks()  : CarbonInterface

addRealYear()  : CarbonInterface

addRealYears()  : CarbonInterface

addSecond()  : CarbonInterface

addSeconds()  : CarbonInterface

addUnitNoOverflow()  : static

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

addWeek()  : CarbonInterface

addWeekday()  : CarbonInterface

addWeekdays()  : CarbonInterface

addWeeks()  : CarbonInterface

addYear()  : CarbonInterface

addYearNoOverflow()  : CarbonInterface

addYears()  : CarbonInterface

addYearsNoOverflow()  : CarbonInterface

addYearsWithNoOverflow()  : CarbonInterface

addYearsWithoutOverflow()  : CarbonInterface

addYearsWithOverflow()  : CarbonInterface

addYearWithNoOverflow()  : CarbonInterface

addYearWithoutOverflow()  : CarbonInterface

addYearWithOverflow()  : CarbonInterface

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

ceilCentury()  : CarbonInterface

ceilDay()  : CarbonInterface

ceilDays()  : CarbonInterface

ceilDecade()  : CarbonInterface

ceilDecades()  : CarbonInterface

ceilHour()  : CarbonInterface

ceilHours()  : CarbonInterface

ceilMicrosecond()  : CarbonInterface

ceilMicroseconds()  : CarbonInterface

ceilMillennia()  : CarbonInterface

ceilMillennium()  : CarbonInterface

ceilMillisecond()  : CarbonInterface

ceilMilliseconds()  : CarbonInterface

ceilMinute()  : CarbonInterface

ceilMinutes()  : CarbonInterface

ceilMonth()  : CarbonInterface

ceilMonths()  : CarbonInterface

ceilQuarter()  : CarbonInterface

ceilQuarters()  : CarbonInterface

ceilSecond()  : CarbonInterface

ceilSeconds()  : CarbonInterface

ceilYear()  : CarbonInterface

ceilYears()  : CarbonInterface

centuriesUntil()  : CarbonPeriod

clone()  : static

copy()  : static

Get a copy of the instance.

day()  : CarbonInterface

dayOfYear()  : static|int

Get/set the day of year.

days()  : CarbonInterface

daysUntil()  : CarbonPeriod

decadesUntil()  : CarbonPeriod

floorCenturies()  : CarbonInterface

floorCentury()  : CarbonInterface

floorDay()  : CarbonInterface

floorDays()  : CarbonInterface

floorDecade()  : CarbonInterface

floorDecades()  : CarbonInterface

floorHour()  : CarbonInterface

floorHours()  : CarbonInterface

floorMicrosecond()  : CarbonInterface

floorMicroseconds()  : CarbonInterface

floorMillennia()  : CarbonInterface

floorMillennium()  : CarbonInterface

floorMillisecond()  : CarbonInterface

floorMilliseconds()  : CarbonInterface

floorMinute()  : CarbonInterface

floorMinutes()  : CarbonInterface

floorMonth()  : CarbonInterface

floorMonths()  : CarbonInterface

floorQuarter()  : CarbonInterface

floorQuarters()  : CarbonInterface

floorSecond()  : CarbonInterface

floorSeconds()  : CarbonInterface

floorYear()  : CarbonInterface

floorYears()  : CarbonInterface

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

hours()  : CarbonInterface

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

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

micros()  : CarbonInterface

microsecond()  : CarbonInterface

microseconds()  : CarbonInterface

microsecondsUntil()  : CarbonPeriod

microsUntil()  : CarbonPeriod

millenniaUntil()  : CarbonPeriod

milli()  : CarbonInterface

millis()  : CarbonInterface

millisecond()  : CarbonInterface

milliseconds()  : CarbonInterface

millisecondsUntil()  : CarbonPeriod

millisUntil()  : CarbonPeriod

minute()  : CarbonInterface

minutes()  : CarbonInterface

minutesUntil()  : CarbonPeriod

month()  : CarbonInterface

months()  : CarbonInterface

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

roundCentury()  : CarbonInterface

roundDay()  : CarbonInterface

roundDays()  : CarbonInterface

roundDecade()  : CarbonInterface

roundDecades()  : CarbonInterface

roundHour()  : CarbonInterface

roundHours()  : CarbonInterface

roundMicrosecond()  : CarbonInterface

roundMicroseconds()  : CarbonInterface

roundMillennia()  : CarbonInterface

roundMillennium()  : CarbonInterface

roundMillisecond()  : CarbonInterface

roundMilliseconds()  : CarbonInterface

roundMinute()  : CarbonInterface

roundMinutes()  : CarbonInterface

roundMonth()  : CarbonInterface

roundMonths()  : CarbonInterface

roundQuarter()  : CarbonInterface

roundQuarters()  : CarbonInterface

roundSecond()  : CarbonInterface

roundSeconds()  : CarbonInterface

roundYear()  : CarbonInterface

roundYears()  : CarbonInterface

second()  : CarbonInterface

seconds()  : CarbonInterface

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

setDays()  : CarbonInterface

setHour()  : CarbonInterface

setHours()  : CarbonInterface

setISODate()  : static

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

setMicro()  : CarbonInterface

setMicros()  : CarbonInterface

setMicrosecond()  : CarbonInterface

setMicroseconds()  : CarbonInterface

setMilli()  : CarbonInterface

setMillis()  : CarbonInterface

setMillisecond()  : CarbonInterface

setMilliseconds()  : CarbonInterface

setMinute()  : CarbonInterface

setMinutes()  : CarbonInterface

setMonth()  : CarbonInterface

setMonths()  : CarbonInterface

setSecond()  : CarbonInterface

setSeconds()  : CarbonInterface

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

setYears()  : CarbonInterface

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

subCenturiesNoOverflow()  : CarbonInterface

subCenturiesWithNoOverflow()  : CarbonInterface

subCenturiesWithoutOverflow()  : CarbonInterface

subCenturiesWithOverflow()  : CarbonInterface

subCentury()  : CarbonInterface

subCenturyNoOverflow()  : CarbonInterface

subCenturyWithNoOverflow()  : CarbonInterface

subCenturyWithoutOverflow()  : CarbonInterface

subCenturyWithOverflow()  : CarbonInterface

subDay()  : CarbonInterface

subDays()  : CarbonInterface

subDecade()  : CarbonInterface

subDecadeNoOverflow()  : CarbonInterface

subDecades()  : CarbonInterface

subDecadesNoOverflow()  : CarbonInterface

subDecadesWithNoOverflow()  : CarbonInterface

subDecadesWithoutOverflow()  : CarbonInterface

subDecadesWithOverflow()  : CarbonInterface

subDecadeWithNoOverflow()  : CarbonInterface

subDecadeWithoutOverflow()  : CarbonInterface

subDecadeWithOverflow()  : CarbonInterface

subHour()  : CarbonInterface

subHours()  : CarbonInterface

subMicro()  : CarbonInterface

subMicros()  : CarbonInterface

subMicrosecond()  : CarbonInterface

subMicroseconds()  : CarbonInterface

subMillennia()  : CarbonInterface

subMillenniaNoOverflow()  : CarbonInterface

subMillenniaWithNoOverflow()  : CarbonInterface

subMillenniaWithoutOverflow()  : CarbonInterface

subMillenniaWithOverflow()  : CarbonInterface

subMillennium()  : CarbonInterface

subMillenniumNoOverflow()  : CarbonInterface

subMillenniumWithNoOverflow()  : CarbonInterface

subMillenniumWithoutOverflow()  : CarbonInterface

subMillenniumWithOverflow()  : CarbonInterface

subMilli()  : CarbonInterface

subMillis()  : CarbonInterface

subMillisecond()  : CarbonInterface

subMilliseconds()  : CarbonInterface

subMinute()  : CarbonInterface

subMinutes()  : CarbonInterface

subMonth()  : CarbonInterface

subMonthNoOverflow()  : CarbonInterface

subMonths()  : CarbonInterface

subMonthsNoOverflow()  : CarbonInterface

subMonthsWithNoOverflow()  : CarbonInterface

subMonthsWithoutOverflow()  : CarbonInterface

subMonthsWithOverflow()  : CarbonInterface

subMonthWithNoOverflow()  : CarbonInterface

subMonthWithoutOverflow()  : CarbonInterface

subMonthWithOverflow()  : CarbonInterface

subQuarter()  : CarbonInterface

subQuarterNoOverflow()  : CarbonInterface

subQuarters()  : CarbonInterface

subQuartersNoOverflow()  : CarbonInterface

subQuartersWithNoOverflow()  : CarbonInterface

subQuartersWithoutOverflow()  : CarbonInterface

subQuartersWithOverflow()  : CarbonInterface

subQuarterWithNoOverflow()  : CarbonInterface

subQuarterWithoutOverflow()  : CarbonInterface

subQuarterWithOverflow()  : CarbonInterface

subRealCenturies()  : CarbonInterface

subRealCentury()  : CarbonInterface

subRealDay()  : CarbonInterface

subRealDays()  : CarbonInterface

subRealDecade()  : CarbonInterface

subRealDecades()  : CarbonInterface

subRealHour()  : CarbonInterface

subRealHours()  : CarbonInterface

subRealMicro()  : CarbonInterface

subRealMicros()  : CarbonInterface

subRealMicrosecond()  : CarbonInterface

subRealMicroseconds()  : CarbonInterface

subRealMillennia()  : CarbonInterface

subRealMillennium()  : CarbonInterface

subRealMilli()  : CarbonInterface

subRealMillis()  : CarbonInterface

subRealMillisecond()  : CarbonInterface

subRealMilliseconds()  : CarbonInterface

subRealMinute()  : CarbonInterface

subRealMinutes()  : CarbonInterface

subRealMonth()  : CarbonInterface

subRealMonths()  : CarbonInterface

subRealQuarter()  : CarbonInterface

subRealQuarters()  : CarbonInterface

subRealSecond()  : CarbonInterface

subRealSeconds()  : CarbonInterface

subRealWeek()  : CarbonInterface

subRealWeeks()  : CarbonInterface

subRealYear()  : CarbonInterface

subRealYears()  : CarbonInterface

subSecond()  : CarbonInterface

subSeconds()  : CarbonInterface

subUnitNoOverflow()  : static

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

subWeek()  : CarbonInterface

subWeekday()  : CarbonInterface

subWeekdays()  : CarbonInterface

subWeeks()  : CarbonInterface

subYear()  : CarbonInterface

subYearNoOverflow()  : CarbonInterface

subYears()  : CarbonInterface

subYearsNoOverflow()  : CarbonInterface

subYearsWithNoOverflow()  : CarbonInterface

subYearsWithoutOverflow()  : CarbonInterface

subYearsWithOverflow()  : CarbonInterface

subYearWithNoOverflow()  : CarbonInterface

subYearWithoutOverflow()  : CarbonInterface

subYearWithOverflow()  : CarbonInterface

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

years()  : CarbonInterface

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.