-
Notifications
You must be signed in to change notification settings - Fork 426
/
iterable.stub
254 lines (213 loc) · 4.3 KB
/
iterable.stub
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
<?php
/**
* @template-covariant TKey
* @template-covariant TValue
*/
interface Traversable
{
}
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @extends Traversable<TKey, TValue>
*/
interface IteratorAggregate extends Traversable
{
/**
* @return Traversable<TKey, TValue>
*/
public function getIterator();
}
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @extends Traversable<TKey, TValue>
*/
interface Iterator extends Traversable
{
/**
* @return TValue
*/
public function current();
/**
* @return TKey
*/
public function key();
}
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @extends Iterator<TKey, TValue>
*/
interface RecursiveIterator extends Iterator
{
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template TSend
* @template-covariant TReturn
*
* @implements Iterator<TKey, TValue>
*/
class Generator implements Iterator
{
/**
* @return TReturn
*/
public function getReturn() {}
/**
* @param TSend $value
* @return TValue
*/
public function send($value) {}
}
/**
* @implements Traversable<string, static>
* @implements ArrayAccess<int|string, static>
* @implements Iterator<string, static>
* @implements RecursiveIterator<string, static>
*/
class SimpleXMLElement implements Traversable, ArrayAccess, Iterator, RecursiveIterator
{
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @extends Iterator<TKey, TValue>
*/
interface SeekableIterator extends Iterator
{
}
/**
* @template TKey of array-key
* @template TValue
* @implements SeekableIterator<TKey, TValue>
* @implements ArrayAccess<TKey, TValue>
*/
class ArrayIterator implements SeekableIterator, ArrayAccess, Countable
{
/**
* @param array<TKey, TValue> $array
* @param int $flags
*/
public function __construct($array = array(), $flags = 0) { }
/**
* @param TValue $value
* @return void
*/
public function append($value) { }
/**
* @return array<TKey, TValue>
*/
public function getArrayCopy() { }
/**
* @param callable(TValue, TValue): int $cmp_function
* @return void
*/
public function uasort($cmp_function) { }
/**
* @param callable(TKey, TKey): int $cmp_function
* @return void
*/
public function uksort($cmp_function) { }
}
/**
* @template T of \RecursiveIterator|\IteratorAggregate
* @mixin T
*/
class RecursiveIteratorIterator
{
/**
* @param T $iterator
* @param int $mode
* @param int $flags
*/
public function __construct(
$iterator,
$mode = RecursiveIteratorIterator::LEAVES_ONLY,
int $flags = 0
)
{
}
}
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @template-extends Iterator<TKey, TValue>
*/
interface OuterIterator extends Iterator {
/**
* @return Iterator<TKey, TValue>
*/
public function getInnerIterator();
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template TIterator as Traversable<TKey, TValue>
*
* @template-implements OuterIterator<TKey, TValue>
*
* @mixin TIterator
*/
class IteratorIterator implements OuterIterator {
/**
* @param TIterator $iterator
*/
public function __construct(Traversable $iterator) {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template TIterator as Traversable<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class FilterIterator extends IteratorIterator
{
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template TIterator as Traversable<TKey, TValue>
*
* @extends FilterIterator<TKey, TValue, TIterator>
*/
class CallbackFilterIterator extends FilterIterator
{
}
/**
* @template TKey of array-key
* @template TValue
*
* @template-implements RecursiveIterator<TKey, TValue>
* @template-extends ArrayIterator<TKey, TValue>
*/
class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
/**
* @return RecursiveArrayIterator<TKey, TValue>
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
/**
* @return TValue
*/
public function current() {}
/**
* @return TKey
*/
public function key() {}
/**
* @param callable(TKey, TKey): int $cmp_function
* @return void
*/
public function uksort($cmp_function) { }
}