Class Carbon\Factory


					
	public

__construct(array $settings = [], ?string $className = null)

#


					
	public

getClassName(): string

#


					
	public

setClassName(string $className): self

#


					
	public

className(?string $className = null): self|string

#


					
	public

getSettings(): array

#


					
	public

setSettings(array $settings): self

#


					
	public

settings(?array $settings = null): self|array

#


					
	public

mergeSettings(array $settings): self

#


					
	public

setHumanDiffOptions(int $humanDiffOptions): void

#


					
	public

enableHumanDiffOption($humanDiffOption): void

#


					
	public

disableHumanDiffOption(int $humanDiffOption): void

#


					
	public

getHumanDiffOptions(): int

#


					
	public

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

Register a custom macro.

Pass null macro to remove it.

#


					
	public

resetMacros(): void

Remove all macros and generic macros.

#


					
	public

genericMacro(callable $macro, int $priority = 0): void

Register a custom macro.

Parameters

$priority

marco with higher priority is tried first

#


					
	public

hasMacro(string $name): bool

Checks if macro is registered globally.

#


					
	public

getMacro(string $name): ?callable

Get the raw callable macro registered globally for a given name.

#


					
	public

setTranslator(TranslatorInterface $translator): void

Set the default translator instance to use.

#


					
	public

getTranslator(): TranslatorInterface

Initialize the default translator instance if necessary.

#


					
	public

resetToStringFormat(): void

Reset the format used to the default when type juggling a Carbon instance to a string

#


					
	public

setToStringFormat(string|Closure|null $format): void

Set the default format used when type juggling a Carbon instance to a string.

#


					
	public

serializeUsing(string|callable|null $format): void

JSON serialize all Carbon instances using the given callback.

#


					
	public

useStrictMode(bool $strictModeEnabled = true): void

Enable the strict mode (or disable with passing false).

#


					
	public

isStrictModeEnabled(): bool

Returns true if the strict mode is globally in use, false else. (It can be overridden in specific instances.)

#


					
	public

useMonthsOverflow(bool $monthsOverflow = true): void

Indicates if months should be calculated with overflow.

#


					
	public

resetMonthsOverflow(): void

Reset the month overflow behavior.

#


					
	public

shouldOverflowMonths(): bool

Get the month overflow global behavior (can be overridden in specific instances).

#


					
	public

useYearsOverflow(bool $yearsOverflow = true): void

Indicates if years should be calculated with overflow.

#


					
	public

resetYearsOverflow(): void

Reset the month overflow behavior.

#


					
	public

shouldOverflowYears(): bool

Get the month overflow global behavior (can be overridden in specific instances).

#


					
	public

getWeekendDays(): array

Get weekend days

#


					
	public

setWeekendDays(array $days): void

Set weekend days

#


					
	public

hasFormat(string $date, string $format): bool

Checks if the (date)time string is in a given format.

#


					
	public

hasFormatWithModifiers(string $date, string $format): bool

Checks if the (date)time string is in a given format.

#


					
	public

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be…

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions:

A call to the static now() method, ex. Carbon::now()
When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
When a string containing the desired time is passed to Carbon::parse().

Note the timezone parameter was left out of the examples above and has no affect as the mock value will be returned regardless of its value.

Only the moment is mocked with setTestNow(), the timezone will still be the one passed as parameter of date_default_timezone_get() as a fallback (see setTestNowAndTimezone()).

To clear the test instance call this method using the default parameter of null.

/!\ Use this method for unit tests only.

Parameters

$testNow

real or mock Carbon instance

#


					
	public

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be…

Set a Carbon instance (real or mock) to be returned when a "now" instance is created. The provided instance will be returned specifically under the following conditions:

A call to the static now() method, ex. Carbon::now()
When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
When a string containing the desired time is passed to Carbon::parse().

It will also align default timezone (e.g. call date_default_timezone_set()) with the second argument or if null, with the timezone of the given date object.

To clear the test instance call this method using the default parameter of null.

/!\ Use this method for unit tests only.

Parameters

$testNow

real or mock Carbon instance

#


					
	public

Temporarily sets a static date to be used within the callback. Using setTestNow to set the date, executing the callback…

Temporarily sets a static date to be used within the callback. Using setTestNow to set the date, executing the callback, then clearing the test instance.

/!\ Use this method for unit tests only.

Parameters

$testNow

real or mock Carbon instance

#


					
	public

getTestNow(): Closure|CarbonInterface|null

Get the Carbon instance (real or mock) to be returned when a "now" instance is created.

Returns

the current instance used for testing

#


					
	public

handleTestNowClosure(
	Closure|CarbonInterface|null $testNow,
	DateTimeZone|string|int|null $timezone = null,
): ?CarbonInterface

#


					
	public

hasTestNow(): bool

Determine if there is a valid test instance set. A valid test instance is anything that is not null.

