Gitiles
Code Review Sign In
gerrit.benkard.de / kubeia / 1ba5381a59770700b02f1f1023d2b2dca73c5e8d / . / mailcow / src / mailcow-dockerized / data / web / inc / lib / vendor / nesbot / carbon / src / Carbon / FactoryImmutable.php
blob: 596ee8064a93c305517e668e6b40f63229458bdd [file] [log] [blame]
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +0200[diff] [blame]1<?php
2
3/**
4 * This file is part of the Carbon package.
5 *
6 * (c) Brian Nesbitt <brian@nesbot.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
Matthias Andreas Benkard1ba53812022-12-27 17:32:58 +0100[diff] [blame^]11
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +0200[diff] [blame]12namespace Carbon;
13
14use Closure;
15
16/**
17 * A factory to generate CarbonImmutable instances with common settings.
18 *
19 * <autodoc generated by `composer phpdoc`>
20 *
Matthias Andreas Benkard1ba53812022-12-27 17:32:58 +0100[diff] [blame^]21 * @method bool canBeCreatedFromFormat($date, $format) Checks if the (date)time string is in a given format and valid to create a
22 * new instance.
23 * @method CarbonImmutable|false create($year = 0, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0, $tz = null) Create a new Carbon instance from a specific date and time.
24 * If any of $year, $month or $day are set to null their now() values will
25 * be used.
26 * If $hour is null it will be set to its now() value and the default
27 * values for $minute and $second will be their now() values.
28 * If $hour is not null then the default values for $minute and $second
29 * will be 0.
30 * @method CarbonImmutable createFromDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to now.
31 * @method CarbonImmutable|false createFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.
32 * @method CarbonImmutable|false createFromIsoFormat($format, $time, $tz = null, $locale = 'en', $translator = null) Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).
33 * @method CarbonImmutable|false createFromLocaleFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific format and a string in a given language.
34 * @method CarbonImmutable|false createFromLocaleIsoFormat($format, $locale, $time, $tz = null) Create a Carbon instance from a specific ISO format and a string in a given language.
35 * @method CarbonImmutable createFromTime($hour = 0, $minute = 0, $second = 0, $tz = null) Create a Carbon instance from just a time. The date portion is set to today.
36 * @method CarbonImmutable createFromTimeString($time, $tz = null) Create a Carbon instance from a time string. The date portion is set to today.
37 * @method CarbonImmutable createFromTimestamp($timestamp, $tz = null) Create a Carbon instance from a timestamp and set the timezone (use default one if not specified).
38 * Timestamp input can be given as int, float or a string containing one or more numbers.
39 * @method CarbonImmutable createFromTimestampMs($timestamp, $tz = null) Create a Carbon instance from a timestamp in milliseconds.
40 * Timestamp input can be given as int, float or a string containing one or more numbers.
41 * @method CarbonImmutable createFromTimestampMsUTC($timestamp) Create a Carbon instance from a timestamp in milliseconds.
42 * Timestamp input can be given as int, float or a string containing one or more numbers.
43 * @method CarbonImmutable createFromTimestampUTC($timestamp) Create a Carbon instance from an timestamp keeping the timezone to UTC.
44 * Timestamp input can be given as int, float or a string containing one or more numbers.
45 * @method CarbonImmutable createMidnightDate($year = null, $month = null, $day = null, $tz = null) Create a Carbon instance from just a date. The time portion is set to midnight.
46 * @method CarbonImmutable|false createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null) Create a new safe Carbon instance from a specific date and time.
47 * If any of $year, $month or $day are set to null their now() values will
48 * be used.
49 * If $hour is null it will be set to its now() value and the default
50 * values for $minute and $second will be their now() values.
51 * If $hour is not null then the default values for $minute and $second
52 * will be 0.
53 * If one of the set values is not valid, an InvalidDateException
54 * will be thrown.
55 * @method CarbonInterface createStrict(?int $year = 0, ?int $month = 1, ?int $day = 1, ?int $hour = 0, ?int $minute = 0, ?int $second = 0, $tz = null) Create a new Carbon instance from a specific date and time using strict validation.
56 * @method CarbonImmutable disableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
57 * You should rather use the ->settings() method.
58 * @method CarbonImmutable enableHumanDiffOption($humanDiffOption) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
59 * You should rather use the ->settings() method.
60 * @method mixed executeWithLocale($locale, $func) Set the current locale to the given, execute the passed function, reset the locale to previous one,
61 * then return the result of the closure (or null if the closure was void).
62 * @method CarbonImmutable fromSerialized($value) Create an instance from a serialized string.
63 * @method void genericMacro($macro, $priority = 0) Register a custom macro.
64 * @method array getAvailableLocales() Returns the list of internally available locales and already loaded custom locales.
65 * (It will ignore custom translator dynamic loading.)
66 * @method Language[] getAvailableLocalesInfo() Returns list of Language object for each available locale. This object allow you to get the ISO name, native
67 * name, region and variant of the locale.
68 * @method array getDays() Get the days of the week
69 * @method string|null getFallbackLocale() Get the fallback locale.
70 * @method array getFormatsToIsoReplacements() List of replacements from date() format to isoFormat().
71 * @method int getHumanDiffOptions() Return default humanDiff() options (merged flags as integer).
72 * @method array getIsoUnits() Returns list of locale units for ISO formatting.
73 * @method array getLastErrors() {@inheritdoc}
74 * @method string getLocale() Get the current translator locale.
75 * @method callable|null getMacro($name) Get the raw callable macro registered globally for a given name.
76 * @method int getMidDayAt() get midday/noon hour
77 * @method Closure|CarbonImmutable getTestNow() Get the Carbon instance (real or mock) to be returned when a "now"
78 * instance is created.
79 * @method string getTimeFormatByPrecision($unitPrecision) Return a format from H:i to H:i:s.u according to given unit precision.
80 * @method string getTranslationMessageWith($translator, string $key, ?string $locale = null, ?string $default = null) Returns raw translation message for a given key.
81 * @method \Symfony\Component\Translation\TranslatorInterface getTranslator() Get the default translator instance in use.
82 * @method int getWeekEndsAt() Get the last day of week
83 * @method int getWeekStartsAt() Get the first day of week
84 * @method array getWeekendDays() Get weekend days
85 * @method bool hasFormat($date, $format) Checks if the (date)time string is in a given format.
86 * @method bool hasFormatWithModifiers($date, $format) Checks if the (date)time string is in a given format.
87 * @method bool hasMacro($name) Checks if macro is registered globally.
88 * @method bool hasRelativeKeywords($time) Determine if a time string will produce a relative date.
89 * @method bool hasTestNow() Determine if there is a valid test instance set. A valid test instance
90 * is anything that is not null.
91 * @method CarbonImmutable instance($date) Create a Carbon instance from a DateTime one.
92 * @method bool isImmutable() Returns true if the current class/instance is immutable.
93 * @method bool isModifiableUnit($unit) Returns true if a property can be changed via setter.
94 * @method bool isMutable() Returns true if the current class/instance is mutable.
95 * @method bool isStrictModeEnabled() Returns true if the strict mode is globally in use, false else.
96 * (It can be overridden in specific instances.)
97 * @method bool localeHasDiffOneDayWords($locale) Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow).
98 * Support is considered enabled if the 3 words are translated in the given locale.
99 * @method bool localeHasDiffSyntax($locale) Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after).
100 * Support is considered enabled if the 4 sentences are translated in the given locale.
101 * @method bool localeHasDiffTwoDayWords($locale) Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow).
102 * Support is considered enabled if the 2 words are translated in the given locale.
103 * @method bool localeHasPeriodSyntax($locale) Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X).
104 * Support is considered enabled if the 4 sentences are translated in the given locale.
105 * @method bool localeHasShortUnits($locale) Returns true if the given locale is internally supported and has short-units support.
106 * Support is considered enabled if either year, day or hour has a short variant translated.
107 * @method void macro($name, $macro) Register a custom macro.
108 * @method CarbonImmutable|null make($var) Make a Carbon instance from given variable if possible.
109 * Always return a new instance. Parse only strings and only these likely to be dates (skip intervals
110 * and recurrences). Throw an exception for invalid format, but otherwise return null.
111 * @method CarbonImmutable maxValue() Create a Carbon instance for the greatest supported date.
112 * @method CarbonImmutable minValue() Create a Carbon instance for the lowest supported date.
113 * @method void mixin($mixin) Mix another object into the class.
114 * @method CarbonImmutable now($tz = null) Get a Carbon instance for the current date and time.
115 * @method CarbonImmutable parse($time = null, $tz = null) Create a carbon instance from a string.
116 * This is an alias for the constructor that allows better fluent syntax
117 * as it allows you to do Carbon::parse('Monday next week')->fn() rather
118 * than (new Carbon('Monday next week'))->fn().
119 * @method CarbonImmutable parseFromLocale($time, $locale = null, $tz = null) Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).
120 * @method string pluralUnit(string $unit) Returns standardized plural of a given singular/plural unit name (in English).
121 * @method CarbonImmutable|false rawCreateFromFormat($format, $time, $tz = null) Create a Carbon instance from a specific format.
122 * @method CarbonImmutable rawParse($time = null, $tz = null) Create a carbon instance from a string.
123 * This is an alias for the constructor that allows better fluent syntax
124 * as it allows you to do Carbon::parse('Monday next week')->fn() rather
125 * than (new Carbon('Monday next week'))->fn().
126 * @method CarbonImmutable resetMacros() Remove all macros and generic macros.
127 * @method void resetMonthsOverflow() @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
128 * You should rather use the ->settings() method.
129 * Or you can use method variants: addMonthsWithOverflow/addMonthsNoOverflow, same variants
130 * are available for quarters, years, decade, centuries, millennia (singular and plural forms).
131 * @method void resetToStringFormat() Reset the format used to the default when type juggling a Carbon instance to a string
132 * @method void resetYearsOverflow() @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
133 * You should rather use the ->settings() method.
134 * Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
135 * are available for quarters, years, decade, centuries, millennia (singular and plural forms).
136 * @method void serializeUsing($callback) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
137 * You should rather transform Carbon object before the serialization.
138 * JSON serialize all Carbon instances using the given callback.
139 * @method CarbonImmutable setFallbackLocale($locale) Set the fallback locale.
140 * @method CarbonImmutable setHumanDiffOptions($humanDiffOptions) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
141 * You should rather use the ->settings() method.
142 * @method bool setLocale($locale) Set the current translator locale and indicate if the source locale file exists.
143 * Pass 'auto' as locale to use closest language from the current LC_TIME locale.
144 * @method void setMidDayAt($hour) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
145 * You should rather consider mid-day is always 12pm, then if you need to test if it's an other
146 * hour, test it explicitly:
147 * $date->format('G') == 13
148 * or to set explicitly to a given hour:
149 * $date->setTime(13, 0, 0, 0)
150 * Set midday/noon hour
151 * @method CarbonImmutable setTestNow($testNow = null) Set a Carbon instance (real or mock) to be returned when a "now"
152 * instance is created. The provided instance will be returned
153 * specifically under the following conditions:
154 * - A call to the static now() method, ex. Carbon::now()
155 * - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
156 * - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
157 * - When a string containing the desired time is passed to Carbon::parse().
158 * Note the timezone parameter was left out of the examples above and
159 * has no affect as the mock value will be returned regardless of its value.
160 * Only the moment is mocked with setTestNow(), the timezone will still be the one passed
161 * as parameter of date_default_timezone_get() as a fallback (see setTestNowAndTimezone()).
162 * To clear the test instance call this method using the default
163 * parameter of null.
164 * /!\ Use this method for unit tests only.
165 * @method CarbonImmutable setTestNowAndTimezone($testNow = null, $tz = null) Set a Carbon instance (real or mock) to be returned when a "now"
166 * instance is created. The provided instance will be returned
167 * specifically under the following conditions:
168 * - A call to the static now() method, ex. Carbon::now()
169 * - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
170 * - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
171 * - When a string containing the desired time is passed to Carbon::parse().
172 * It will also align default timezone (e.g. call date_default_timezone_set()) with
173 * the second argument or if null, with the timezone of the given date object.
174 * To clear the test instance call this method using the default
175 * parameter of null.
176 * /!\ Use this method for unit tests only.
177 * @method void setToStringFormat($format) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
178 * You should rather let Carbon object being casted to string with DEFAULT_TO_STRING_FORMAT, and
179 * use other method or custom format passed to format() method if you need to dump an other string
180 * format.
181 * Set the default format used when type juggling a Carbon instance to a string
182 * @method void setTranslator(TranslatorInterface $translator) Set the default translator instance to use.
183 * @method CarbonImmutable setUtf8($utf8) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
184 * You should rather use UTF-8 language packages on every machine.
185 * Set if UTF8 will be used for localized date/time.
186 * @method void setWeekEndsAt($day) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
187 * Use $weekStartsAt optional parameter instead when using startOfWeek, floorWeek, ceilWeek
188 * or roundWeek method. You can also use the 'first_day_of_week' locale setting to change the
189 * start of week according to current locale selected and implicitly the end of week.
190 * Set the last day of week
191 * @method void setWeekStartsAt($day) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
192 * Use $weekEndsAt optional parameter instead when using endOfWeek method. You can also use the
193 * 'first_day_of_week' locale setting to change the start of week according to current locale
194 * selected and implicitly the end of week.
195 * Set the first day of week
196 * @method void setWeekendDays($days) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
197 * You should rather consider week-end is always saturday and sunday, and if you have some custom
198 * week-end days to handle, give to those days an other name and create a macro for them:
199 * ```
200 * Carbon::macro('isDayOff', function ($date) {
201 * return $date->isSunday() || $date->isMonday();
202 * });
203 * Carbon::macro('isNotDayOff', function ($date) {
204 * return !$date->isDayOff();
205 * });
206 * if ($someDate->isDayOff()) ...
207 * if ($someDate->isNotDayOff()) ...
208 * // Add 5 not-off days
209 * $count = 5;
210 * while ($someDate->isDayOff() || ($count-- > 0)) {
211 * $someDate->addDay();
212 * }
213 * ```
214 * Set weekend days
215 * @method bool shouldOverflowMonths() Get the month overflow global behavior (can be overridden in specific instances).
216 * @method bool shouldOverflowYears() Get the month overflow global behavior (can be overridden in specific instances).
217 * @method string singularUnit(string $unit) Returns standardized singular of a given singular/plural unit name (in English).
218 * @method CarbonImmutable today($tz = null) Create a Carbon instance for today.
219 * @method CarbonImmutable tomorrow($tz = null) Create a Carbon instance for tomorrow.
220 * @method string translateTimeString($timeString, $from = null, $to = null, $mode = CarbonInterface::TRANSLATE_ALL) Translate a time string from a locale to an other.
221 * @method string translateWith(TranslatorInterface $translator, string $key, array $parameters = [], $number = null) Translate using translation string or callback available.
222 * @method void useMonthsOverflow($monthsOverflow = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
223 * You should rather use the ->settings() method.
224 * Or you can use method variants: addMonthsWithOverflow/addMonthsNoOverflow, same variants
225 * are available for quarters, years, decade, centuries, millennia (singular and plural forms).
226 * @method CarbonImmutable useStrictMode($strictModeEnabled = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
227 * You should rather use the ->settings() method.
228 * @method void useYearsOverflow($yearsOverflow = true) @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
229 * You should rather use the ->settings() method.
230 * Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
231 * are available for quarters, years, decade, centuries, millennia (singular and plural forms).
232 * @method mixed withTestNow($testNow = null, $callback = null) Temporarily sets a static date to be used within the callback.
233 * Using setTestNow to set the date, executing the callback, then
234 * clearing the test instance.
235 * /!\ Use this method for unit tests only.
236 * @method CarbonImmutable yesterday($tz = null) Create a Carbon instance for yesterday.
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +0200[diff] [blame]237 *
238 * </autodoc>
239 */
240class FactoryImmutable extends Factory
241{
242 protected $className = CarbonImmutable::class;
243}