Class Carbon\CarbonInterval

`extends`	`DateInterval`
`implements`	`CarbonConverterInterface`
`uses`	`LocalFactory, IntervalRounding, IntervalStep, MagicParameter, Mixin, Options, ToStringFormat`


					
	public

setTimezone(DateTimeZone|string|int $timezone): static

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

#


					
	public

shiftTimezone(DateTimeZone|string|int $timezone): static

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

#


					
	public
					static

getCascadeFactors(): array

Mapping of units and factors for cascading.

Should only be modified by changing the factors or referenced constants.

#


					
	protected
					static

getDefaultCascadeFactors(): array

#


					
	public
					static

setCascadeFactors(array $cascadeFactors)

Set default cascading factors for ->cascade() method.

#


					
	public
					static

enableFloatSetters(bool $floatSettersEnabled = true): void

This option allow you to opt-in for the Carbon 3 behavior where float values will no longer be cast to integer (so…

This option allow you to opt-in for the Carbon 3 behavior where float values will no longer be cast to integer (so truncated).

⚠️ This settings will be applied globally, which mean your whole application code including the third-party dependencies that also may use Carbon will adopt the new behavior.

#


					
	public

__construct(
	Closure|DateInterval|string|int|null $years = null,
	int|float|null $months = null,
	int|float|null $weeks = null,
	int|float|null $days = null,
	int|float|null $hours = null,
	int|float|null $minutes = null,
	int|float|null $seconds = null,
	int|float|null $microseconds = null,
)

Create a new CarbonInterval instance.

Throws

Exception

when the interval_spec (passed as $years) cannot be parsed as an interval.

Overrides

DateInterval::__construct()

#


					
	public
					static

getFactor(string $source, string $target): int|float|null

Returns the factor for a given source-to-target couple.

#


					
	public
					static

getFactorWithDefault(string $source, string $target): int|float|null

Returns the factor for a given source-to-target couple if set, else try to find the appropriate constant as the factor,…

Returns the factor for a given source-to-target couple if set, else try to find the appropriate constant as the factor, such as Carbon::DAYS_PER_WEEK.

#


					
	public
					static

getDaysPerWeek(): int|float

Returns current config for days per week.

#


					
	public
					static

getHoursPerDay(): int|float

Returns current config for hours per day.

#


					
	public
					static

getMinutesPerHour(): int|float

Returns current config for minutes per hour.

#


					
	public
					static

getSecondsPerMinute(): int|float

Returns current config for seconds per minute.

#


					
	public
					static

getMillisecondsPerSecond(): int|float

Returns current config for microseconds per second.

#


					
	public
					static

getMicrosecondsPerMillisecond(): int|float

Returns current config for microseconds per second.

#


					
	public
					static

create(
	int $years = null,
	int $months = null,
	int $weeks = null,
	int $days = null,
	int $hours = null,
	int $minutes = null,
	int $seconds = null,
	int $microseconds = null,
): static

Create a new CarbonInterval instance from specific values. This is an alias for the constructor that allows better…

Create a new CarbonInterval instance from specific values. This is an alias for the constructor that allows better fluent syntax as it allows you to do CarbonInterval::create(1)->fn() rather than (new CarbonInterval(1))->fn().

Throws

Exception

when the interval_spec (passed as $years) cannot be parsed as an interval.

#


					
	public
					static

createFromFormat(string $format, string|null $interval): static

Parse a string into a new CarbonInterval object according to the specified format.

Parameters

`$format`	Format of the $interval input string
`$interval`	Input string to convert into an interval

Throws

Carbon\Exceptions\ParseErrorException

when the $interval cannot be parsed as an interval.

#


					
	public

Return the original source used to create the current interval.

#


					
	public

start(): CarbonInterface|null

Return the start date if interval was created from a difference between 2 dates.

#


					
	public

end(): CarbonInterface|null

Return the end date if interval was created from a difference between 2 dates.

#


					
	public

optimize(): $this

Get rid of the original input, start date and end date that may be kept in memory.

#


					
	public

copy(): static

Get a copy of the instance.

#


					
	public

clone(): static

Get a copy of the instance.

#


					
	public
					static

__callStatic(string $method, array $parameters): static|mixed|null

Provide static helpers to create instances. Allows CarbonInterval::years(3).

Note: This is done using the magic method to allow static and instance methods to have the same names.

Parameters

`$method`	magic method name called
`$parameters`	parameters list

#


					
	public
					static

__set_state(array $dump): static

Evaluate the PHP generated by var_export() and recreate the exported CarbonInterval instance.

Parameters

$dump

data as exported by var_export()

Overrides

DateInterval::__set_state()

#


					
	protected
					static

this(): static

Return the current context from inside a macro callee or a new one if static.

#


					
	public
					static

fromString(string $intervalDefinition): static

Creates a CarbonInterval from string.

Format:

Suffix	Unit	Example	DateInterval expression
y	years	1y	P1Y
mo	months	3mo	P3M
w	weeks	2w	P2W
d	days	28d	P28D
h	hours	4h	PT4H
m	minutes	12m	PT12M
s	seconds	59s	PT59S

e. g. 1w 3d 4h 32m 23s is converted to 10 days 4 hours 32 minutes and 23 seconds.

Special cases:

An empty string will return a zero interval
Fractions are allowed for weeks, days, hours and minutes and will be converted and rounded to the next smaller value (caution: 0.5w = 4d)

Throws

Carbon\Exceptions\InvalidIntervalException

#


					
	public
					static

parseFromLocale(string $interval, string|null $locale = null): static

Creates a CarbonInterval from string using a different locale.

Parameters

`$interval`	interval string in the given language (may also contain English).
`$locale`	if locale is null or not specified, current global locale will be used instead.

#


					
	public
					static

diff(
	Carbon|DateTimeInterface|mixed $start,
	Carbon|DateTimeInterface|mixed $end = null,
	bool $absolute = false,
	array $skip = [],
): static

Create an interval from the difference between 2 dates.

#


					
	public

abs(bool $absolute = false): $this

Invert the interval if it's inverted.

Parameters

$absolute

do nothing if set to false

#


					
	public

absolute(bool $absolute = true): $this

Parameters

$absolute

do nothing if set to false

#


					
	public

cast<T is DateInterval>(class-string<T> $className): T

Cast the current instance into the given class.

Parameters

$className

The $className::instance() method will be called to cast the current object.

#


					
	public
					static

instance(DateInterval $interval, array $skip = [], bool $skipCopy = false): static

Create a CarbonInterval instance from a DateInterval one. Can not instance DateInterval objects created from DateTime:…

Create a CarbonInterval instance from a DateInterval one. Can not instance DateInterval objects created from DateTime::diff() as you can't externally set the $days field.

Parameters

$skipCopy

set to true to return the passed object (without copying it) if it's already of the current class

#


					
	public
					static

make(
	mixed|int|DateInterval|string|Closure|Unit|null $interval,
	Unit|string|null $unit = null,
	bool $skipCopy = false,
): static|null

Make a CarbonInterval instance from given variable if possible.

Always return a new instance. Parse only strings and only these likely to be intervals (skip dates and recurrences). Throw an exception for invalid format, but otherwise return null.

Parameters

`$interval`	interval or number of the given $unit
`$unit`	if specified, $interval must be an integer
`$skipCopy`	set to true to return the passed object (without copying it) if it's already of the current class

#


					
	protected
					static

makeFromString(string $interval): ?self

#


					
	protected

resolveInterval($interval): ?self

#


					
	public
					static

createFromDateString(string $datetime): static

Sets up a DateInterval from the relative parts of the string.

Overrides

DateInterval::createFromDateString()

#


					
	public

get(Unit|string $name): int|float|string|null

Get a part of the CarbonInterval object.

#


					
	public

__get(string $name): int|float|string|null

Get a part of the CarbonInterval object.

#


					
	public

set(Unit|string|array $name, int $value = null): $this

Set a part of the CarbonInterval object.

Throws

Carbon\Exceptions\UnknownSetterException

#


					
	public

__set(string $name, int $value)

Set a part of the CarbonInterval object.

Throws

Carbon\Exceptions\UnknownSetterException

#


					
	public

weeksAndDays(int $weeks, int $days): static

Allow setting of weeks and days to be cumulative.

Parameters

`$weeks`	Number of weeks to set
`$days`	Number of days to set

#


					
	public

isEmpty(): bool

Returns true if the interval is empty for each unit.

#


					
	public
					static

macro(string $name, ?callable $macro): void

Register a custom macro.

Pass null macro to remove it.

#


					
	public
					static

mixin(object|string $mixin): void

Register macros from a mixin object.

Throws

ReflectionException

#


					
	public
					static

hasMacro(string $name): bool

Check if macro is registered.

#


					
	protected

callMacro(string $name, array $parameters): mixed

Call given macro.

#


					
	public

__call(string $method, array $parameters): static|int|float|string

Allow fluent calls on the setters... CarbonInterval::years(3)->months(5)->day().

Note: This is done using the magic method to allow static and instance methods to have the same names.

Parameters

`$method`	magic method name called
`$parameters`	parameters list

Throws

Carbon\Exceptions\BadFluentSetterException|Throwable

#


					
	protected

getForHumansInitialVariables($syntax, $short): array

#


					
	protected

getForHumansParameters(
	mixed $syntax = null,
	mixed $short = false,
	mixed $parts = self::NO_LIMIT,
	mixed $options = null,
): array

#


					
	protected
					static

getRoundingMethodFromOptions(int $options): ?string

#


					
	public

toArray(): int[]

Returns interval values as an array where key are the unit names and values the counts.

#


					
	public

getNonZeroValues(): int[]

Returns interval non-zero values as an array where key are the unit names and values the counts.

#


					
	public

getValuesSequence(): int[]

Returns interval values as an array where key are the unit names and values the counts from the biggest non-zero one…

Returns interval values as an array where key are the unit names and values the counts from the biggest non-zero one the the smallest non-zero one.

#


					
	public

forHumans(int|array $syntax = null, bool $short = false, int $parts = self::NO_LIMIT, int $options = null): string

Get the current interval in a human readable format in the current locale.

Parameters

`$syntax`	if array passed, parameters will be extracted from it, the array may contain: ⦿ 'syntax' entry (see below) ⦿ 'short' entry (see below) ⦿ 'parts' entry (see below) ⦿ 'options' entry (see below) ⦿ 'skip' entry, list of units to skip (array of strings or a single string, `it can be the unit name (singular or plural) or its shortcut` (y, m, w, d, h, min, s, ms, µs). ⦿ 'aUnit' entry, prefer "an hour" over "1 hour" if true ⦿ 'altNumbers' entry, use alternative numbers if available `(from the current language if true is passed, from the given language(s)` if array or string is passed) ⦿ 'join' entry determines how to join multiple parts of the string `- if $join is a string, it's used as a joiner glue` - if $join is a callable/closure, it get the list of string and should return a string `- if $join is an array, the first item will be the default glue, and the second item` will be used instead of the glue for the last item `- if $join is true, it will be guessed from the locale ('list' translation file entry)` - if $join is missing, a space will be used as glue ⦿ 'minimumUnit' entry determines the smallest unit of time to display can be long or ` short form of the units, e.g. 'hour' or 'h' (default value: s) ⦿ 'locale' language in which the diff should be output (has no effect if 'translator' key is set) ⦿ 'translator' a custom translator to use to translator the output. if int passed, it adds modifiers: Possible values: - CarbonInterface::DIFF_ABSOLUTE no modifiers - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier Default value: CarbonInterface::DIFF_ABSOLUTE
`$short`	displays short format of time units
`$parts`	maximum number of parts to display (default value: -1: no limits)
`$options`	human diff options

Throws

Exception

#


					
	public

format(string $format): string

Overrides

DateInterval::format()

#


					
	public

__toString(): string

Format the instance as a string using the forHumans() function.

Throws

Exception

#


					
	public

toDateInterval(): DateInterval

Return native DateInterval PHP object matching the current instance.

#


					
	public

toPeriod(DateTimeInterface|string|int ...$params): CarbonPeriod

Convert the interval to a CarbonPeriod.

Parameters

...$params

Start date, [end date or recurrences] and optional settings.

#


					
	public

Decompose the current interval into

Parameters

`$interval`	interval or number of the given $unit
`$unit`	if specified, $interval must be an integer

#


					
	public

invert(bool|int $inverted = null): $this

Invert the interval.

Parameters

$inverted

if a parameter is passed, the passed value cast as 1 or 0 is used as the new value of the ->invert property.

#


					
	protected

solveNegativeInterval(): static

#


					
	public

add(string|DateInterval $unit, int|float $value = 1): $this

Add the passed interval to the current instance.

#


					
	public

sub(string|DateInterval $unit, int|float $value = 1): $this

Subtract the passed interval to the current instance.

#


					
	public

subtract(string|DateInterval $unit, int|float $value = 1): $this

Subtract the passed interval to the current instance.

#


					
	public

plus(
	int $years = 0,
	int $months = 0,
	int|float $weeks = 0,
	int|float $days = 0,
	int|float $hours = 0,
	int|float $minutes = 0,
	int|float $seconds = 0,
	int|float $microseconds = 0,
): $this

Add given parameters to the current interval.

#


					
	public

minus(
	int $years = 0,
	int $months = 0,
	int|float $weeks = 0,
	int|float $days = 0,
	int|float $hours = 0,
	int|float $minutes = 0,
	int|float $seconds = 0,
	int|float $microseconds = 0,
): $this

Add given parameters to the current interval.

#


					
	public

times(float|int $factor): $this

Multiply current instance given number of times. times() is naive, it multiplies each unit (so day can be greater than…

Multiply current instance given number of times. times() is naive, it multiplies each unit (so day can be greater than 31, hour can be greater than 23, etc.) and the result is rounded separately for each unit.

Use times() when you want a fast and approximated calculation that does not cascade units.

For a precise and cascaded calculation,

#


					
	public

shares(float|int $divider): $this

Divide current instance by a given divider. shares() is naive, it divides each unit separately and the result is…

Divide current instance by a given divider. shares() is naive, it divides each unit separately and the result is rounded for each unit. So 5 hours and 20 minutes shared by 3 becomes 2 hours and 7 minutes.

Use shares() when you want a fast and approximated calculation that does not cascade units.

For a precise and cascaded calculation,

#


					
	protected

copyProperties(self $interval, $ignoreSign = false): static

#


					
	public

multiply(float|int $factor): $this

Multiply and cascade current instance by a given factor.

#


					
	public

divide(float|int $divider): $this

Divide and cascade current instance by a given divider.

#


					
	public
					static

getDateIntervalSpec(DateInterval $interval, bool $microseconds = false, array $skip = []): string

Get the interval_spec string of a date interval.

#


					
	public

spec(bool $microseconds = false): string

Get the interval_spec string.

#


					
	public
					static

compareDateIntervals(DateInterval $first, DateInterval $second): int

Comparing 2 date intervals.

Returns

0, 1 or -1

#


					
	public

compare(DateInterval $interval): int

Comparing with passed interval.

Returns

0, 1 or -1

#


					
	public

cascade(): $this

Convert overflowed values into bigger units.

#


					
	public

hasNegativeValues(): bool

#


					
	public

hasPositiveValues(): bool

#


					
	public

total(string $unit): float

Get amount of given unit equivalent to the interval.

Throws

Carbon\Exceptions\UnknownUnitException|Carbon\Exceptions\UnitNotConfiguredException

#


					
	public

eq(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is equal to another

#


					
	public

equalTo(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is equal to another

#


					
	public

ne(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is not equal to another

#


					
	public

notEqualTo(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is not equal to another

#


					
	public

gt(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is greater (longer) than another

#


					
	public

greaterThan(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is greater (longer) than another

#


					
	public

gte(CarbonInterval|DateInterval|mixed $interval): bool

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

#


					
	public

greaterThanOrEqualTo(CarbonInterval|DateInterval|mixed $interval): bool

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

#


					
	public

lt(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is less (shorter) than another

#


					
	public

lessThan(CarbonInterval|DateInterval|mixed $interval): bool

Determines if the instance is less (shorter) than another

#


					
	public

lte(CarbonInterval|DateInterval|mixed $interval): bool

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

#


					
	public

lessThanOrEqualTo(CarbonInterval|DateInterval|mixed $interval): bool

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

#


					
	public

between(
	CarbonInterval|DateInterval|mixed $interval1,
	CarbonInterval|DateInterval|mixed $interval2,
	bool $equal = true,
): bool

Determines if the instance is between two others.

The third argument allow you to specify if bounds are included or not (true by default) but for when you including/excluding bounds may produce different results in your application, we recommend to use the explicit methods ->betweenIncluded() or ->betweenExcluded() instead.

Parameters

$equal

Indicates if an equal to comparison should be done

#


					
	public

betweenIncluded(CarbonInterval|DateInterval|mixed $interval1, CarbonInterval|DateInterval|mixed $interval2): bool

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

#


					
	public

betweenExcluded(CarbonInterval|DateInterval|mixed $interval1, CarbonInterval|DateInterval|mixed $interval2): bool

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

#


					
	public

isBetween(
	CarbonInterval|DateInterval|mixed $interval1,
	CarbonInterval|DateInterval|mixed $interval2,
	bool $equal = true,
): bool

Determines if the instance is between two others

Parameters

$equal

Indicates if an equal to comparison should be done

#


					
	public

roundUnit(string $unit, DateInterval|string|int|float $precision = 1, string $function = 'round'): static

Round the current instance at the given unit with given precision if specified and the given function.

Throws

Exception

#


					
	public

floorUnit(string $unit, float|int|string|DateInterval|null $precision = 1): $this

Truncate the current instance at the given unit with given precision if specified.

Throws

Exception

#


					
	public

ceilUnit(string $unit, float|int|string|DateInterval|null $precision = 1): $this

Ceil the current instance at the given unit with given precision if specified.

Throws

Exception

#


					
	public

round(float|int|string|DateInterval|null $precision = 1, string $function = 'round'): $this

Round the current instance second with given precision if specified.

Throws

Exception

#


					
	public

floor(DateInterval|string|float|int $precision = 1): $this

Round the current instance second with given precision if specified.

Throws

Exception

#


					
	public

ceil(DateInterval|string|float|int $precision = 1): $this

Ceil the current instance second with given precision if specified.

Throws

Exception

#


					
	public

__unserialize(array $data): void

Overrides

DateInterval::__unserialize()

#


					
	public
					static

years($years = 1): CarbonInterval

Create instance specifying a number of years or modify the number of years if called on an instance.

#


					
	public
					static

year($years = 1): CarbonInterval

Alias for years()

#


					
	public
					static

months($months = 1): CarbonInterval

Create instance specifying a number of months or modify the number of months if called on an instance.

#


					
	public
					static

month($months = 1): CarbonInterval

Alias for months()

#


					
	public
					static

weeks($weeks = 1): CarbonInterval

Create instance specifying a number of weeks or modify the number of weeks if called on an instance.

#


					
	public
					static

week($weeks = 1): CarbonInterval

Alias for weeks()

#


					
	public
					static

days($days = 1): CarbonInterval

Create instance specifying a number of days or modify the number of days if called on an instance.

#


					
	public
					static

dayz($days = 1): CarbonInterval

Alias for days()

#


					
	public
					static

daysExcludeWeeks($days = 1): CarbonInterval

Create instance specifying a number of days or modify the number of days (keeping the current number of weeks) if…

Create instance specifying a number of days or modify the number of days (keeping the current number of weeks) if called on an instance.

#


					
	public
					static

dayzExcludeWeeks($days = 1): CarbonInterval

Alias for daysExcludeWeeks()

#


					
	public
					static

day($days = 1): CarbonInterval

Alias for days()

#


					
	public
					static

hours($hours = 1): CarbonInterval

Create instance specifying a number of hours or modify the number of hours if called on an instance.

#


					
	public
					static

hour($hours = 1): CarbonInterval

Alias for hours()

#


					
	public
					static

minutes($minutes = 1): CarbonInterval

Create instance specifying a number of minutes or modify the number of minutes if called on an instance.

#


					
	public
					static

minute($minutes = 1): CarbonInterval

Alias for minutes()

#


					
	public
					static

seconds($seconds = 1): CarbonInterval

Create instance specifying a number of seconds or modify the number of seconds if called on an instance.

#


					
	public
					static

second($seconds = 1): CarbonInterval

Alias for seconds()

#


					
	public
					static

milliseconds($milliseconds = 1): CarbonInterval

Create instance specifying a number of milliseconds or modify the number of milliseconds if called on an instance.

#


					
	public
					static

millisecond($milliseconds = 1): CarbonInterval

Alias for milliseconds()

#


					
	public
					static

microseconds($microseconds = 1): CarbonInterval

Create instance specifying a number of microseconds or modify the number of microseconds if called on an instance.

#


					
	public
					static

microsecond($microseconds = 1): CarbonInterval

Alias for microseconds()

#


					
	public

addYears(int $years): $this

Add given number of years to the current interval

#


					
	public

subYears(int $years): $this

Subtract given number of years to the current interval

#


					
	public

addMonths(int $months): $this

Add given number of months to the current interval

#


					
	public

subMonths(int $months): $this

Subtract given number of months to the current interval

#


					
	public

addWeeks(int|float $weeks): $this

Add given number of weeks to the current interval

#


					
	public

subWeeks(int|float $weeks): $this

Subtract given number of weeks to the current interval

#


					
	public

addDays(int|float $days): $this

Add given number of days to the current interval

#


					
	public

subDays(int|float $days): $this

Subtract given number of days to the current interval

#


					
	public

addHours(int|float $hours): $this

Add given number of hours to the current interval

#


					
	public

subHours(int|float $hours): $this

Subtract given number of hours to the current interval

#


					
	public

addMinutes(int|float $minutes): $this

Add given number of minutes to the current interval

#


					
	public

subMinutes(int|float $minutes): $this

Subtract given number of minutes to the current interval

#


					
	public

addSeconds(int|float $seconds): $this

Add given number of seconds to the current interval

#


					
	public

subSeconds(int|float $seconds): $this

Subtract given number of seconds to the current interval

#


					
	public

addMilliseconds(int|float $milliseconds): $this

Add given number of milliseconds to the current interval

#


					
	public

subMilliseconds(int|float $milliseconds): $this

Subtract given number of milliseconds to the current interval

#


					
	public

addMicroseconds(int|float $microseconds): $this

Add given number of microseconds to the current interval

#


					
	public

subMicroseconds(int|float $microseconds): $this

Subtract given number of microseconds to the current interval

#


					
	public

roundYear(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundYears(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorYear(int|float $precision = 1): $this

Truncate the current instance year with given precision.

#


					
	public

floorYears(int|float $precision = 1): $this

Truncate the current instance year with given precision.

#


					
	public

ceilYear(int|float $precision = 1): $this

Ceil the current instance year with given precision.

#


					
	public

ceilYears(int|float $precision = 1): $this

Ceil the current instance year with given precision.

#


					
	public

roundMonth(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundMonths(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorMonth(int|float $precision = 1): $this

Truncate the current instance month with given precision.

#


					
	public

floorMonths(int|float $precision = 1): $this

Truncate the current instance month with given precision.

#


					
	public

ceilMonth(int|float $precision = 1): $this

Ceil the current instance month with given precision.

#


					
	public

ceilMonths(int|float $precision = 1): $this

Ceil the current instance month with given precision.

#


					
	public

roundWeek(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundWeeks(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorWeek(int|float $precision = 1): $this

Truncate the current instance day with given precision.

#


					
	public

floorWeeks(int|float $precision = 1): $this

Truncate the current instance day with given precision.

#


					
	public

ceilWeek(int|float $precision = 1): $this

Ceil the current instance day with given precision.

#


					
	public

ceilWeeks(int|float $precision = 1): $this

Ceil the current instance day with given precision.

#


					
	public

roundDay(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundDays(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorDay(int|float $precision = 1): $this

Truncate the current instance day with given precision.

#


					
	public

floorDays(int|float $precision = 1): $this

Truncate the current instance day with given precision.

#


					
	public

ceilDay(int|float $precision = 1): $this

Ceil the current instance day with given precision.

#


					
	public

ceilDays(int|float $precision = 1): $this

Ceil the current instance day with given precision.

#


					
	public

roundHour(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundHours(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorHour(int|float $precision = 1): $this

Truncate the current instance hour with given precision.

#


					
	public

floorHours(int|float $precision = 1): $this

Truncate the current instance hour with given precision.

#


					
	public

ceilHour(int|float $precision = 1): $this

Ceil the current instance hour with given precision.

#


					
	public

ceilHours(int|float $precision = 1): $this

Ceil the current instance hour with given precision.

#


					
	public

roundMinute(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundMinutes(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorMinute(int|float $precision = 1): $this

Truncate the current instance minute with given precision.

#


					
	public

floorMinutes(int|float $precision = 1): $this

Truncate the current instance minute with given precision.

#


					
	public

ceilMinute(int|float $precision = 1): $this

Ceil the current instance minute with given precision.

#


					
	public

ceilMinutes(int|float $precision = 1): $this

Ceil the current instance minute with given precision.

#


					
	public

roundSecond(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundSeconds(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorSecond(int|float $precision = 1): $this

Truncate the current instance second with given precision.

#


					
	public

floorSeconds(int|float $precision = 1): $this

Truncate the current instance second with given precision.

#


					
	public

ceilSecond(int|float $precision = 1): $this

Ceil the current instance second with given precision.

#


					
	public

ceilSeconds(int|float $precision = 1): $this

Ceil the current instance second with given precision.

#


					
	public

roundMillennium(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundMillennia(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorMillennium(int|float $precision = 1): $this

Truncate the current instance millennium with given precision.

#


					
	public

floorMillennia(int|float $precision = 1): $this

Truncate the current instance millennium with given precision.

#


					
	public

ceilMillennium(int|float $precision = 1): $this

Ceil the current instance millennium with given precision.

#


					
	public

ceilMillennia(int|float $precision = 1): $this

Ceil the current instance millennium with given precision.

#


					
	public

roundCentury(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundCenturies(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorCentury(int|float $precision = 1): $this

Truncate the current instance century with given precision.

#


					
	public

floorCenturies(int|float $precision = 1): $this

Truncate the current instance century with given precision.

#


					
	public

ceilCentury(int|float $precision = 1): $this

Ceil the current instance century with given precision.

#


					
	public

ceilCenturies(int|float $precision = 1): $this

Ceil the current instance century with given precision.

#


					
	public

roundDecade(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundDecades(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorDecade(int|float $precision = 1): $this

Truncate the current instance decade with given precision.

#


					
	public

floorDecades(int|float $precision = 1): $this

Truncate the current instance decade with given precision.

#


					
	public

ceilDecade(int|float $precision = 1): $this

Ceil the current instance decade with given precision.

#


					
	public

ceilDecades(int|float $precision = 1): $this

Ceil the current instance decade with given precision.

#


					
	public

roundQuarter(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundQuarters(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorQuarter(int|float $precision = 1): $this

Truncate the current instance quarter with given precision.

#


					
	public

floorQuarters(int|float $precision = 1): $this

Truncate the current instance quarter with given precision.

#


					
	public

ceilQuarter(int|float $precision = 1): $this

Ceil the current instance quarter with given precision.

#


					
	public

ceilQuarters(int|float $precision = 1): $this

Ceil the current instance quarter with given precision.

#


					
	public

roundMillisecond(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundMilliseconds(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorMillisecond(int|float $precision = 1): $this

Truncate the current instance millisecond with given precision.

#


					
	public

floorMilliseconds(int|float $precision = 1): $this

Truncate the current instance millisecond with given precision.

#


					
	public

ceilMillisecond(int|float $precision = 1): $this

Ceil the current instance millisecond with given precision.

#


					
	public

ceilMilliseconds(int|float $precision = 1): $this

Ceil the current instance millisecond with given precision.

#


					
	public

roundMicrosecond(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

roundMicroseconds(int|float $precision = 1, string $function = "\"round\""): $this

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

#


					
	public

floorMicrosecond(int|float $precision = 1): $this

Truncate the current instance microsecond with given precision.

#


					
	public

floorMicroseconds(int|float $precision = 1): $this

Truncate the current instance microsecond with given precision.

#


					
	public

ceilMicrosecond(int|float $precision = 1): $this

Ceil the current instance microsecond with given precision.

#


					
	public

ceilMicroseconds(int|float $precision = 1): $this

Ceil the current instance microsecond with given precision.

#

Constants
`public`	`NO_LIMIT = -1` Unlimited parts for forHumans() method. Unlimited parts for forHumans() method. INF constant can be used instead.	#
`public`	`POSITIVE = 1`	#
`public`	`NEGATIVE = -1`	#
`public`	`PERIOD_PREFIX = 'P'` Interval spec period designators Interval spec period designators	#
`public`	`PERIOD_YEARS = 'Y'`	#
`public`	`PERIOD_MONTHS = 'M'`	#
`public`	`PERIOD_DAYS = 'D'`	#
`public`	`PERIOD_TIME_PREFIX = 'T'`	#
`public`	`PERIOD_HOURS = 'H'`	#
`public`	`PERIOD_MINUTES = 'M'`	#
`public`	`PERIOD_SECONDS = 'S'`	#
`public`	`SPECIAL_TRANSLATIONS = [ 1 => [ 'option' => CarbonInterface::ONE_DAY_WORDS, 'future' => 'diff_tomorrow', 'past' => 'diff_yesterday', ], 2 => [ 'option' => CarbonInterface::TWO_DAY_WORDS, 'future' => 'diff_after_tomorrow', 'past' => 'diff_before_yesterday', ], ]`	#

Properties
`protected static`	`?array`	`$cascadeFactors = null`	#
`protected static`	`array`	`$formats = [ 'y' => 'y', 'Y' => 'y', 'o' => 'y', 'm' => 'm', 'n' => 'm', 'W' => 'weeks', 'd' => 'd', 'j' => 'd', 'z' => 'd', 'h' => 'h', 'g' => 'h', 'H' => 'h', 'G' => 'h', 'i' => 'i', 's' => 's', 'u' => 'micro', 'v' => 'milli', ]`	#
`protected static`	`array`	`$macros = []` The registered macros. The registered macros.	#
`protected`	`DateTimeZone\|string\|int\|null`	`$timezoneSetting = null` Timezone handler for settings() method. Timezone handler for settings() method.	#
`protected`	`mixed`	`$originalInput = null` The input used to create the interval. The input used to create the interval.	#
`protected`	`?CarbonInterface`	`$startDate = null` Start date if interval was created from a difference between 2 dates. Start date if interval was created from a difference between 2 dates.	#
`protected`	`?CarbonInterface`	`$endDate = null` End date if interval was created from a difference between 2 dates. End date if interval was created from a difference between 2 dates.	#
`protected`	`?DateInterval`	`$rawInterval = null` End date if interval was created from a difference between 2 dates. End date if interval was created from a difference between 2 dates.	#
`protected`	`bool`	`$absolute = false` Flag if the interval was made from a diff with absolute flag on. Flag if the interval was made from a diff with absolute flag on.	#
`protected`	`?array`	`$initialValues = null`	#
`public`	`int`	`$years` Year component of the current interval. (For P2Y6M, the value will be 2) Year component of the current interval. (For P2Y6M, the value will be 2)	#
`public`	`int`	`$months` Month component of the current interval. (For P1Y6M10D, the value will be 6) Month component of the current interval. (For P1Y6M10D, the value will be 6)	#
`public`	`int`	`$weeks` Week component of the current interval calculated from the days. (For P1Y6M17D, the value will be 2) Week component of the current interval calculated from the days. (For P1Y6M17D, the value will be 2)	#
`public`	`int`	`$dayz` Day component of the current interval (weeks * 7 + days). (For P6M17DT20H, the value will be 17) Day component of the current interval (weeks * 7 + days). (For P6M17DT20H, the value will be 17)	#
`public`	`int`	`$hours` Hour component of the current interval. (For P7DT20H5M, the value will be 20) Hour component of the current interval. (For P7DT20H5M, the value will be 20)	#
`public`	`int`	`$minutes` Minute component of the current interval. (For PT20H5M30S, the value will be 5) Minute component of the current interval. (For PT20H5M30S, the value will be 5)	#
`public`	`int`	`$seconds` Second component of the current interval. (CarbonInterval::minutes(2)->seconds(34)->microseconds(567_890)->seconds = 34) Second component of the current interval. (CarbonInterval::minutes(2)->seconds(34)->microseconds(567_890)->seconds = 34)	#
`public`	`int`	`$milliseconds` Milliseconds component of the current interval. (CarbonInterval::seconds(34)->microseconds(567_890)->milliseconds = 567) Milliseconds component of the current interval. (CarbonInterval::seconds(34)->microseconds(567_890)->milliseconds = 567)	#
`public`	`int`	`$microseconds` Microseconds component of the current interval. (CarbonInterval::seconds(34)->microseconds(567_890)->microseconds = 567… Microseconds component of the current interval. (CarbonInterval::seconds(34)->microseconds(567_890)->microseconds = 567_890)	#
`public`	`int`	`$microExcludeMilli` Remaining microseconds without the milliseconds. Remaining microseconds without the milliseconds.	#
`public`	`int`	`$dayzExcludeWeeks` Total days remaining in the final week of the current instance (days % 7). Total days remaining in the final week of the current instance (days % 7).	#
`public`	`int`	`$daysExcludeWeeks` alias of dayzExcludeWeeks alias of dayzExcludeWeeks	#
`public readonly`	`float`	`$totalYears` Number of years equivalent to the interval. (For P1Y6M, the value will be 1.5) Number of years equivalent to the interval. (For P1Y6M, the value will be 1.5)	#
`public readonly`	`float`	`$totalMonths` Number of months equivalent to the interval. (For P1Y6M10D, the value will be ~12.357) Number of months equivalent to the interval. (For P1Y6M10D, the value will be ~12.357)	#
`public readonly`	`float`	`$totalWeeks` Number of weeks equivalent to the interval. (For P6M17DT20H, the value will be ~26.548) Number of weeks equivalent to the interval. (For P6M17DT20H, the value will be ~26.548)	#
`public readonly`	`float`	`$totalDays` Number of days equivalent to the interval. (For P17DT20H, the value will be ~17.833) Number of days equivalent to the interval. (For P17DT20H, the value will be ~17.833)	#
`public readonly`	`float`	`$totalDayz` Alias for totalDays. Alias for totalDays.	#
`public readonly`	`float`	`$totalHours` Number of hours equivalent to the interval. (For P1DT20H5M, the value will be ~44.083) Number of hours equivalent to the interval. (For P1DT20H5M, the value will be ~44.083)	#
`public readonly`	`float`	`$totalMinutes` Number of minutes equivalent to the interval. (For PT20H5M30S, the value will be 1205.5) Number of minutes equivalent to the interval. (For PT20H5M30S, the value will be 1205.5)	#
`public readonly`	`float`	`$totalSeconds` Number of seconds equivalent to the interval. (CarbonInterval::minutes(2)->seconds(34)->microseconds(567_890)-… Number of seconds equivalent to the interval. (CarbonInterval::minutes(2)->seconds(34)->microseconds(567_890)->totalSeconds = 154.567_890)	#
`public readonly`	`float`	`$totalMilliseconds` Number of milliseconds equivalent to the interval. (CarbonInterval::seconds(34)->microseconds(567_890)-… Number of milliseconds equivalent to the interval. (CarbonInterval::seconds(34)->microseconds(567_890)->totalMilliseconds = 34567.890)	#
`public readonly`	`float`	`$totalMicroseconds` Number of microseconds equivalent to the interval. (CarbonInterval::seconds(34)->microseconds(567_890)-… Number of microseconds equivalent to the interval. (CarbonInterval::seconds(34)->microseconds(567_890)->totalMicroseconds = 34567890)	#
`public readonly`	`string`	`$locale` locale of the current instance locale of the current instance	#

Namespaces

Classes

Interfaces

Enums

Class Carbon\CarbonInterval

Throws

Overrides

Throws

Parameters

Throws

Parameters

Parameters

Overrides

Throws

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Overrides

Throws

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Overrides

Throws

Parameters

Parameters

Parameters

Returns

Returns

Throws

Parameters

Parameters

Throws

Throws

Throws

Throws

Throws

Throws

Overrides