xref: /PHP-8.2/ext/intl/calendar/calendar.stub.php (revision 383eefa9) 
1<?php
2
3/** @generate-class-entries */
4
5/** @not-serializable */
6class IntlCalendar
7{
8    /**
9     * @var int
10     * @cvalue UCAL_ERA
11     */
12    public const FIELD_ERA = UNKNOWN;
13    /**
14     * @var int
15     * @cvalue UCAL_YEAR
16     */
17    public const FIELD_YEAR = UNKNOWN;
18    /**
19     * @var int
20     * @cvalue UCAL_MONTH
21     */
22    public const FIELD_MONTH = UNKNOWN;
23    /**
24     * @var int
25     * @cvalue UCAL_WEEK_OF_YEAR
26     */
27    public const FIELD_WEEK_OF_YEAR = UNKNOWN;
28    /**
29     * @var int
30     * @cvalue UCAL_WEEK_OF_MONTH
31     */
32    public const FIELD_WEEK_OF_MONTH = UNKNOWN;
33    /**
34     * @var int
35     * @cvalue UCAL_DATE
36     */
37    public const FIELD_DATE = UNKNOWN;
38    /**
39     * @var int
40     * @cvalue UCAL_DAY_OF_YEAR
41     */
42    public const FIELD_DAY_OF_YEAR = UNKNOWN;
43    /**
44     * @var int
45     * @cvalue UCAL_DAY_OF_WEEK
46     */
47    public const FIELD_DAY_OF_WEEK = UNKNOWN;
48    /**
49     * @var int
50     * @cvalue UCAL_DAY_OF_WEEK_IN_MONTH
51     */
52    public const FIELD_DAY_OF_WEEK_IN_MONTH = UNKNOWN;
53    /**
54     * @var int
55     * @cvalue UCAL_AM_PM
56     */
57    public const FIELD_AM_PM = UNKNOWN;
58    /**
59     * @var int
60     * @cvalue UCAL_HOUR
61     */
62    public const FIELD_HOUR = UNKNOWN;
63    /**
64     * @var int
65     * @cvalue UCAL_HOUR_OF_DAY
66     */
67    public const FIELD_HOUR_OF_DAY = UNKNOWN;
68    /**
69     * @var int
70     * @cvalue UCAL_MINUTE
71     */
72    public const FIELD_MINUTE = UNKNOWN;
73    /**
74     * @var int
75     * @cvalue UCAL_SECOND
76     */
77    public const FIELD_SECOND = UNKNOWN;
78    /**
79     * @var int
80     * @cvalue UCAL_MILLISECOND
81     */
82    public const FIELD_MILLISECOND = UNKNOWN;
83    /**
84     * @var int
85     * @cvalue UCAL_ZONE_OFFSET
86     */
87    public const FIELD_ZONE_OFFSET = UNKNOWN;
88    /**
89     * @var int
90     * @cvalue UCAL_DST_OFFSET
91     */
92    public const FIELD_DST_OFFSET = UNKNOWN;
93    /**
94     * @var int
95     * @cvalue UCAL_YEAR_WOY
96     */
97    public const FIELD_YEAR_WOY = UNKNOWN;
98    /**
99     * @var int
100     * @cvalue UCAL_DOW_LOCAL
101     */
102    public const FIELD_DOW_LOCAL = UNKNOWN;
103    /**
104     * @var int
105     * @cvalue UCAL_EXTENDED_YEAR
106     */
107    public const FIELD_EXTENDED_YEAR = UNKNOWN;
108    /**
109     * @var int
110     * @cvalue UCAL_JULIAN_DAY
111     */
112    public const FIELD_JULIAN_DAY = UNKNOWN;
113    /**
114     * @var int
115     * @cvalue UCAL_MILLISECONDS_IN_DAY
116     */
117    public const FIELD_MILLISECONDS_IN_DAY = UNKNOWN;
118    /**
119     * @var int
120     * @cvalue UCAL_IS_LEAP_MONTH
121     */
122    public const FIELD_IS_LEAP_MONTH = UNKNOWN;
123    /**
124     * @var int
125     * @cvalue UCAL_FIELD_COUNT
126     */
127    public const FIELD_FIELD_COUNT = UNKNOWN;
128    /**
129     * @var int
130     * @cvalue UCAL_DAY_OF_MONTH
131     */
132    public const FIELD_DAY_OF_MONTH = UNKNOWN;
133
134    /**
135     * @var int
136     * @cvalue UCAL_SUNDAY
137     */
138    public const DOW_SUNDAY = UNKNOWN;
139    /**
140     * @var int
141     * @cvalue UCAL_MONDAY
142     */
143    public const DOW_MONDAY = UNKNOWN;
144    /**
145     * @var int
146     * @cvalue UCAL_TUESDAY
147     */
148    public const DOW_TUESDAY = UNKNOWN;
149    /**
150     * @var int
151     * @cvalue UCAL_WEDNESDAY
152     */
153    public const DOW_WEDNESDAY = UNKNOWN;
154    /**
155     * @var int
156     * @cvalue UCAL_THURSDAY
157     */
158    public const DOW_THURSDAY = UNKNOWN;
159    /**
160     * @var int
161     * @cvalue UCAL_FRIDAY
162     */
163    public const DOW_FRIDAY = UNKNOWN;
164    /**
165     * @var int
166     * @cvalue UCAL_SATURDAY
167     */
168    public const DOW_SATURDAY = UNKNOWN;
169
170    /**
171     * @var int
172     * @cvalue UCAL_WEEKDAY
173     */
174    public const DOW_TYPE_WEEKDAY = UNKNOWN;
175    /**
176     * @var int
177     * @cvalue UCAL_WEEKEND
178     */
179    public const DOW_TYPE_WEEKEND = UNKNOWN;
180    /**
181     * @var int
182     * @cvalue UCAL_WEEKEND_ONSET
183     */
184    public const DOW_TYPE_WEEKEND_OFFSET = UNKNOWN;
185    /**
186     * @var int
187     * @cvalue UCAL_WEEKEND_CEASE
188     */
189    public const DOW_TYPE_WEEKEND_CEASE = UNKNOWN;
190
191    /**
192     * @var int
193     * @cvalue UCAL_WALLTIME_FIRST
194     */
195    public const WALLTIME_FIRST = UNKNOWN;
196    /**
197     * @var int
198     * @cvalue UCAL_WALLTIME_LAST
199     */
200    public const WALLTIME_LAST = UNKNOWN;
201    /**
202     * @var int
203     * @cvalue UCAL_WALLTIME_NEXT_VALID
204     */
205    public const WALLTIME_NEXT_VALID = UNKNOWN;
206
207    private function __construct() {}
208
209    /**
210     * @param IntlTimeZone|DateTimeZone|string|null $timezone
211     * @tentative-return-type
212     * @alias intlcal_create_instance
213     */
214    public static function createInstance($timezone = null, ?string $locale = null): ?IntlCalendar {}
215
216    /**
217     * @tentative-return-type
218     * @alias intlcal_equals
219     */
220    public function equals(IntlCalendar $other): bool {}
221
222    /**
223     * @tentative-return-type
224     * @alias intlcal_field_difference
225     */
226    public function fieldDifference(float $timestamp, int $field): int|false {}
227
228    /**
229     * @tentative-return-type
230     * @alias intlcal_add
231     */
232    public function add(int $field, int $value): bool {}
233
234    /**
235     * @tentative-return-type
236     * @alias intlcal_after
237     */
238    public function after(IntlCalendar $other): bool {}
239
240    /**
241     * @tentative-return-type
242     * @alias intlcal_before
243     */
244    public function before(IntlCalendar $other): bool {}
245
246    /**
247     * @return bool
248     * @alias intlcal_clear
249     */
250    public function clear(?int $field = null) {} // TODO make return type void
251
252    /**
253     * @tentative-return-type
254     * @alias intlcal_from_date_time
255     */
256    public static function fromDateTime(DateTime|string $datetime, ?string $locale = null): ?IntlCalendar {}
257
258    /**
259     * @tentative-return-type
260     * @alias intlcal_get
261     */
262    public function get(int $field): int|false {}
263
264    /**
265     * @tentative-return-type
266     * @alias intlcal_get_actual_maximum
267     */
268    public function getActualMaximum(int $field): int|false {}
269
270    /**
271     * @tentative-return-type
272     * @alias intlcal_get_actual_minimum
273     */
274    public function getActualMinimum(int $field): int|false {}
275
276    /**
277     * @return array<int, string>
278     * @tentative-return-type
279     * @alias intlcal_get_available_locales
280     */
281    public static function getAvailableLocales(): array {}
282
283    /**
284     * @tentative-return-type
285     * @alias intlcal_get_day_of_week_type
286     */
287    public function getDayOfWeekType(int $dayOfWeek): int|false {}
288
289    /**
290     * @tentative-return-type
291     * @alias intlcal_get_error_code
292     */
293    public function getErrorCode(): int|false {}
294
295    /**
296     * @tentative-return-type
297     * @alias intlcal_get_error_message
298     */
299    public function getErrorMessage(): string|false {}
300
301    /**
302     * @tentative-return-type
303     * @alias intlcal_get_first_day_of_week
304     */
305    public function getFirstDayOfWeek(): int|false {}
306
307    /**
308     * @tentative-return-type
309     * @alias intlcal_get_greatest_minimum
310     */
311    public function getGreatestMinimum(int $field): int|false {}
312
313    /**
314     * @tentative-return-type
315     * @alias intlcal_get_keyword_values_for_locale
316     */
317    public static function getKeywordValuesForLocale(string $keyword, string $locale, bool $onlyCommon): IntlIterator|false {}
318
319    /**
320     * @tentative-return-type
321     * @alias intlcal_get_least_maximum
322     */
323    public function getLeastMaximum(int $field): int|false {}
324
325    /**
326     * @tentative-return-type
327     * @alias intlcal_get_locale
328     */
329    public function getLocale(int $type): string|false {}
330
331    /**
332     * @tentative-return-type
333     * @alias intlcal_get_maximum
334     */
335    public function getMaximum(int $field): int|false {}
336
337    /**
338     * @tentative-return-type
339     * @alias intlcal_get_minimal_days_in_first_week
340     */
341    public function getMinimalDaysInFirstWeek(): int|false {}
342
343    /**
344     * @return bool
345     * @alias intlcal_set_minimal_days_in_first_week
346     */
347    public function setMinimalDaysInFirstWeek(int $days) {} // TODO make return void
348
349    /**
350     * @tentative-return-type
351     * @alias intlcal_get_minimum
352     */
353    public function getMinimum(int $field): int|false {}
354
355    /**
356     * @tentative-return-type
357     * @alias intlcal_get_now
358     */
359    public static function getNow(): float {}
360
361    /**
362     * @tentative-return-type
363     * @alias intlcal_get_repeated_wall_time_option
364     */
365    public function getRepeatedWallTimeOption(): int {}
366
367    /**
368     * @tentative-return-type
369     * @alias intlcal_get_skipped_wall_time_option
370     */
371    public function getSkippedWallTimeOption(): int {}
372
373    /**
374     * @tentative-return-type
375     * @alias intlcal_get_time
376     */
377    public function getTime(): float|false {}
378
379    /**
380     * @tentative-return-type
381     * @alias intlcal_get_time_zone
382     */
383    public function getTimeZone(): IntlTimeZone|false {}
384
385    /**
386     * @tentative-return-type
387     * @alias intlcal_get_type
388     */
389    public function getType(): string {}
390
391    /**
392     * @tentative-return-type
393     * @alias intlcal_get_weekend_transition
394     */
395    public function getWeekendTransition(int $dayOfWeek): int|false {}
396
397    /**
398     * @tentative-return-type
399     * @alias intlcal_in_daylight_time
400     */
401    public function inDaylightTime(): bool {}
402
403    /**
404     * @tentative-return-type
405     * @alias intlcal_is_equivalent_to
406     */
407    public function isEquivalentTo(IntlCalendar $other): bool {}
408
409    /**
410     * @tentative-return-type
411     * @alias intlcal_is_lenient
412     */
413    public function isLenient(): bool {}
414
415    /**
416     * @tentative-return-type
417     * @alias intlcal_is_weekend
418     */
419    public function isWeekend(?float $timestamp = null): bool {}
420
421    /**
422     * @param int|bool $value
423     * @alias intlcal_roll
424     * @tentative-return-type
425     */
426    public function roll(int $field, $value): bool {}
427
428    /**
429     * @tentative-return-type
430     * @alias intlcal_is_set
431     */
432    public function isSet(int $field): bool {}
433
434    /**
435     * @return bool
436     * @alias intlcal_set
437     */
438    public function set(int $year, int $month, int $dayOfMonth = UNKNOWN, int $hour = UNKNOWN, int $minute = UNKNOWN, int $second = UNKNOWN) {} // TODO make return type void
439
440    /**
441     * @return bool
442     * @alias intlcal_set_first_day_of_week
443     */
444    public function setFirstDayOfWeek(int $dayOfWeek) {} // TODO make return type void
445
446    /**
447     * @return bool
448     * @alias intlcal_set_lenient
449     */
450    public function setLenient(bool $lenient) {} // TODO make return type void
451
452    /**
453     * @return bool
454     * @alias intlcal_set_repeated_wall_time_option
455     */
456    public function setRepeatedWallTimeOption(int $option) {} // TODO make return type void
457
458    /**
459     * @return bool
460     * @alias intlcal_set_skipped_wall_time_option
461     */
462    public function setSkippedWallTimeOption(int $option) {} // TODO make return type void
463
464    /**
465     * @tentative-return-type
466     * @alias intlcal_set_time
467     */
468    public function setTime(float $timestamp): bool {}
469
470    /**
471     * @param IntlTimeZone|DateTimeZone|string|null $timezone
472     * @tentative-return-type
473     * @alias intlcal_set_time_zone
474     */
475    public function setTimeZone($timezone): bool {}
476
477    /**
478     * @tentative-return-type
479     * @alias intlcal_to_date_time
480     */
481    public function toDateTime(): DateTime|false {}
482}
483
484/** @not-serializable */
485class IntlGregorianCalendar extends IntlCalendar
486{
487    /**
488     * @param DateTimeZone|IntlTimeZone|string|int|null $timezoneOrYear
489     * @param string|int|null $localeOrMonth
490     * @param int $day
491     * @param int $hour
492     * @param int $minute
493     * @param int $second
494     */
495    public function __construct($timezoneOrYear = UNKNOWN, $localeOrMonth = UNKNOWN, $day = UNKNOWN, $hour = UNKNOWN, $minute = UNKNOWN, $second = UNKNOWN) {}
496
497    /**
498     * @tentative-return-type
499     * @alias intlgregcal_set_gregorian_change
500     */
501    public function setGregorianChange(float $timestamp): bool {}
502
503    /**
504     * @tentative-return-type
505     * @alias intlgregcal_get_gregorian_change
506     */
507    public function getGregorianChange(): float {}
508
509    /**
510     * @tentative-return-type
511     * @alias intlgregcal_is_leap_year
512     */
513    public function isLeapYear(int $year): bool {}
514}
515