xref: /php-src/ext/intl/timezone/timezone.stub.php (revision 22a3866f)
1<?php
2
3/** @generate-class-entries */
4
5/** @not-serializable */
6class IntlTimeZone
7{
8    /** @cvalue TimeZone::SHORT */
9    public const int DISPLAY_SHORT = UNKNOWN;
10    /** @cvalue TimeZone::LONG */
11    public const int DISPLAY_LONG = UNKNOWN;
12
13    /** @cvalue TimeZone::SHORT_GENERIC */
14    public const int DISPLAY_SHORT_GENERIC = UNKNOWN;
15    /** @cvalue TimeZone::LONG_GENERIC */
16    public const int DISPLAY_LONG_GENERIC = UNKNOWN;
17    /** @cvalue TimeZone::SHORT_GMT */
18    public const int DISPLAY_SHORT_GMT = UNKNOWN;
19    /** @cvalue TimeZone::LONG_GMT */
20    public const int DISPLAY_LONG_GMT = UNKNOWN;
21    /** @cvalue TimeZone::SHORT_COMMONLY_USED */
22    public const int DISPLAY_SHORT_COMMONLY_USED = UNKNOWN;
23    /** @cvalue TimeZone::GENERIC_LOCATION */
24    public const int DISPLAY_GENERIC_LOCATION = UNKNOWN;
25
26    /** @cvalue UCAL_ZONE_TYPE_ANY */
27    public const int TYPE_ANY = UNKNOWN;
28    /** @cvalue UCAL_ZONE_TYPE_CANONICAL */
29    public const int TYPE_CANONICAL = UNKNOWN;
30    /** @cvalue UCAL_ZONE_TYPE_CANONICAL_LOCATION */
31    public const int TYPE_CANONICAL_LOCATION = UNKNOWN;
32
33    private function __construct() {}
34
35    /**
36     * @tentative-return-type
37     * @alias intltz_count_equivalent_ids
38     */
39    public static function countEquivalentIDs(string $timezoneId): int|false {}
40
41    /**
42     * @tentative-return-type
43     * @alias intltz_create_default
44     */
45    public static function createDefault(): IntlTimeZone {}
46
47    /**
48     * @param IntlTimeZone|string|int|float|null $countryOrRawOffset
49     * @tentative-return-type
50     * @alias intltz_create_enumeration
51     */
52    public static function createEnumeration($countryOrRawOffset = null): IntlIterator|false {}
53
54    /**
55     * @tentative-return-type
56     * @alias intltz_create_time_zone
57     */
58    public static function createTimeZone(string $timezoneId): ?IntlTimeZone {}
59
60    /**
61     * @tentative-return-type
62     * @alias intltz_create_time_zone_id_enumeration
63     */
64    public static function createTimeZoneIDEnumeration(int $type, ?string $region = null, ?int $rawOffset = null): IntlIterator|false {}
65
66    /**
67     * @tentative-return-type
68     * @alias intltz_from_date_time_zone
69     */
70    public static function fromDateTimeZone(DateTimeZone $timezone): ?IntlTimeZone {}
71
72    /**
73     * @param bool $isSystemId
74     * @tentative-return-type
75     * @alias intltz_get_canonical_id
76     */
77    public static function getCanonicalID(string $timezoneId, &$isSystemId = null): string|false {}
78
79    /**
80     * @tentative-return-type
81     * @alias intltz_get_display_name
82     */
83    public function getDisplayName(bool $dst = false, int $style = IntlTimeZone::DISPLAY_LONG, ?string $locale = null): string|false {}
84
85    /**
86     * @tentative-return-type
87     * @alias intltz_get_dst_savings
88     */
89    public function getDSTSavings(): int {}
90
91    /**
92     * @tentative-return-type
93     * @alias intltz_get_equivalent_id
94     */
95    public static function getEquivalentID(string $timezoneId, int $offset): string|false {}
96
97    /**
98     * @tentative-return-type
99     * @alias intltz_get_error_code
100     */
101    public function getErrorCode(): int|false {}
102
103    /**
104     * @tentative-return-type
105     * @alias intltz_get_error_message
106     */
107    public function getErrorMessage(): string|false {}
108
109    /**
110     * @tentative-return-type
111     * @alias intltz_get_gmt
112     */
113    public static function getGMT(): IntlTimeZone {}
114
115#if U_ICU_VERSION_MAJOR_NUM >= 74
116    /**
117     * @alias intltz_get_iana_id
118     */
119    public static function getIanaID(string $timezoneId): string|false {}
120#endif
121
122    /**
123     * @tentative-return-type
124     * @alias intltz_get_id
125     */
126    public function getID(): string|false {}
127
128    /**
129     * @param int $rawOffset
130     * @param int $dstOffset
131     * @tentative-return-type
132     * @alias intltz_get_offset
133     */
134    public function getOffset(float $timestamp, bool $local, &$rawOffset, &$dstOffset): bool {}
135
136    /**
137     * @tentative-return-type
138     * @alias intltz_get_raw_offset
139     */
140    public function getRawOffset(): int {}
141
142    /**
143     * @tentative-return-type
144     * @alias intltz_get_region
145     */
146    public static function getRegion(string $timezoneId): string|false {}
147
148    /**
149     * @tentative-return-type
150     * @alias intltz_get_tz_data_version
151     */
152    public static function getTZDataVersion(): string|false {}
153
154    /**
155     * @tentative-return-type
156     * @alias intltz_get_unknown
157     */
158    public static function getUnknown(): IntlTimeZone {}
159
160#if U_ICU_VERSION_MAJOR_NUM >= 52
161    /**
162     * @tentative-return-type
163     * @alias intltz_get_windows_id
164     */
165    public static function getWindowsID(string $timezoneId): string|false {}
166
167    /**
168     * @tentative-return-type
169     * @alias intltz_get_id_for_windows_id
170     */
171    public static function getIDForWindowsID(string $timezoneId, ?string $region = null): string|false {}
172#endif
173    /**
174     * @tentative-return-type
175     * @alias intltz_has_same_rules
176     */
177    public function hasSameRules(IntlTimeZone $other): bool {}
178
179    /**
180     * @tentative-return-type
181     * @alias intltz_to_date_time_zone
182     */
183    public function toDateTimeZone(): DateTimeZone|false {}
184
185    /**
186     * @tentative-return-type
187     * @alias intltz_use_daylight_time
188     */
189    public function useDaylightTime(): bool {}
190}
191