Просмотр файла vendor/nesbot/carbon/src/Carbon/FactoryImmutable.php

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