Returns

true if there is a test instance, otherwise false

#


					
	public

withTimeZone(DateTimeZone|string|int|null $timezone): static

#


					
	public

__call(string $name, array $arguments): mixed

#


					
	protected

getMockedTestNow(DateTimeZone|string|int|null $timezone): ?CarbonInterface

Get the mocked date passed in setTestNow() and if it's a Closure, execute it.

#


					
	public

canBeCreatedFromFormat(?string $date, string $format): bool

Checks if the (date)time string is in a given format and valid to create a …

Checks if the (date)time string is in a given format and valid to create a new instance.

#


					
	public

create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $timezone = null): ?Carbon

Create a new Carbon instance from a specific date and time. …

Create a new Carbon instance from a specific date and time. If any of $year, $month or $day are set to null their now() values will be used. If $hour is null it will be set to its now() value and the default values for $minute and $second will be their now() values. If $hour is not null then the default values for $minute and $second will be 0.

#


					
	public

createFromDate($year = null, $month = null, $day = null, $timezone = null): Carbon

Create a Carbon instance from just a date. The time portion is set to now.

#


					
	public

createFromFormat($format, $time, $timezone = null): ?Carbon

Create a Carbon instance from a specific format.

#


					
	public

createFromIsoFormat(
	string $format,
	string $time,
	$timezone = null,
	?string $locale = "'en'",
	?TranslatorInterface $translator = null,
): ?Carbon

Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).

#


					
	public

createFromLocaleFormat(string $format, string $locale, string $time, $timezone = null): ?Carbon

Create a Carbon instance from a specific format and a string in a given language.

#


					
	public

createFromLocaleIsoFormat(string $format, string $locale, string $time, $timezone = null): ?Carbon

Create a Carbon instance from a specific ISO format and a string in a given language.

#


					
	public

createFromTime($hour = 0, $minute = 0, $second = 0, $timezone = null): Carbon

Create a Carbon instance from just a time. The date portion is set to today.

#


					
	public

createFromTimeString(string $time, DateTimeZone|string|int|null $timezone = null): Carbon

Create a Carbon instance from a time string. The date portion is set to today.

#


					
	public

Create a Carbon instance from a timestamp and set the timezone (UTC by default). …

Create a Carbon instance from a timestamp and set the timezone (UTC by default). Timestamp input can be given as int, float or a string containing one or more numbers.

#


					
	public

Create a Carbon instance from a timestamp in milliseconds. …

Create a Carbon instance from a timestamp in milliseconds. Timestamp input can be given as int, float or a string containing one or more numbers.

#


					
	public

createFromTimestampMsUTC($timestamp): Carbon

Create a Carbon instance from a timestamp in milliseconds. …

Create a Carbon instance from a timestamp in milliseconds. Timestamp input can be given as int, float or a string containing one or more numbers.

#


					
	public

createFromTimestampUTC(string|int|float $timestamp): Carbon

Create a Carbon instance from a timestamp keeping the timezone to UTC. …

Create a Carbon instance from a timestamp keeping the timezone to UTC. Timestamp input can be given as int, float or a string containing one or more numbers.

#


					
	public

createMidnightDate($year = null, $month = null, $day = null, $timezone = null): Carbon

Create a Carbon instance from just a date. The time portion is set to midnight.

#


					
	public

createSafe(
	$year = null,
	$month = null,
	$day = null,
	$hour = null,
	$minute = null,
	$second = null,
	$timezone = null,
): ?Carbon

Create a new safe Carbon instance from a specific date and time. …

Create a new safe Carbon instance from a specific date and time. If any of $year, $month or $day are set to null their now() values will be used. If $hour is null it will be set to its now() value and the default values for $minute and $second will be their now() values. If $hour is not null then the default values for $minute and $second will be 0. If one of the set values is not valid, an InvalidDateException will be thrown.

#


					
	public

createStrict(
	?int $year = 0,
	?int $month = 1,
	?int $day = 1,
	?int $hour = 0,
	?int $minute = 0,
	?int $second = 0,
	$timezone = null,
): Carbon

Create a new Carbon instance from a specific date and time using strict validation.

#


					
	public

executeWithLocale(string $locale, callable $func): mixed

Set the current locale to the given, execute the passed function, reset the locale to previous one, …

Set the current locale to the given, execute the passed function, reset the locale to previous one, then return the result of the closure (or null if the closure was void).

#


					
	public

fromSerialized($value): Carbon

Create an instance from a serialized string.

#


					
	public

getAvailableLocales(): array

Returns the list of internally available locales and already loaded custom locales. …

Returns the list of internally available locales and already loaded custom locales. (It will ignore custom translator dynamic loading.)

#


					
	public

getAvailableLocalesInfo(): Language[]

Returns list of Language object for each available locale. This object allow you to get the ISO name, native …

