1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
<?php
/** @generate-class-entries */
class EmptyIterator implements Iterator
{
/** @tentative-return-type */
public function current(): never {}
/** @tentative-return-type */
public function next(): void {}
/** @tentative-return-type */
public function key(): never {}
/** @tentative-return-type */
public function valid(): false {}
/** @tentative-return-type */
public function rewind(): void {}
}
class CallbackFilterIterator extends FilterIterator
{
public function __construct(Iterator $iterator, callable $callback) {}
/** @tentative-return-type */
public function accept(): bool {}
}
class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator
{
public function __construct(RecursiveIterator $iterator, callable $callback) {}
/**
* @tentative-return-type
* @implementation-alias RecursiveFilterIterator::hasChildren
*/
public function hasChildren(): bool {}
/** @tentative-return-type */
public function getChildren(): RecursiveCallbackFilterIterator {}
}
interface RecursiveIterator extends Iterator
{
/** @tentative-return-type */
public function hasChildren(): bool;
/** @tentative-return-type */
public function getChildren(): ?RecursiveIterator;
}
class RecursiveIteratorIterator implements OuterIterator
{
/** @cvalue RIT_LEAVES_ONLY */
public const int LEAVES_ONLY = UNKNOWN;
/** @cvalue RIT_SELF_FIRST */
public const int SELF_FIRST = UNKNOWN;
/** @cvalue RIT_CHILD_FIRST */
public const int CHILD_FIRST = UNKNOWN;
/** @cvalue RIT_CATCH_GET_CHILD */
public const int CATCH_GET_CHILD = UNKNOWN;
public function __construct(Traversable $iterator, int $mode = RecursiveIteratorIterator::LEAVES_ONLY, int $flags = 0) {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function key(): mixed {}
/** @tentative-return-type */
public function current(): mixed {}
/** @tentative-return-type */
public function next(): void {}
/** @tentative-return-type */
public function getDepth(): int {}
/** @tentative-return-type */
public function getSubIterator(?int $level = null): ?RecursiveIterator {}
/** @tentative-return-type */
public function getInnerIterator(): RecursiveIterator {}
/** @tentative-return-type */
public function beginIteration(): void {}
/** @tentative-return-type */
public function endIteration(): void {}
/** @tentative-return-type */
public function callHasChildren(): bool {}
/** @tentative-return-type */
public function callGetChildren(): ?RecursiveIterator {}
/** @tentative-return-type */
public function beginChildren(): void {}
/** @tentative-return-type */
public function endChildren(): void {}
/** @tentative-return-type */
public function nextElement(): void {}
/** @tentative-return-type */
public function setMaxDepth(int $maxDepth = -1): void {}
/** @tentative-return-type */
public function getMaxDepth(): int|false {}
}
interface OuterIterator extends Iterator
{
/** @tentative-return-type */
public function getInnerIterator(): ?Iterator;
}
class IteratorIterator implements OuterIterator
{
public function __construct(Traversable $iterator, ?string $class = null) {}
/** @tentative-return-type */
public function getInnerIterator(): ?Iterator {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function key(): mixed {}
/** @tentative-return-type */
public function current(): mixed {}
/** @tentative-return-type */
public function next(): void {}
}
abstract class FilterIterator extends IteratorIterator
{
/** @tentative-return-type */
abstract public function accept(): bool;
public function __construct(Iterator $iterator) {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function next(): void {}
}
abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator
{
public function __construct(RecursiveIterator $iterator) {}
/** @tentative-return-type */
public function hasChildren(): bool {}
/** @tentative-return-type */
public function getChildren(): ?RecursiveFilterIterator {}
}
class ParentIterator extends RecursiveFilterIterator
{
public function __construct(RecursiveIterator $iterator) {}
/**
* @tentative-return-type
* @implementation-alias RecursiveFilterIterator::hasChildren
*/
public function accept(): bool {}
}
interface SeekableIterator extends Iterator
{
/** @tentative-return-type */
public function seek(int $offset): void;
}
class LimitIterator extends IteratorIterator
{
public function __construct(Iterator $iterator, int $offset = 0, int $limit = -1) {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function next(): void {}
/** @tentative-return-type */
public function seek(int $offset): int {}
/** @tentative-return-type */
public function getPosition(): int {}
}
class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable
{
/** @cvalue CIT_CALL_TOSTRING */
public const int CALL_TOSTRING = UNKNOWN;
/** @cvalue CIT_CATCH_GET_CHILD */
public const int CATCH_GET_CHILD = UNKNOWN;
/** @cvalue CIT_TOSTRING_USE_KEY */
public const int TOSTRING_USE_KEY = UNKNOWN;
/** @cvalue CIT_TOSTRING_USE_CURRENT */
public const int TOSTRING_USE_CURRENT = UNKNOWN;
/** @cvalue CIT_TOSTRING_USE_INNER */
public const int TOSTRING_USE_INNER = UNKNOWN;
/** @cvalue CIT_FULL_CACHE */
public const int FULL_CACHE = UNKNOWN;
public function __construct(Iterator $iterator, int $flags = CachingIterator::CALL_TOSTRING) {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function next(): void {}
/** @tentative-return-type */
public function hasNext(): bool {}
public function __toString(): string {}
/** @tentative-return-type */
public function getFlags(): int {}
/** @tentative-return-type */
public function setFlags(int $flags): void {}
/**
* @param string $key
* @tentative-return-type
*/
public function offsetGet($key): mixed {}
/**
* @param string $key
* @tentative-return-type
*/
public function offsetSet($key, mixed $value): void {}
/**
* @param string $key
* @tentative-return-type
*/
public function offsetUnset($key): void {}
/**
* @param string $key
* @tentative-return-type
*/
public function offsetExists($key): bool {}
/** @tentative-return-type */
public function getCache(): array {}
/** @tentative-return-type */
public function count(): int {}
}
class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator
{
public function __construct(Iterator $iterator, int $flags = RecursiveCachingIterator::CALL_TOSTRING) {}
/** @tentative-return-type */
public function hasChildren(): bool {}
/** @tentative-return-type */
public function getChildren(): ?RecursiveCachingIterator {}
}
class NoRewindIterator extends IteratorIterator
{
public function __construct(Iterator $iterator) {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function key(): mixed {}
/** @tentative-return-type */
public function current(): mixed {}
/** @tentative-return-type */
public function next(): void {}
}
class AppendIterator extends IteratorIterator
{
public function __construct() {}
/** @tentative-return-type */
public function append(Iterator $iterator): void {}
/** @tentative-return-type */
public function rewind(): void {}
/** @tentative-return-type */
public function valid(): bool {}
/** @tentative-return-type */
public function current(): mixed {}
/** @tentative-return-type */
public function next(): void {}
/** @tentative-return-type */
public function getIteratorIndex(): ?int {}
/** @tentative-return-type */
public function getArrayIterator(): ArrayIterator {}
}
class InfiniteIterator extends IteratorIterator
{
public function __construct(Iterator $iterator) {}
/** @tentative-return-type */
public function next(): void {}
}
class RegexIterator extends FilterIterator
{
/** @cvalue REGIT_USE_KEY */
public const int USE_KEY = UNKNOWN;
/** @cvalue REGIT_INVERTED */
public const int INVERT_MATCH = UNKNOWN;
/** @cvalue REGIT_MODE_MATCH */
public const int MATCH = UNKNOWN;
/** @cvalue REGIT_MODE_GET_MATCH */
public const int GET_MATCH = UNKNOWN;
/** @cvalue REGIT_MODE_ALL_MATCHES */
public const int ALL_MATCHES = UNKNOWN;
/** @cvalue REGIT_MODE_SPLIT */
public const int SPLIT = UNKNOWN;
/** @cvalue REGIT_MODE_REPLACE */
public const int REPLACE = UNKNOWN;
public ?string $replacement = null;
public function __construct(Iterator $iterator, string $pattern, int $mode = RegexIterator::MATCH, int $flags = 0, int $pregFlags = 0) {}
/** @tentative-return-type */
public function accept(): bool {}
/** @tentative-return-type */
public function getMode(): int {}
/** @tentative-return-type */
public function setMode(int $mode): void {}
/** @tentative-return-type */
public function getFlags(): int {}
/** @tentative-return-type */
public function setFlags(int $flags): void {}
/** @tentative-return-type */
public function getRegex(): string {}
/** @tentative-return-type */
public function getPregFlags(): int {}
/** @tentative-return-type */
public function setPregFlags(int $pregFlags): void {}
}
class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator
{
public function __construct(RecursiveIterator $iterator, string $pattern, int $mode = RecursiveRegexIterator::MATCH, int $flags = 0, int $pregFlags = 0) {}
/** @tentative-return-type */
public function accept(): bool {}
/**
* @tentative-return-type
* @implementation-alias RecursiveFilterIterator::hasChildren
*/
public function hasChildren(): bool {}
/** @tentative-return-type */
public function getChildren(): RecursiveRegexIterator {}
}
class RecursiveTreeIterator extends RecursiveIteratorIterator
{
/** @cvalue RTIT_BYPASS_CURRENT */
public const int BYPASS_CURRENT = UNKNOWN;
/** @cvalue RTIT_BYPASS_KEY */
public const int BYPASS_KEY = UNKNOWN;
public const int PREFIX_LEFT = 0;
public const int PREFIX_MID_HAS_NEXT = 1;
public const int PREFIX_MID_LAST = 2;
public const int PREFIX_END_HAS_NEXT = 3;
public const int PREFIX_END_LAST = 4;
public const int PREFIX_RIGHT = 5;
/** @param RecursiveIterator|IteratorAggregate $iterator */
public function __construct(
$iterator,
int $flags = RecursiveTreeIterator::BYPASS_KEY,
int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
int $mode = RecursiveTreeIterator::SELF_FIRST
) {}
/** @tentative-return-type */
public function key(): mixed {}
/** @tentative-return-type */
public function current(): mixed {}
/** @tentative-return-type */
public function getPrefix(): string {}
/** @tentative-return-type */
public function setPostfix(string $postfix): void {}
/** @tentative-return-type */
public function setPrefixPart(int $part, string $value): void {}
/** @tentative-return-type */
public function getEntry(): string {}
/** @tentative-return-type */
public function getPostfix(): string {}
}
|
