summaryrefslogtreecommitdiff
path: root/ext/spl/spl_iterators.stub.php
blob: 2038fd649955125d853cf1851bcb5c53e025e637 (plain)
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
<?php

/** @generate-class-entries */

class EmptyIterator implements Iterator
{
    /** @return void */
    public function current() {}

    /** @return void */
    public function next() {}

    /** @return void */
    public function key() {}

    /** @return bool */
    public function valid() {}

    /** @return void */
    public function rewind() {}
}

class CallbackFilterIterator extends FilterIterator
{
    public function __construct(Iterator $iterator, callable $callback) {}

    /** @return bool */
    public function accept() {}
}

class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator
{
    public function __construct(RecursiveIterator $iterator, callable $callback) {}

    /**
     * @return bool
     * @implementation-alias RecursiveFilterIterator::hasChildren
     */
    public function hasChildren() {}

    /** @return RecursiveCallbackFilterIterator */
    public function getChildren() {}
}

interface RecursiveIterator extends Iterator
{
    /** @return bool */
    public function hasChildren();

    /** @return RecursiveIterator */
    public function getChildren();
}

class RecursiveIteratorIterator implements OuterIterator
{
    public function __construct(Traversable $iterator, int $mode = self::LEAVES_ONLY, int $flags = 0) {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return mixed */
    public function key() {}

    /** @return mixed */
    public function current() {}

    /** @return void */
    public function next() {}

    /** @return int */
    public function getDepth() {}

    /** @return RecursiveIterator|null */
    public function getSubIterator(?int $level = null) {}

    /** @return RecursiveIterator */
    public function getInnerIterator() {}

    /** @return void */
    public function beginIteration() {}

    /** @return void */
    public function endIteration() {}

    /** @return bool|null */
    public function callHasChildren() {}

    /** @return RecursiveIterator|null */
    public function callGetChildren() {}

    /** @return void */
    public function beginChildren() {}

    /** @return void */
    public function endChildren() {}

    /** @return void */
    public function nextElement() {}

    /** @return void */
    public function setMaxDepth(int $maxDepth = -1) {}

    /** @return int|false */
    public function getMaxDepth() {}
}

interface OuterIterator extends Iterator
{
    /** @return Iterator */
    public function getInnerIterator();
}

class IteratorIterator implements OuterIterator
{
    public function __construct(Traversable $iterator, ?string $class = null) {}

    /** @return Iterator|null */
    public function getInnerIterator() {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return mixed */
    public function key() {}

    /** @return mixed */
    public function current() {}

    /** @return void */
    public function next() {}
}

abstract class FilterIterator extends IteratorIterator
{
    /** @return bool */
    abstract public function accept();

    public function __construct(Iterator $iterator) {}

    /** @return void */
    public function rewind() {}

    /** @return void */
    public function next() {}
}

abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator
{
    public function __construct(RecursiveIterator $iterator) {}

    /** @return bool */
    public function hasChildren() {}

    /** @return RecursiveFilterIterator|null */
    public function getChildren() {}
}

class ParentIterator extends RecursiveFilterIterator
{
    public function __construct(RecursiveIterator $iterator) {}

    /**
     * @return bool
     * @implementation-alias RecursiveFilterIterator::hasChildren
     */
    public function accept() {}
}

interface SeekableIterator extends Iterator
{
    /** @return void */
    public function seek(int $offset);
}

class LimitIterator extends IteratorIterator
{
    public function __construct(Iterator $iterator, int $offset = 0, int $limit = -1) {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return void */
    public function next() {}

    /** @return int */
    public function seek(int $offset) {}

    /** @return int */
    public function getPosition() {}
}

class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable
{
    public function __construct(Iterator $iterator, int $flags = self::CALL_TOSTRING) {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return void */
    public function next() {}

    /** @return bool */
    public function hasNext() {}

    public function __toString(): string {}

    /** @return int */
    public function getFlags() {}

    /** @return void */
    public function setFlags(int $flags) {}

    /**
     * @param string $key
     * @return mixed
     */
    public function offsetGet($key) {}

    /**
     * @param string $key
     * @return void
     */
    public function offsetSet($key, mixed $value) {}

    /**
     * @param string $key
     * @return void
     */
    public function offsetUnset($key) {}

    /**
     * @param string $key
     * @return bool
     */
    public function offsetExists($key) {}

    /** @return array */
    public function getCache() {}

    /** @return int */
    public function count() {}
}

class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator
{
    public function __construct(Iterator $iterator, int $flags = self::CALL_TOSTRING) {}

    /** @return bool */
    public function hasChildren() {}

    /** @return RecursiveCachingIterator|null */
    public function getChildren() {}
}

class NoRewindIterator extends IteratorIterator
{
    public function __construct(Iterator $iterator) {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return mixed */
    public function key() {}

    /** @return mixed */
    public function current() {}

    /** @return void */
    public function next() {}
}

class AppendIterator extends IteratorIterator
{
    public function __construct() {}

    /** @return void */
    public function append(Iterator $iterator) {}

    /** @return void */
    public function rewind() {}

    /** @return bool */
    public function valid() {}

    /** @return mixed */
    public function current() {}

    /** @return void */
    public function next() {}

    /** @return int */
    public function getIteratorIndex() {}

    /** @return ArrayIterator */
    public function getArrayIterator() {}
}

class InfiniteIterator extends IteratorIterator
{
    public function __construct(Iterator $iterator) {}

    /** @return void */
    public function next() {}
}

class RegexIterator extends FilterIterator
{
    /** @var string|null */
    public $replacement;

    public function __construct(Iterator $iterator, string $pattern, int $mode = self::MATCH, int $flags = 0, int $pregFlags = 0) {}

    /** @return bool */
    public function accept() {}

    /** @return int */
    public function getMode() {}

    /** @return void */
    public function setMode(int $mode) {}

    /** @return int */
    public function getFlags() {}

    /** @return void */
    public function setFlags(int $flags) {}

    /** @return string */
    public function getRegex() {}

    /** @return int */
    public function getPregFlags() {}

    /** @return void */
    public function setPregFlags(int $pregFlags) {}
}

class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator
{
    public function __construct(RecursiveIterator $iterator, string $pattern, int $mode = self::MATCH, int $flags = 0, int $pregFlags = 0) {}

    /** @return bool */
    public function accept() {}

    /**
     * @return bool
     * @implementation-alias RecursiveFilterIterator::hasChildren
     */
    public function hasChildren() {}

    /** @return RecursiveRegexIterator */
    public function getChildren() {}
}

class RecursiveTreeIterator extends RecursiveIteratorIterator
{
    /** @param RecursiveIterator|IteratorAggregate $iterator */
    public function __construct(
        $iterator,
        int $flags = self::BYPASS_KEY,
        int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
        int $mode = self::SELF_FIRST
    ) {}

    /** @return mixed */
    public function key() {}

    /** @return mixed */
    public function current() {}

    /** @return string */
    public function getPrefix() {}

    /** @return void */
    public function setPostfix(string $postfix) {}

    /** @return void */
    public function setPrefixPart(int $part, string $value) {}

    /** @return string */
    public function getEntry() {}

    /** @return string */
    public function getPostfix() {}
}