1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. DateFactory

DateFactory

class DateFactory (View source)

Constants

DEFAULT_CLASS_NAME

The default class that will be used for all created dates.

Properties

static protected string $dateClass

The type (class) of dates that should be created.
static protected callable $callable

This callable may be used to intercept date creation.
static protected object $factory

The Carbon factory that should be used when creating dates.

Methods

static mixed
use(mixed $handler)

Use the given handler when generating dates (class name, callable, or factory).

static void
useDefault()

Use the default date class when generating dates.

static void
useCallable(callable $callable)

Execute the given callable on each date creation.

static void
useClass(string $dateClass)

Use the given date type (class) when generating dates.

static void
useFactory(object $factory)

Use the given Carbon factory when generating dates.

mixed
__call(string $method, array $parameters)

Handle dynamic calls to generate dates.

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

No description

Carbon|null
create(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

Carbon
createFromDate(mixed $year, mixed $month, mixed $day, mixed $timezone)

No description

Carbon|null
createFromFormat(mixed $format, mixed $time, mixed $timezone)

No description

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

No description

Carbon|null
createFromLocaleFormat(string $format, string $locale, string $time, mixed $timezone)

No description

Carbon|null
createFromLocaleIsoFormat(string $format, string $locale, string $time, mixed $timezone)

No description

Carbon
createFromTime(mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

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

No description

Carbon
createFromTimestamp(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)

No description

Carbon
createFromTimestampMs(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)

No description

Carbon
createFromTimestampMsUTC(mixed $timestamp)

No description

Carbon
createFromTimestampUTC(string|int|float $timestamp)

No description

Carbon
createMidnightDate(mixed $year, mixed $month, mixed $day, mixed $timezone)

No description

Carbon|null
createSafe(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

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

No description

void
disableHumanDiffOption(mixed $humanDiffOption)

No description

void
enableHumanDiffOption(mixed $humanDiffOption)

No description

mixed
executeWithLocale(string $locale, callable $func)

No description

Carbon
fromSerialized(mixed $value)

No description

array
getAvailableLocales()

No description

array
getAvailableLocalesInfo()

No description

array
getDays()

No description

array
getFormatsToIsoReplacements()

No description

int
getHumanDiffOptions()

No description

array
getIsoUnits()

No description

array|false
getLastErrors()

No description

string
getLocale()

No description

int
getMidDayAt()

No description

string
getTimeFormatByPrecision(string $unitPrecision)

No description

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

No description

Carbon|null
getTestNow()

No description

TranslatorInterface
getTranslator()

No description

int
getWeekEndsAt(?string $locale = null)

No description

int
getWeekStartsAt(?string $locale = null)

No description

array
getWeekendDays()

No description

bool
hasFormat(string $date, string $format)

No description

bool
hasFormatWithModifiers(string $date, string $format)

No description

bool
hasMacro(mixed $name)

No description

bool
hasRelativeKeywords(?string $time)

No description

bool
hasTestNow()

No description

Carbon
instance(DateTimeInterface $date)

No description

bool
isImmutable()

No description

bool
isModifiableUnit(mixed $unit)

No description

bool
isMutable()

No description

bool
isStrictModeEnabled()

No description

bool
localeHasDiffOneDayWords(string $locale)

No description

bool
localeHasDiffSyntax(string $locale)

No description

bool
localeHasDiffTwoDayWords(string $locale)

No description

bool
localeHasPeriodSyntax(mixed $locale)

No description

bool
localeHasShortUnits(string $locale)

No description

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

No description

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

No description

void
mixin(object|string $mixin)

No description

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

No description

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

No description

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

No description

string
pluralUnit(string $unit)

No description

Carbon|null
rawCreateFromFormat(string $format, string $time, mixed $timezone)

No description

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

No description

void
resetMonthsOverflow()

No description

void
resetToStringFormat()

No description

void
resetYearsOverflow()

No description

void
serializeUsing(mixed $callback)

No description

void
setFallbackLocale(string $locale)

No description

void
setHumanDiffOptions(mixed $humanDiffOptions)

No description

void
setLocale(string $locale)

No description

void
setMidDayAt(mixed $hour)

No description

void
setTestNow(mixed $testNow = null)

No description

void
setTestNowAndTimezone(mixed $testNow = null, mixed $timezone)

No description

void
setToStringFormat(Closure|null $format)

No description

void
setTranslator(TranslatorInterface $translator)

No description

void
setWeekEndsAt(mixed $day)

No description

void
setWeekStartsAt(mixed $day)

No description

void
setWeekendDays(mixed $days)

No description

bool
shouldOverflowMonths()

No description

bool
shouldOverflowYears()

No description

string
singularUnit(string $unit)

No description

void
sleep(int|float $seconds)

No description

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

No description

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

No description

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

No description

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

No description

void
useMonthsOverflow(mixed $monthsOverflow)

No description

void
useStrictMode(mixed $strictModeEnabled)

No description

void
useYearsOverflow(mixed $yearsOverflow)

No description

mixed
withTestNow(mixed $testNow, callable $callback)

No description

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

No description

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

No description

Details

at line 141
static mixed use(mixed $handler)

Use the given handler when generating dates (class name, callable, or factory).

Parameters

mixed $handler

Return Value

mixed

Exceptions

InvalidArgumentException

at line 159
static void useDefault()

Use the default date class when generating dates.

Return Value

void

at line 172
static void useCallable(callable $callable)

Execute the given callable on each date creation.

Parameters

callable $callable

Return Value

void

at line 186
static void useClass(string $dateClass)

Use the given date type (class) when generating dates.

Parameters

string $dateClass

Return Value

void

at line 200
static void useFactory(object $factory)

Use the given Carbon factory when generating dates.

Parameters

object $factory

Return Value

void

at line 217
mixed __call(string $method, array $parameters)

Handle dynamic calls to generate dates.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

RuntimeException

at line 103
bool canBeCreatedFromFormat(?string $date, string $format)

No description

Parameters

?string $date
string $format

Return Value

bool

at line 103
Carbon|null create(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

Parameters

mixed $year
mixed $month
mixed $day
mixed $hour
mixed $minute
mixed $second
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon createFromDate(mixed $year, mixed $month, mixed $day, mixed $timezone)

No description

Parameters

mixed $year
mixed $month
mixed $day
mixed $timezone

Return Value

Carbon

at line 103
Carbon|null createFromFormat(mixed $format, mixed $time, mixed $timezone)

No description

Parameters

mixed $format
mixed $time
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon|null createFromIsoFormat(string $format, string $time, mixed $timezone, ?string $locale = 'en', TranslatorInterface $translator = null)

No description

Parameters

string $format
string $time
mixed $timezone
?string $locale
TranslatorInterface $translator

Return Value

Carbon|null

at line 103
Carbon|null createFromLocaleFormat(string $format, string $locale, string $time, mixed $timezone)

No description

Parameters

string $format
string $locale
string $time
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon|null createFromLocaleIsoFormat(string $format, string $locale, string $time, mixed $timezone)

No description

Parameters

string $format
string $locale
string $time
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon createFromTime(mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

Parameters

mixed $hour
mixed $minute
mixed $second
mixed $timezone

Return Value

Carbon

at line 103
Carbon createFromTimeString(string $time, DateTimeZone|string|int|null $timezone = null)

No description

Parameters

string $time
DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
Carbon createFromTimestamp(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)

No description

Parameters

string|int|float $timestamp
DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
Carbon createFromTimestampMs(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)

No description

Parameters

string|int|float $timestamp
DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
Carbon createFromTimestampMsUTC(mixed $timestamp)

No description

Parameters

mixed $timestamp

Return Value

Carbon

at line 103
Carbon createFromTimestampUTC(string|int|float $timestamp)

No description

Parameters

string|int|float $timestamp

Return Value

Carbon

at line 103
Carbon createMidnightDate(mixed $year, mixed $month, mixed $day, mixed $timezone)

No description

Parameters

mixed $year
mixed $month
mixed $day
mixed $timezone

Return Value

Carbon

at line 103
Carbon|null createSafe(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $timezone)

No description

Parameters

mixed $year
mixed $month
mixed $day
mixed $hour
mixed $minute
mixed $second
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon createStrict(?int $year, ?int $month = 1, ?int $day = 1, ?int $hour, ?int $minute, ?int $second, mixed $timezone)

No description

Parameters

?int $year
?int $month
?int $day
?int $hour
?int $minute
?int $second
mixed $timezone

Return Value

Carbon

at line 103
void disableHumanDiffOption(mixed $humanDiffOption)

No description

Parameters

mixed $humanDiffOption

Return Value

void

at line 103
void enableHumanDiffOption(mixed $humanDiffOption)

No description

Parameters

mixed $humanDiffOption

Return Value

void

at line 103
mixed executeWithLocale(string $locale, callable $func)

No description

Parameters

string $locale
callable $func

Return Value

mixed

at line 103
Carbon fromSerialized(mixed $value)

No description

Parameters

mixed $value

Return Value

Carbon

at line 103
array getAvailableLocales()

No description

Return Value

array

at line 103
array getAvailableLocalesInfo()

No description

Return Value

array

at line 103
array getDays()

No description

Return Value

array

at line 103
array getFormatsToIsoReplacements()

No description

Return Value

array

at line 103
int getHumanDiffOptions()

No description

Return Value

int

at line 103
array getIsoUnits()

No description

Return Value

array

at line 103
array|false getLastErrors()

No description

Return Value

array|false

at line 103
string getLocale()

No description

Return Value

string

at line 103
int getMidDayAt()

No description

Return Value

int

at line 103
string getTimeFormatByPrecision(string $unitPrecision)

No description

Parameters

string $unitPrecision

Return Value

string

at line 103
Closure|null getTranslationMessageWith(mixed $translator, string $key, ?string $locale = null, ?string $default = null)

No description

Parameters

mixed $translator
string $key
?string $locale
?string $default

Return Value

Closure|null

at line 103
Carbon|null getTestNow()

No description

Return Value

Carbon|null

at line 103
TranslatorInterface getTranslator()

No description

Return Value

TranslatorInterface

at line 103
int getWeekEndsAt(?string $locale = null)

No description

Parameters

?string $locale

Return Value

int

at line 103
int getWeekStartsAt(?string $locale = null)

No description

Parameters

?string $locale

Return Value

int

at line 103
array getWeekendDays()

No description

Return Value

array

at line 103
bool hasFormat(string $date, string $format)

No description

Parameters

string $date
string $format

Return Value

bool

at line 103
bool hasFormatWithModifiers(string $date, string $format)

No description

Parameters

string $date
string $format

Return Value

bool

at line 103
bool hasMacro(mixed $name)

No description

Parameters

mixed $name

Return Value

bool

at line 103
bool hasRelativeKeywords(?string $time)

No description

Parameters

?string $time

Return Value

bool

at line 103
bool hasTestNow()

No description

Return Value

bool

at line 103
Carbon instance(DateTimeInterface $date)

No description

Parameters

DateTimeInterface $date

Return Value

Carbon

at line 103
bool isImmutable()

No description

Return Value

bool

at line 103
bool isModifiableUnit(mixed $unit)

No description

Parameters

mixed $unit

Return Value

bool

at line 103
bool isMutable()

No description

Return Value

bool

at line 103
bool isStrictModeEnabled()

No description

Return Value

bool

at line 103
bool localeHasDiffOneDayWords(string $locale)

No description

Parameters

string $locale

Return Value

bool

at line 103
bool localeHasDiffSyntax(string $locale)

No description

Parameters

string $locale

Return Value

bool

at line 103
bool localeHasDiffTwoDayWords(string $locale)

No description

Parameters

string $locale

Return Value

bool

at line 103
bool localeHasPeriodSyntax(mixed $locale)

No description

Parameters

mixed $locale

Return Value

bool

at line 103
bool localeHasShortUnits(string $locale)

No description

Parameters

string $locale

Return Value

bool

at line 103
void macro(string $name, ?callable $macro)

No description

Parameters

string $name
?callable $macro

Return Value

void

at line 103
Carbon|null make(mixed $var, DateTimeZone|string|null $timezone = null)

No description

Parameters

mixed $var
DateTimeZone|string|null $timezone

Return Value

Carbon|null

at line 103
void mixin(object|string $mixin)

No description

Parameters

object|string $mixin

Return Value

void

at line 103
Carbon now(DateTimeZone|string|int|null $timezone = null)

No description

Parameters

DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
Carbon parse(Month|string|int|float|null $time, DateTimeZone|string|int|null $timezone = null)

No description

Parameters

Month|string|int|float|null $time
DateTimeZone|string|int|null $timezone

Return Value

Carbon

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

No description

Parameters

string $time
?string $locale
DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
string pluralUnit(string $unit)

No description

Parameters

string $unit

Return Value

string

at line 103
Carbon|null rawCreateFromFormat(string $format, string $time, mixed $timezone)

No description

Parameters

string $format
string $time
mixed $timezone

Return Value

Carbon|null

at line 103
Carbon rawParse(Month|string|int|float|null $time, DateTimeZone|string|int|null $timezone = null)

No description

Parameters

Month|string|int|float|null $time
DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
void resetMonthsOverflow()

No description

Return Value

void

at line 103
void resetToStringFormat()

No description

Return Value

void

at line 103
void resetYearsOverflow()

No description

Return Value

void

at line 103
void serializeUsing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
void setFallbackLocale(string $locale)

No description

Parameters

string $locale

Return Value

void

at line 103
void setHumanDiffOptions(mixed $humanDiffOptions)

No description

Parameters

mixed $humanDiffOptions

Return Value

void

at line 103
void setLocale(string $locale)

No description

Parameters

string $locale

Return Value

void

at line 103
void setMidDayAt(mixed $hour)

No description

Parameters

mixed $hour

Return Value

void

at line 103
void setTestNow(mixed $testNow = null)

No description

Parameters

mixed $testNow

Return Value

void

at line 103
void setTestNowAndTimezone(mixed $testNow = null, mixed $timezone)

No description

Parameters

mixed $testNow
mixed $timezone

Return Value

void

at line 103
void setToStringFormat(Closure|null $format)

No description

Parameters

Closure|null $format

Return Value

void

at line 103
void setTranslator(TranslatorInterface $translator)

No description

Parameters

TranslatorInterface $translator

Return Value

void

at line 103
void setWeekEndsAt(mixed $day)

No description

Parameters

mixed $day

Return Value

void

at line 103
void setWeekStartsAt(mixed $day)

No description

Parameters

mixed $day

Return Value

void

at line 103
void setWeekendDays(mixed $days)

No description

Parameters

mixed $days

Return Value

void

at line 103
bool shouldOverflowMonths()

No description

Return Value

bool

at line 103
bool shouldOverflowYears()

No description

Return Value

bool

at line 103
string singularUnit(string $unit)

No description

Parameters

string $unit

Return Value

string

at line 103
void sleep(int|float $seconds)

No description

Parameters

int|float $seconds

Return Value

void

at line 103
Carbon today(DateTimeZone|string|int|null $timezone = null)

No description

Parameters

DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
Carbon tomorrow(DateTimeZone|string|int|null $timezone = null)

No description

Parameters

DateTimeZone|string|int|null $timezone

Return Value

Carbon

at line 103
string translateTimeString(string $timeString, ?string $from = null, ?string $to = null, int $mode = \Carbon\CarbonInterface::TRANSLATE_ALL)

No description

Parameters

string $timeString
?string $from
?string $to
int $mode

Return Value

string

at line 103
string translateWith(TranslatorInterface $translator, string $key, array $parameters = [], mixed $number)

No description

Parameters

TranslatorInterface $translator
string $key
array $parameters
mixed $number

Return Value

string

at line 103
void useMonthsOverflow(mixed $monthsOverflow)

No description

Parameters

mixed $monthsOverflow

Return Value

void

at line 103
void useStrictMode(mixed $strictModeEnabled)

No description

Parameters

mixed $strictModeEnabled

Return Value

void

at line 103
void useYearsOverflow(mixed $yearsOverflow)

No description

Parameters

mixed $yearsOverflow

Return Value

void

at line 103
mixed withTestNow(mixed $testNow, callable $callback)

No description

Parameters

mixed $testNow
callable $callback

Return Value

mixed

at line 103
static void withTimeZone(DateTimeZone|string|int|null $timezone)

No description

Parameters

DateTimeZone|string|int|null $timezone

Return Value

void

at line 103
Carbon yesterday(DateTimeZone|string|int|null $timezone = null)

No description

Parameters

DateTimeZone|string|int|null $timezone

Return Value

Carbon