Skip to content

Commit 0a554da

Browse files
taylorotwellgithub-actions[bot]
authored andcommitted
Update facade docblocks
1 parent 964c4bb commit 0a554da

File tree

1 file changed

+51
-32
lines changed

1 file changed

+51
-32
lines changed

src/Illuminate/Support/Facades/Date.php

Lines changed: 51 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,77 +13,96 @@
1313
* @method static void useCallable(callable $callable)
1414
* @method static void useClass(string $dateClass)
1515
* @method static void useFactory(object $factory)
16-
* @method static \Illuminate\Support\Carbon create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $timezone = null)
16+
* @method static bool canBeCreatedFromFormat(?string $date, string $format)
17+
* @method static \Illuminate\Support\Carbon|null create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $timezone = null)
1718
* @method static \Illuminate\Support\Carbon createFromDate($year = null, $month = null, $day = null, $timezone = null)
18-
* @method static \Illuminate\Support\Carbon|false createFromFormat($format, $time, $timezone = null)
19+
* @method static \Illuminate\Support\Carbon|null createFromFormat($format, $time, $timezone = null)
20+
* @method static \Illuminate\Support\Carbon|null createFromIsoFormat(string $format, string $time, $timezone = null, ?string $locale = 'en', ?TranslatorInterface $translator = null)
21+
* @method static \Illuminate\Support\Carbon|null createFromLocaleFormat(string $format, string $locale, string $time, $timezone = null)
22+
* @method static \Illuminate\Support\Carbon|null createFromLocaleIsoFormat(string $format, string $locale, string $time, $timezone = null)
1923
* @method static \Illuminate\Support\Carbon createFromTime($hour = 0, $minute = 0, $second = 0, $timezone = null)
20-
* @method static \Illuminate\Support\Carbon createFromTimeString($time, $timezone = null)
21-
* @method static \Illuminate\Support\Carbon createFromTimestamp($timestamp, $timezone = null)
22-
* @method static \Illuminate\Support\Carbon createFromTimestampMs($timestamp, $timezone = null)
23-
* @method static \Illuminate\Support\Carbon createFromTimestampUTC($timestamp)
24+
* @method static \Illuminate\Support\Carbon createFromTimeString(string $time, DateTimeZone|string|int|null $timezone = null)
25+
* @method static \Illuminate\Support\Carbon createFromTimestamp(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)
26+
* @method static \Illuminate\Support\Carbon createFromTimestampMs(string|int|float $timestamp, DateTimeZone|string|int|null $timezone = null)
27+
* @method static \Illuminate\Support\Carbon createFromTimestampMsUTC($timestamp)
28+
* @method static \Illuminate\Support\Carbon createFromTimestampUTC(string|int|float $timestamp)
2429
* @method static \Illuminate\Support\Carbon createMidnightDate($year = null, $month = null, $day = null, $timezone = null)
25-
* @method static \Illuminate\Support\Carbon|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $timezone = null)
30+
* @method static \Illuminate\Support\Carbon|null createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $timezone = null)
31+
* @method static \Illuminate\Support\Carbon createStrict(?int $year = 0, ?int $month = 1, ?int $day = 1, ?int $hour = 0, ?int $minute = 0, ?int $second = 0, $timezone = null)
2632
* @method static void disableHumanDiffOption($humanDiffOption)
2733
* @method static void enableHumanDiffOption($humanDiffOption)
28-
* @method static mixed executeWithLocale($locale, $func)
34+
* @method static mixed executeWithLocale(string $locale, callable $func)
2935
* @method static \Illuminate\Support\Carbon fromSerialized($value)
3036
* @method static array getAvailableLocales()
37+
* @method static array getAvailableLocalesInfo()
3138
* @method static array getDays()
39+
* @method static ?string getFallbackLocale()
40+
* @method static array getFormatsToIsoReplacements()
3241
* @method static int getHumanDiffOptions()
3342
* @method static array getIsoUnits()
34-
* @method static array getLastErrors()
43+
* @method static array|false getLastErrors()
3544
* @method static string getLocale()
3645
* @method static int getMidDayAt()
46+
* @method static string getTimeFormatByPrecision(string $unitPrecision)
47+
* @method static string|Closure|null getTranslationMessageWith($translator, string $key, ?string $locale = null, ?string $default = null)
3748
* @method static \Illuminate\Support\Carbon|null getTestNow()
3849
* @method static \Symfony\Contracts\Translation\TranslatorInterface getTranslator()
39-
* @method static int getWeekEndsAt()
40-
* @method static int getWeekStartsAt()
50+
* @method static int getWeekEndsAt(?string $locale = null)
51+
* @method static int getWeekStartsAt(?string $locale = null)
4152
* @method static array getWeekendDays()
42-
* @method static bool hasFormat($date, $format)
53+
* @method static bool hasFormat(string $date, string $format)
54+
* @method static bool hasFormatWithModifiers(string $date, string $format)
4355
* @method static bool hasMacro($name)
44-
* @method static bool hasRelativeKeywords($time)
56+
* @method static bool hasRelativeKeywords(?string $time)
4557
* @method static bool hasTestNow()
46-
* @method static \Illuminate\Support\Carbon instance($date)
58+
* @method static \Illuminate\Support\Carbon instance(DateTimeInterface $date)
4759
* @method static bool isImmutable()
4860
* @method static bool isModifiableUnit($unit)
4961
* @method static bool isMutable()
5062
* @method static bool isStrictModeEnabled()
51-
* @method static bool localeHasDiffOneDayWords($locale)
52-
* @method static bool localeHasDiffSyntax($locale)
53-
* @method static bool localeHasDiffTwoDayWords($locale)
63+
* @method static bool localeHasDiffOneDayWords(string $locale)
64+
* @method static bool localeHasDiffSyntax(string $locale)
65+
* @method static bool localeHasDiffTwoDayWords(string $locale)
5466
* @method static bool localeHasPeriodSyntax($locale)
55-
* @method static bool localeHasShortUnits($locale)
56-
* @method static void macro($name, $macro)
57-
* @method static \Illuminate\Support\Carbon|null make($var)
58-
* @method static \Illuminate\Support\Carbon maxValue()
59-
* @method static \Illuminate\Support\Carbon minValue()
60-
* @method static void mixin($mixin)
61-
* @method static \Illuminate\Support\Carbon now($timezone = null)
62-
* @method static \Illuminate\Support\Carbon parse($time = null, $timezone = null)
67+
* @method static bool localeHasShortUnits(string $locale)
68+
* @method static void macro(string $name, ?callable $macro)
69+
* @method static \Illuminate\Support\Carbon|null make($var, DateTimeZone|string|null $timezone = null)
70+
* @method static void mixin(object|string $mixin)
71+
* @method static \Illuminate\Support\Carbon now(DateTimeZone|string|int|null $timezone = null)
72+
* @method static \Illuminate\Support\Carbon parse(DateTimeInterface|WeekDay|Month|string|int|float|null $time, DateTimeZone|string|int|null $timezone = null)
73+
* @method static \Illuminate\Support\Carbon parseFromLocale(string $time, ?string $locale = null, DateTimeZone|string|int|null $timezone = null)
6374
* @method static string pluralUnit(string $unit)
75+
* @method static \Illuminate\Support\Carbon|null rawCreateFromFormat(string $format, string $time, $timezone = null)
76+
* @method static \Illuminate\Support\Carbon rawParse(DateTimeInterface|WeekDay|Month|string|int|float|null $time, DateTimeZone|string|int|null $timezone = null)
6477
* @method static void resetMonthsOverflow()
6578
* @method static void resetToStringFormat()
6679
* @method static void resetYearsOverflow()
6780
* @method static void serializeUsing($callback)
81+
* @method static void setFallbackLocale(string $locale)
6882
* @method static void setHumanDiffOptions($humanDiffOptions)
69-
* @method static bool setLocale($locale)
83+
* @method static void setLocale(string $locale)
7084
* @method static void setMidDayAt($hour)
71-
* @method static void setTestNow($testNow = null)
72-
* @method static void setToStringFormat($format)
85+
* @method static void setTestNow(mixed $testNow = null)
86+
* @method static void setTestNowAndTimezone(mixed $testNow = null, $timezone = null)
87+
* @method static void setToStringFormat(string|Closure|null $format)
7388
* @method static void setTranslator(\Symfony\Contracts\Translation\TranslatorInterface $translator)
74-
* @method static void setUtf8($utf8)
7589
* @method static void setWeekEndsAt($day)
7690
* @method static void setWeekStartsAt($day)
7791
* @method static void setWeekendDays($days)
7892
* @method static bool shouldOverflowMonths()
7993
* @method static bool shouldOverflowYears()
8094
* @method static string singularUnit(string $unit)
81-
* @method static \Illuminate\Support\Carbon today($timezone = null)
82-
* @method static \Illuminate\Support\Carbon tomorrow($timezone = null)
95+
* @method static void sleep(int|float $seconds)
96+
* @method static \Illuminate\Support\Carbon today(DateTimeZone|string|int|null $timezone = null)
97+
* @method static \Illuminate\Support\Carbon tomorrow(DateTimeZone|string|int|null $timezone = null)
98+
* @method static string translateTimeString(string $timeString, ?string $from = null, ?string $to = null, int $mode = CarbonInterface::TRANSLATE_ALL)
99+
* @method static string translateWith(TranslatorInterface $translator, string $key, array $parameters = [], $number = null)
83100
* @method static void useMonthsOverflow($monthsOverflow = true)
84101
* @method static void useStrictMode($strictModeEnabled = true)
85102
* @method static void useYearsOverflow($yearsOverflow = true)
86-
* @method static \Illuminate\Support\Carbon yesterday($timezone = null)
103+
* @method static mixed withTestNow(mixed $testNow, callable $callback)
104+
* @method static static withTimeZone(DateTimeZone|string|int|null $timezone)
105+
* @method static \Illuminate\Support\Carbon yesterday(DateTimeZone|string|int|null $timezone = null)
87106
*
88107
* @see \Illuminate\Support\DateFactory
89108
*/

0 commit comments

Comments
 (0)