Returns list of Language object for each available locale. This object allow you to get the ISO name, native name, region and variant of the locale.

#


					
	public

getDays(): array

Get the days of the week.

#


					
	public

getFallbackLocale(): ?string

Get the fallback locale.

#


					
	public

getFormatsToIsoReplacements(): array

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

#


					
	public

getIsoUnits(): array

Returns list of locale units for ISO formatting.

#


					
	public

getLastErrors(): array|false

{@inheritdoc}

#


					
	public

getLocale(): string

Get the current translator locale.

#


					
	public

getMidDayAt(): int

get midday/noon hour

#


					
	public

getTimeFormatByPrecision(string $unitPrecision): string

Return a format from H:i to H:i:s.u according to given unit precision.

#


					
	public

getTranslationMessageWith(
	$translator,
	string $key,
	?string $locale = null,
	?string $default = null,
): string|Closure|null

Returns raw translation message for a given key.

#


					
	public

getWeekEndsAt(?string $locale = null): int

Get the last day of week.

#


					
	public

getWeekStartsAt(?string $locale = null): int

Get the first day of week.

#


					
	public

hasRelativeKeywords(?string $time): bool

Determine if a time string will produce a relative date.

#


					
	public

instance(DateTimeInterface $date): Carbon

Create a Carbon instance from a DateTime one.

#


					
	public

isImmutable(): bool

Returns true if the current class/instance is immutable.

#


					
	public

isModifiableUnit($unit): bool

Returns true if a property can be changed via setter.

#


					
	public

isMutable(): bool

Returns true if the current class/instance is mutable.

#


					
	public

localeHasDiffOneDayWords(string $locale): bool

Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow). …

Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow). Support is considered enabled if the 3 words are translated in the given locale.

#


					
	public

localeHasDiffSyntax(string $locale): bool

Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after). …

Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after). Support is considered enabled if the 4 sentences are translated in the given locale.

#


					
	public

localeHasDiffTwoDayWords(string $locale): bool

Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after…

Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow). Support is considered enabled if the 2 words are translated in the given locale.

#


					
	public

localeHasPeriodSyntax($locale): bool

Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X)…

Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X). Support is considered enabled if the 4 sentences are translated in the given locale.

#


					
	public

localeHasShortUnits(string $locale): bool

Returns true if the given locale is internally supported and has short-units support. …

Returns true if the given locale is internally supported and has short-units support. Support is considered enabled if either year, day or hour has a short variant translated.

#


					
	public

make($var, DateTimeZone|string|null $timezone = null): ?Carbon

Make a Carbon instance from given variable if possible. …

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

#


					
	public

mixin(object|string $mixin): void

Mix another object into the class.

#


					
	public

now(DateTimeZone|string|int|null $timezone = null): Carbon

Get a Carbon instance for the current date and time.

#


					
	public

parse(
	DateTimeInterface|WeekDay|Month|string|int|float|null $time,
	DateTimeZone|string|int|null $timezone = null,
): Carbon

Create a carbon instance from a string. …

Create a carbon instance from a string. This is an alias for the constructor that allows better fluent syntax as it allows you to do Carbon::parse('Monday next week')->fn() rather than (new Carbon('Monday next week'))->fn().

#


					
	public

parseFromLocale(string $time, ?string $locale = null, DateTimeZone|string|int|null $timezone = null): Carbon

Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).

#


					
	public

pluralUnit(string $unit): string

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

#


					
	public

rawCreateFromFormat(string $format, string $time, $timezone = null): ?Carbon

Create a Carbon instance from a specific format.

#


					
	public

rawParse(
	DateTimeInterface|WeekDay|Month|string|int|float|null $time,
	DateTimeZone|string|int|null $timezone = null,
): Carbon

Create a carbon instance from a string. …

Create a carbon instance from a string. This is an alias for the constructor that allows better fluent syntax as it allows you to do Carbon::parse('Monday next week')->fn() rather than (new Carbon('Monday next week'))->fn().

#


					
	public

setFallbackLocale(string $locale): void

Set the fallback locale.

#


					
	public

setLocale(string $locale): void

Set the current translator locale and indicate if the source locale file exists. …

Set the current translator locale and indicate if the source locale file exists. Pass 'auto' as locale to use the closest language to the current LC_TIME locale.

#


					
	public

setMidDayAt($hour): void

@deprecated To avoid conflict between different third-party libraries, static setters should not be used. …

@deprecated To avoid conflict between different third-party libraries, static setters should not be used. You should rather consider mid-day is always 12pm, then if you need to test if it's an other hour, test it explicitly: $date->format('G') == 13 or to set explicitly to a given hour: $date->setTime(13, 0, 0, 0) Set midday/noon hour

#


					
	public

singularUnit(string $unit): string

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

#


					
	public

sleep(int|float $seconds): void

