xref: /PHP-8.3/ext/intl/collator/collator.stub.php (revision 150456ea) 
1<?php
2
3/** @generate-class-entries */
4
5/**
6 * @var int
7 * @cvalue ULOC_ACTUAL_LOCALE
8 */
9const ULOC_ACTUAL_LOCALE = UNKNOWN;
10/**
11 * @var int
12 * @cvalue ULOC_VALID_LOCALE
13 */
14const ULOC_VALID_LOCALE = UNKNOWN;
15
16/** @not-serializable */
17class Collator
18{
19    /**
20     * @var int
21     * @cvalue UCOL_DEFAULT
22     */
23    const DEFAULT_VALUE = UNKNOWN;
24
25    /**
26     * @var int
27     * @cvalue UCOL_PRIMARY
28     */
29    const PRIMARY = UNKNOWN;
30    /**
31     * @var int
32     * @cvalue UCOL_SECONDARY
33     */
34    const SECONDARY = UNKNOWN;
35    /**
36     * @var int
37     * @cvalue UCOL_TERTIARY
38     */
39    const TERTIARY = UNKNOWN;
40    /**
41     * @var int
42     * @cvalue UCOL_DEFAULT_STRENGTH
43     */
44    const DEFAULT_STRENGTH = UNKNOWN;
45    /**
46     * @var int
47     * @cvalue UCOL_QUATERNARY
48     */
49    const QUATERNARY = UNKNOWN;
50    /**
51     * @var int
52     * @cvalue UCOL_IDENTICAL
53     */
54    const IDENTICAL = UNKNOWN;
55
56    /**
57     * @var int
58     * @cvalue UCOL_OFF
59     */
60    const OFF = UNKNOWN;
61    /**
62     * @var int
63     * @cvalue UCOL_ON
64     */
65    const ON = UNKNOWN;
66
67    /**
68     * @var int
69     * @cvalue UCOL_SHIFTED
70     */
71    const SHIFTED = UNKNOWN;
72    /**
73     * @var int
74     * @cvalue UCOL_NON_IGNORABLE
75     */
76    const NON_IGNORABLE = UNKNOWN;
77
78    /**
79     * @var int
80     * @cvalue UCOL_LOWER_FIRST
81     */
82    const LOWER_FIRST = UNKNOWN;
83    /**
84     * @var int
85     * @cvalue UCOL_UPPER_FIRST
86     */
87    const UPPER_FIRST = UNKNOWN;
88
89    /* UColAttribute constants */
90
91    /**
92     * @var int
93     * @cvalue UCOL_FRENCH_COLLATION
94     */
95    const FRENCH_COLLATION = UNKNOWN;
96    /**
97     * @var int
98     * @cvalue UCOL_ALTERNATE_HANDLING
99     */
100    const ALTERNATE_HANDLING = UNKNOWN;
101    /**
102     * @var int
103     * @cvalue UCOL_CASE_FIRST
104     */
105    const CASE_FIRST = UNKNOWN;
106    /**
107     * @var int
108     * @cvalue UCOL_CASE_LEVEL
109     */
110    const CASE_LEVEL = UNKNOWN;
111    /**
112     * @var int
113     * @cvalue UCOL_NORMALIZATION_MODE
114     */
115    const NORMALIZATION_MODE = UNKNOWN;
116    /**
117     * @var int
118     * @cvalue UCOL_STRENGTH
119     */
120    const STRENGTH = UNKNOWN;
121    /**
122     * @var int
123     * @cvalue UCOL_HIRAGANA_QUATERNARY_MODE
124     */
125    const HIRAGANA_QUATERNARY_MODE = UNKNOWN;
126    /**
127     * @var int
128     * @cvalue UCOL_NUMERIC_COLLATION
129     */
130    const NUMERIC_COLLATION = UNKNOWN;
131
132    /* sort flags */
133
134    /**
135     * @var int
136     * @cvalue COLLATOR_SORT_REGULAR
137     */
138    const SORT_REGULAR = UNKNOWN;
139    /**
140     * @var int
141     * @cvalue COLLATOR_SORT_STRING
142     */
143    const SORT_STRING = UNKNOWN;
144    /**
145     * @var int
146     * @cvalue COLLATOR_SORT_NUMERIC
147     */
148    const SORT_NUMERIC = UNKNOWN;
149
150    public function __construct(string $locale) {}
151
152    /**
153     * @tentative-return-type
154     * @alias collator_create
155     */
156    public static function create(string $locale): ?Collator {}
157
158    /**
159     * @tentative-return-type
160     * @alias collator_compare
161     */
162    public function compare(string $string1, string $string2): int|false {}
163
164    /**
165     * @tentative-return-type
166     * @alias collator_sort
167     */
168    public function sort(array &$array, int $flags = Collator::SORT_REGULAR): bool {}
169
170    /**
171     * @tentative-return-type
172     * @alias collator_sort_with_sort_keys
173     */
174    public function sortWithSortKeys(array &$array): bool {}
175
176    /**
177     * @tentative-return-type
178     * @alias collator_asort
179     */
180    public function asort(array &$array, int $flags = Collator::SORT_REGULAR): bool {}
181
182    /**
183     * @tentative-return-type
184     * @alias collator_get_attribute
185     */
186    public function getAttribute(int $attribute): int|false {}
187
188    /**
189     * @tentative-return-type
190     * @alias collator_set_attribute
191     */
192    public function setAttribute(int $attribute, int $value): bool {}
193
194    /**
195     * @tentative-return-type
196     * @alias collator_get_strength
197     */
198    public function getStrength(): int {}
199
200    /**
201     * @return bool
202     * @alias collator_set_strength
203     */
204    public function setStrength(int $strength) {} // TODO make return type void
205
206    /**
207     * @tentative-return-type
208     * @alias collator_get_locale
209     */
210    public function getLocale(int $type): string|false {}
211
212    /**
213     * @tentative-return-type
214     * @alias collator_get_error_code
215     */
216    public function getErrorCode(): int|false {}
217
218    /**
219     * @tentative-return-type
220     * @alias collator_get_error_message
221     */
222    public function getErrorMessage(): string|false {}
223
224    /**
225     * @tentative-return-type
226     * @alias collator_get_sort_key
227     */
228    public function getSortKey(string $string): string|false {}
229}
230