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.

static Carbon

create(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

static Carbon

createFromDate(mixed $year, mixed $month, mixed $day, mixed $tz)

No description

static Carbon|false

createFromFormat(mixed $format, mixed $time, mixed $tz)

No description

static Carbon

createFromTime(mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

static Carbon

createFromTimeString(mixed $time, mixed $tz)

No description

static Carbon

createFromTimestamp(mixed $timestamp, mixed $tz)

No description

static Carbon

createFromTimestampMs(mixed $timestamp, mixed $tz)

No description

static Carbon

createFromTimestampUTC(mixed $timestamp)

No description

static Carbon

createMidnightDate(mixed $year, mixed $month, mixed $day, mixed $tz)

No description

static Carbon|false

createSafe(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

static Carbon

disableHumanDiffOption(mixed $humanDiffOption)

No description

static Carbon

enableHumanDiffOption(mixed $humanDiffOption)

No description

static mixed

executeWithLocale(mixed $locale, mixed $func)

No description

static Carbon

fromSerialized(mixed $value)

No description

static array

getAvailableLocales()

No description

static array

getDays()

No description

static int

getHumanDiffOptions()

No description

static array

getIsoUnits()

No description

static Carbon

getLastErrors()

No description

static string

getLocale()

No description

static int

getMidDayAt()

No description

static Carbon

getTestNow()

No description

static TranslatorInterface

getTranslator()

No description

static int

getWeekEndsAt()

No description

static int

getWeekStartsAt()

No description

static array

getWeekendDays()

No description

static bool

hasFormat(mixed $date, mixed $format)

No description

static bool

hasMacro(mixed $name)

No description

static bool

hasRelativeKeywords(mixed $time)

No description

static bool

hasTestNow()

No description

static Carbon

instance(mixed $date)

No description

static bool

isImmutable()

No description

static bool

isModifiableUnit(mixed $unit)

No description

static Carbon

isMutable()

No description

static bool

isStrictModeEnabled()

No description

static bool

localeHasDiffOneDayWords(mixed $locale)

No description

static bool

localeHasDiffSyntax(mixed $locale)

No description

static bool

localeHasDiffTwoDayWords(mixed $locale)

No description

static bool

localeHasPeriodSyntax(mixed $locale)

No description

static bool

localeHasShortUnits(mixed $locale)

No description

static void

macro(mixed $name, mixed $macro)

No description

static Carbon|null

make(mixed $var)

No description

static Carbon

maxValue()

No description

static Carbon

minValue()

No description

static void

mixin(mixed $mixin)

No description

static Carbon

now(mixed $tz)

No description

static Carbon

parse(mixed $time, mixed $tz)

No description

static string

pluralUnit(string $unit)

No description

static void

resetMonthsOverflow()

No description

static void

resetToStringFormat()

No description

static void

resetYearsOverflow()

No description

static void

serializeUsing(mixed $callback)

No description

static Carbon

setHumanDiffOptions(mixed $humanDiffOptions)

No description

static bool

setLocale(mixed $locale)

No description

static void

setMidDayAt(mixed $hour)

No description

static Carbon

setTestNow(mixed $testNow)

No description

static void

setToStringFormat(mixed $format)

No description

static void

setTranslator(TranslatorInterface $translator)

No description

static Carbon

setUtf8(mixed $utf8)

No description

static void

setWeekEndsAt(mixed $day)

No description

static void

setWeekStartsAt(mixed $day)

No description

static void

setWeekendDays(mixed $days)

No description

static bool

shouldOverflowMonths()

No description

static bool

shouldOverflowYears()

No description

static string

singularUnit(string $unit)

No description

static Carbon

today(mixed $tz)

No description

static Carbon

tomorrow(mixed $tz)

No description

static void

useMonthsOverflow(mixed $monthsOverflow)

No description

static Carbon

useStrictMode(mixed $strictModeEnabled)

No description

static void

useYearsOverflow(mixed $yearsOverflow)

No description

static Carbon

yesterday(mixed $tz)

No description

Details

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

static void useDefault()

Use the default date class when generating dates.

Return Value

void

static void useCallable(callable $callable)

Execute the given callable on each date creation.

Parameters

callable

$callable

Return Value

void

static void useClass(string $dateClass)

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

Parameters

string

$dateClass

Return Value

void

static void useFactory(object $factory)

Use the given Carbon factory when generating dates.

Parameters

object

$factory

Return Value

void

mixed __call(string $method, array $parameters)

Handle dynamic calls to generate dates.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

RuntimeException

static Carbon create(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

Parameters

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

Return Value

Carbon

static Carbon createFromDate(mixed $year, mixed $month, mixed $day, mixed $tz)

No description

Parameters

mixed	$year
mixed	$month
mixed	$day
mixed	$tz

Return Value

Carbon

static Carbon|false createFromFormat(mixed $format, mixed $time, mixed $tz)

No description

Parameters

mixed	$format
mixed	$time
mixed	$tz

Return Value

Carbon|false

static Carbon createFromTime(mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

Parameters

mixed	$hour
mixed	$minute
mixed	$second
mixed	$tz

Return Value

Carbon

static Carbon createFromTimeString(mixed $time, mixed $tz)

No description

Parameters

mixed	$time
mixed	$tz

Return Value

Carbon

static Carbon createFromTimestamp(mixed $timestamp, mixed $tz)

No description

Parameters

mixed	$timestamp
mixed	$tz

Return Value

Carbon

static Carbon createFromTimestampMs(mixed $timestamp, mixed $tz)

No description

Parameters

mixed	$timestamp
mixed	$tz

Return Value

Carbon

static Carbon createFromTimestampUTC(mixed $timestamp)

No description

Parameters

mixed

$timestamp

Return Value

Carbon

static Carbon createMidnightDate(mixed $year, mixed $month, mixed $day, mixed $tz)

No description

Parameters

mixed	$year
mixed	$month
mixed	$day
mixed	$tz

Return Value

Carbon

static Carbon|false createSafe(mixed $year, mixed $month, mixed $day, mixed $hour, mixed $minute, mixed $second, mixed $tz)

No description

Parameters

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

Return Value

Carbon|false

static Carbon disableHumanDiffOption(mixed $humanDiffOption)

No description

Parameters

mixed

$humanDiffOption

Return Value

Carbon

static Carbon enableHumanDiffOption(mixed $humanDiffOption)

No description

Parameters

mixed

$humanDiffOption

Return Value

Carbon

static mixed executeWithLocale(mixed $locale, mixed $func)

No description

Parameters

mixed	$locale
mixed	$func

Return Value

mixed

static Carbon fromSerialized(mixed $value)

No description

Parameters

mixed

$value

Return Value

Carbon

static array getAvailableLocales()

No description

Return Value

array

static array getDays()

No description

Return Value

array

static int getHumanDiffOptions()

No description

Return Value

int

static array getIsoUnits()

No description

Return Value

array

static Carbon getLastErrors()

No description

Return Value

Carbon

static string getLocale()

No description

Return Value

string

static int getMidDayAt()

No description

Return Value

int

static Carbon getTestNow()

No description

Return Value

Carbon

static TranslatorInterface getTranslator()

No description

Return Value

TranslatorInterface

static int getWeekEndsAt()

No description

Return Value

int

static int getWeekStartsAt()

No description

Return Value

int

static array getWeekendDays()

No description

Return Value

array

static bool hasFormat(mixed $date, mixed $format)

No description

Parameters

mixed	$date
mixed	$format

Return Value

bool

static bool hasMacro(mixed $name)

No description

Parameters

mixed

$name

Return Value

bool

static bool hasRelativeKeywords(mixed $time)

No description

Parameters

mixed

$time

Return Value

bool

static bool hasTestNow()

No description

Return Value

bool

static Carbon instance(mixed $date)

No description

Parameters

mixed

$date

Return Value

Carbon

static bool isImmutable()

No description

Return Value

bool

static bool isModifiableUnit(mixed $unit)

No description

Parameters

mixed

$unit

Return Value

bool

static Carbon isMutable()

No description

Return Value

Carbon

static bool isStrictModeEnabled()

No description

Return Value

bool

static bool localeHasDiffOneDayWords(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static bool localeHasDiffSyntax(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static bool localeHasDiffTwoDayWords(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static bool localeHasPeriodSyntax(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static bool localeHasShortUnits(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static void macro(mixed $name, mixed $macro)

No description

Parameters

mixed	$name
mixed	$macro

Return Value

void

static Carbon|null make(mixed $var)

No description

Parameters

mixed

$var

Return Value

Carbon|null

static Carbon maxValue()

No description

Return Value

Carbon

static Carbon minValue()

No description

Return Value

Carbon

static void mixin(mixed $mixin)

No description

Parameters

mixed

$mixin

Return Value

void

static Carbon now(mixed $tz)

No description

Parameters

mixed

$tz

Return Value

Carbon

static Carbon parse(mixed $time, mixed $tz)

No description

Parameters

mixed	$time
mixed	$tz

Return Value

Carbon

static string pluralUnit(string $unit)

No description

Parameters

string

$unit

Return Value

string

static void resetMonthsOverflow()

No description

Return Value

void

static void resetToStringFormat()

No description

Return Value

void

static void resetYearsOverflow()

No description

Return Value

void

static void serializeUsing(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static Carbon setHumanDiffOptions(mixed $humanDiffOptions)

No description

Parameters

mixed

$humanDiffOptions

Return Value

Carbon

static bool setLocale(mixed $locale)

No description

Parameters

mixed

$locale

Return Value

bool

static void setMidDayAt(mixed $hour)

No description

Parameters

mixed

$hour

Return Value

void

static Carbon setTestNow(mixed $testNow)

No description

Parameters

mixed

$testNow

Return Value

Carbon

static void setToStringFormat(mixed $format)

No description

Parameters

mixed

$format

Return Value

void

static void setTranslator(TranslatorInterface $translator)

No description

Parameters

TranslatorInterface

$translator

Return Value

void

static Carbon setUtf8(mixed $utf8)

No description

Parameters

mixed

$utf8

Return Value

Carbon

static void setWeekEndsAt(mixed $day)

No description

Parameters

mixed

$day

Return Value

void

static void setWeekStartsAt(mixed $day)

No description

Parameters

mixed

$day

Return Value

void

static void setWeekendDays(mixed $days)

No description

Parameters

mixed

$days

Return Value

void

static bool shouldOverflowMonths()

No description

Return Value

bool

static bool shouldOverflowYears()

No description

Return Value

bool

static string singularUnit(string $unit)

No description

Parameters

string

$unit

Return Value

string

static Carbon today(mixed $tz)

No description

Parameters

mixed

$tz

Return Value

Carbon

static Carbon tomorrow(mixed $tz)

No description

Parameters

mixed

$tz

Return Value

Carbon

static void useMonthsOverflow(mixed $monthsOverflow)

No description

Parameters

mixed

$monthsOverflow

Return Value

void

static Carbon useStrictMode(mixed $strictModeEnabled)

No description

Parameters

mixed

$strictModeEnabled

Return Value

Carbon

static void useYearsOverflow(mixed $yearsOverflow)

No description

Parameters

mixed

$yearsOverflow

Return Value

void

static Carbon yesterday(mixed $tz)

No description

Parameters

mixed

$tz

Return Value

Carbon

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Support/DateFactory.html