#


					
	public

today(DateTimeZone|string|int|null $timezone = null): Carbon

Create a Carbon instance for today.

#


					
	public

tomorrow(DateTimeZone|string|int|null $timezone = null): Carbon

Create a Carbon instance for tomorrow.

#


					
	public

translateTimeString(
	string $timeString,
	?string $from = null,
	?string $to = null,
	int $mode = CarbonInterface::TRANSLATE_ALL,
): string

Translate a time string from a locale to an other.

#


					
	public

translateWith(TranslatorInterface $translator, string $key, array $parameters = [], $number = null): string

Translate using translation string or callback available.

#


					
	public

yesterday(DateTimeZone|string|int|null $timezone = null): Carbon

Create a Carbon instance for yesterday.

#

Properties
`protected`	`string`	`$className = Carbon::class`	#
`protected`	`array`	`$settings = []`	#
`protected`	`Closure\|CarbonInterface\|null`	`$testNow = null` A test Carbon instance to be returned when now instances are created. A test Carbon instance to be returned when now instances are created.	#
`protected`	`?string`	`$testDefaultTimezone = null` The timezone to restore to when clearing the time mock. The timezone to restore to when clearing the time mock.	#
`protected`	`bool`	`$useTimezoneFromTestNow = false` Is true when test-now is generated by a closure and timezone should be taken on the fly from it. Is true when test-now is generated by a closure and timezone should be taken on the fly from it.	#
`protected`	`TranslatorInterface`	`$translator` Default translator. Default translator.	#
`protected`	`array`	`$weekendDays = [CarbonInterface::SATURDAY, CarbonInterface::SUNDAY]` Days of weekend. Days of weekend.	#
`protected`	`array<string, string>`	$regexFormats = [ 'd' => '(3[01]\|[12][0-9]\|0[1-9])', 'D' => '(Sun\|Mon\|Tue\|Wed\|Thu\|Fri\|Sat)', 'j' => '([123][0-9]\|[1-9])', 'l' => '([a-zA-Z]{2,})', 'N' => '([1-7])', 'S' => '(st\|nd\|rd\|th)', 'w' => '([0-6])', 'z' => '(36[0-5]\|3[0-5][0-9]\|[12][0-9]{2}\|[1-9]?[0-9])', 'W' => '(5[012]\|[1-4][0-9]\|0?[1-9])', 'F' => '([a-zA-Z]{2,})', 'm' => '(1[012]\|0[1-9])', 'M' => '([a-zA-Z]{3})', 'n' => '(1[012]\|[1-9])', 't' => '(2[89]\|3[01])', 'L' => '(0\|1)', 'o' => '([1-9][0-9]{0,4})', 'Y' => '([1-9]?[0-9]{4})', 'y' => '([0-9]{2})', 'a' => '(am\|pm)', 'A' => '(AM\|PM)', 'B' => '([0-9]{3})', 'g' => '(1[012]\|[1-9])', 'G' => '(2[0-3]\|1?[0-9])', 'h' => '(1[012]\|0[1-9])', 'H' => '(2[0-3]\|[01][0-9])', 'i' => '([0-5][0-9])', 's' => '([0-5][0-9])', 'u' => '([0-9]{1,6})', 'v' => '([0-9]{1,3})', 'e' => '([a-zA-Z]{1,5})\|([a-zA-Z]\\/[a-zA-Z])', 'I' => '(0\|1)', 'O' => '([+-](1[0123]\|0[0-9])[0134][05])', 'P' => '([+-](1[0123]\|0[0-9]):[0134][05])', 'p' => '(Z\|[+-](1[0123]\|0[0-9]):[0134][05])', 'T' => '([a-zA-Z]{1,5})', 'Z' => '(-?[1-5]?[0-9]{1,4})', 'U' => '([0-9]*)', 'c' => '(([1-9]?[0-9]{4})-(1[012]\|0[1-9])-(3[01]\|[12][0-9]\|0[1-9])T(2[0-3]\|[01][0-9]):([0-5][0-9]):([0-5][0-9])[+-](1[012]\|0[0-9]):([0134][05]))', 'r' => '(([a-zA-Z]{3}), ([123][0-9]\|0[1-9]) ([a-zA-Z]{3}) ([1-9]?[0-9]{4}) (2[0-3]\|[01][0-9]):([0-5][0-9]):([0-5][0-9]) [+-](1[012]\|0[0-9])([0134][05]))', ]	#
`protected`	`array`	`$regexFormatModifiers = [ '*' => '.+', ' ' => '[ ]', '#' => '[;:\\/.,()-]', '?' => '([^a]\|[a])', '!' => '', '\|' => '', '+' => '', ]`	#

Namespaces

Classes

Interfaces

Enums

Class Carbon\Factory

Parameters

Parameters

Parameters

Parameters

Returns

Returns