-
Notifications
You must be signed in to change notification settings - Fork 659
/
CoreGenericIterators.phpstub
1086 lines (954 loc) · 26.7 KB
/
CoreGenericIterators.phpstub
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @template-extends Traversable<TKey, TValue>
*/
interface IteratorAggregate extends Traversable {
/**
* @return Traversable<TKey, TValue> An instance of an object implementing Iterator or Traversable
*/
public function getIterator();
}
/**
* @template-covariant TKey
* @template-covariant TValue
*
* @template-extends Traversable<TKey, TValue>
*/
interface Iterator extends Traversable {
/**
* @return TValue|null returns current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current();
/**
* @return void Any returned value is ignored.
*/
public function next();
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key();
/**
* @return bool The return value will be casted to boolean and then evaluated.
* Returns true on success or false on failure.
*/
public function valid();
/**
* @return void Any returned value is ignored.
*/
public function rewind();
}
/**
* @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-extends Iterator<TKey, TValue>
*/
interface RecursiveIterator extends Iterator {
/**
* @return bool true if the current entry can be iterated over, otherwise returns false.
*/
public function hasChildren();
/**
* @return RecursiveIterator<TKey, TValue> An iterator for the current entry.
*/
public function getChildren();
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-extends Iterator<TKey, TValue>
*/
interface SeekableIterator extends Iterator {
/**
* Seeks to a position
* @link https://php.net/manual/en/seekableiterator.seek.php
*
* @param int $position The position to seek to.
* @return void
*
* @since 5.1.0
*/
public function seek($position);
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Traversable<TKey, TValue>
*
* @template-implements OuterIterator<TKey, TValue>
*
* @mixin TIterator
*/
class IteratorIterator implements OuterIterator {
/**
* @param TIterator $iterator
*/
public function __construct(Traversable $iterator, ?string $class = null) {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as Iterator<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class AppendIterator extends IteratorIterator {
public function __construct(){}
/**
* @param TIterator $iterator
* @return void
*/
public function append(Iterator $iterator) {}
/**
* @return ArrayIterator<TKey, TValue>
*/
public function getArrayIterator() {}
/**
* @return int
*/
public function getIteratorIndex() {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TKey as array-key
* @template TValue
* @template-implements SeekableIterator<TKey, TValue>
* @template-implements ArrayAccess<TKey, TValue>
*/
class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {
const STD_PROP_LIST = 1;
const ARRAY_AS_PROPS = 2;
/**
* @param array<TKey, TValue> $array The array or object to be iterated on.
* @param int-mask-of<static::*> $flags Flags to control the behaviour of the ArrayObject object.
*/
public function __construct($array = array(), $flags = 0) { }
/**
* @param TKey $index The offset being checked.
* @return bool true if the offset exists, otherwise false
*/
public function offsetExists($index) { }
/**
* @param TKey $index The offset to get the value from.
* @return TValue|null The value at offset index, null when accessing invalid indexes
* @psalm-ignore-nullable-return
*/
public function offsetGet($index) { }
/**
* @param TKey $index The index to set for.
* @param TValue $newval The new value to store at the index.
* @return void
*/
public function offsetSet($index, $newval) { }
/**
* @param TKey $index The offset to unset.
* @return void
*/
public function offsetUnset($index) { }
/**
* @param TValue $value The value to append.
* @return void
*/
public function append($value) { }
/**
* @return array<TKey, TValue> A copy of the array, or array of public properties
* if ArrayIterator refers to an object.
*/
public function getArrayCopy() { }
/**
* @return int The number of elements or public properties in the associated
* array or object, respectively.
*/
public function count() { }
/**
* @return int-mask-of<self::*> The current flags.
*/
public function getFlags() { }
/**
* @param int-mask-of<self::*> $flags bitmask
* @return void
*/
public function setFlags($flags) { }
/**
* @return void
*/
public function asort() { }
/**
* @return void
*/
public function ksort() { }
/**
* @param callable(TValue,TValue):int $cmp_function The compare function used for the sort.
* @return void
*/
public function uasort($cmp_function) { }
/**
* @param callable(TKey,TKey):int $cmp_function The compare function used for the sort.
* @return void
*/
public function uksort($cmp_function) { }
/**
* @return void
*/
public function natsort() { }
/**
* @return void
*/
public function natcasesort() { }
/**
* @param string $serialized The serialized ArrayIterator object to be unserialized.
* @return void
*/
public function unserialize($serialized) { }
/**
* @return string The serialized ArrayIterator
*/
public function serialize() { }
/**
* @return void
*/
public function rewind() { }
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() { }
/**
* @return TKey|null The current array key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() { }
/**
* @return void
*/
public function next() { }
/**
* @return bool
*/
public function valid() { }
/**
* @param int $position The position to seek to.
* @return void
*/
public function seek($position) { }
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Traversable<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
abstract class FilterIterator extends IteratorIterator {
/** @return bool */
abstract public function accept();
/**
* @return TValue Can return any type.
*/
public function current() {}
/**
* @return TKey scalar on success, or null on failure.
*/
public function key() {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Iterator<TKey, TValue>
*
* @template-implements OuterIterator<TKey, TValue>
* @template-implements ArrayAccess<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class CachingIterator extends IteratorIterator implements OuterIterator , ArrayAccess , Countable {
const CALL_TOSTRING = 1 ;
const CATCH_GET_CHILD = 16 ;
const TOSTRING_USE_KEY = 2 ;
const TOSTRING_USE_CURRENT = 4 ;
const TOSTRING_USE_INNER = 8 ;
const FULL_CACHE = 256 ;
/**
* @param TIterator $iterator
* @param int-mask-of<self::*> $flags
*/
public function __construct(Iterator $iterator, int $flags = self::CALL_TOSTRING) {}
/** @return bool */
public function hasNext () {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
/**
* @return array<array-key, TValue>
*/
public function getCache() {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Iterator<TKey, TValue>
*
* @template-implements OuterIterator<TKey, TValue>
*
* @template-extends FilterIterator<TKey, TValue, TIterator>
*/
class CallbackFilterIterator extends FilterIterator implements OuterIterator {
/**
* @param TIterator $iterator
* @param callable(TValue, TKey, TIterator): bool $callback
*/
public function __construct(Iterator $iterator, callable $callback) {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template-implements SeekableIterator<int, DirectoryIterator>
*/
class DirectoryIterator extends SplFileInfo implements SeekableIterator {
public function __construct(string $path){}
/**
* @return self
*/
public function current() {}
/**
* @return int|false
* @psalm-ignore-falsable-return
*/
public function key() {}
/**
* @return void
*/
public function next(){}
/**
* @return void
*/
public function rewind(){}
/**
* @param int $position
*/
public function seek($position) {}
/**
* @return bool
*/
public function valid(){}
}
/**
* @template-implements Iterator<never, never>
*/
class EmptyIterator implements Iterator {
/**
* @return never
*/
public function current() {}
/**
* @return never
*/
public function key() {}
/**
* @return void
*/
public function next() {}
/**
* @return void
*/
public function rewind() {}
/**
* @return false
*/
public function valid() {}
}
/**
* @template-extends SeekableIterator<string, FilesystemIterator|SplFileInfo|string>
*/
class FilesystemIterator extends DirectoryIterator
{
const CURRENT_AS_PATHNAME = 32;
const CURRENT_AS_FILEINFO = 0;
const CURRENT_AS_SELF = 16;
const CURRENT_MODE_MASK = 240;
const KEY_AS_PATHNAME = 0;
const KEY_AS_FILENAME = 256;
const FOLLOW_SYMLINKS = 512;
const KEY_MODE_MASK = 3840;
const NEW_CURRENT_AND_KEY = 256;
const SKIP_DOTS = 4096;
const UNIX_PATHS = 8192;
/**
* @param int-mask<self::CURRENT_AS_PATHNAME,self::CURRENT_AS_FILEINFO,self::CURRENT_AS_SELF,self::KEY_AS_PATHNAME,self::KEY_AS_FILENAME,self::FOLLOW_SYMLINKS,self::NEW_CURRENT_AND_KEY,self::SKIP_DOTS,self::UNIX_PATHS> $flags
*/
public function __construct(string $path, int $flags = self::KEY_AS_PATHNAME|self::CURRENT_AS_FILEINFO|self::SKIP_DOTS) {}
/**
* @return FilesystemIterator|SplFileInfo|string|null
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return int-mask<self::CURRENT_AS_PATHNAME,self::CURRENT_AS_FILEINFO,self::CURRENT_AS_SELF,self::KEY_AS_PATHNAME,self::KEY_AS_FILENAME,self::FOLLOW_SYMLINKS,self::NEW_CURRENT_AND_KEY,self::SKIP_DOTS,self::UNIX_PATH>
*/
public function getFlags() {}
/**
* @param int-mask<self::CURRENT_AS_PATHNAME,self::CURRENT_AS_FILEINFO,self::CURRENT_AS_SELF,self::KEY_AS_PATHNAME,self::KEY_AS_FILENAME,self::FOLLOW_SYMLINKS,self::NEW_CURRENT_AND_KEY,self::SKIP_DOTS,self::UNIX_PATH> $flags
* @return void
*/
public function setFlags($flags) {}
/**
* @return string|null
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template-extends SeekableIterator<string, GlobIterator|SplFileInfo|string>
*/
class GlobIterator extends FilesystemIterator implements Countable {
/**
* @return int
*/
public function count() {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Iterator<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class InfiniteIterator extends IteratorIterator {
/**
* @param TIterator $iterator
*/
public function __construct(Iterator $iterator) {}
/**
* @return TValue|null current value or null if iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Iterator<TKey, TValue>
*
* @template-implements OuterIterator<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class LimitIterator extends IteratorIterator implements OuterIterator {
/**
* @param TIterator $iterator
*/
public function __construct(Iterator $iterator, int $offset = 0, int $limit = -1) {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template-covariant TKey
* @template-covariant TValue
* @template-covariant TIterator as Iterator<TKey, TValue>
*
* @template-extends IteratorIterator<TKey, TValue, TIterator>
*/
class NoRewindIterator extends IteratorIterator {
/**
* @param TIterator $iterator
*/
public function __construct(Iterator $iterator) {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
*
* @template-covariant TKey
* @template-covariant TValue
*
* @template-implements Iterator<TKey, TValue>
*/
class MultipleIterator implements Iterator {
const MIT_NEED_ANY = 0 ;
const MIT_NEED_ALL = 1 ;
const MIT_KEYS_NUMERIC = 0 ;
const MIT_KEYS_ASSOC = 2 ;
/**
* @param int-mask-of<self::MIT_*> $flags
*/
public function __construct (int $flags = 0) {}
/**
* @param Iterator<TKey,TValue> $iterator
* @param string|int $infos
* @return void
*/
public function attachIterator(Iterator $iterator, $infos = '') {}
/**
* @param Iterator<TKey, TValue> $iterator
* @return bool
*/
public function containsIterator(Iterator $iterator) {}
/**
* @return int
*/
public function countIterators() {}
/**
* nullable values are returned when MIT_NEED_ANY is set
* and one of the iterators is already drained.
* When MIT_NEED_ALL is set and one of the iterators
* is already drained, `current()` throws
*
* @return array<array-key, TValue|null>
*/
public function current() {}
/**
* @param Iterator<TKey,TValue> $iterator
* @return void
*/
public function detachIterator(Iterator $iterator) {}
/**
* @return int-mask-of<self::MIT_*>
*/
public function getFlags() {}
/**
* @return array<array-key, TValue|null>
*/
public function key() {}
/**
* @param int-mask-of<self::MIT_*> $flags
* @return void
*/
public function setFlags( int $flags ) {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as RecursiveIterator<TKey, TValue>
*
* @template-extends FilterIterator<TKey, TValue, TIterator>
* @template-implements RecursiveIterator<TKey, TValue>
*/
abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator {
/**
* @param TIterator $iterator
*/
public function __construct(RecursiveIterator $iterator) {}
/**
* @return TIterator
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as RecursiveIterator<TKey, TValue>
*
* @template-extends RecursiveFilterIterator<TKey, TValue, TIterator>
*/
class ParentIterator extends RecursiveFilterIterator implements RecursiveIterator, OuterIterator {
/**
* @return bool
*/
public function accept() {}
/**
* @param TIterator $iterator
*/
public function __construct(RecursiveIterator $iterator) {}
/**
* @return ParentIterator<TKey,TValue>
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
/**
* @return void
*/
public function next() {}
/**
* @return void
*/
public function rewind() {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TKey
* @template TValue
*
* @template-implements RecursiveIterator<TKey, TValue>
* @template-extends ArrayIterator<TKey, TValue>
*/
class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
const STD_PROP_LIST = 1 ;
const ARRAY_AS_PROPS = 2 ;
const CHILD_ARRAYS_ONLY = 4 ;
/**
* @return RecursiveArrayIterator<TKey, TValue>
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
/**
* @return TValue|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return TKey|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as Iterator<TKey, TValue>
*
* @template-implements RecursiveIterator<TKey, TValue>
* @template-extends CachingIterator<TKey, TValue, TIterator>
*/
class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator {
/**
* @return RecursiveCachingIterator<TKey,TValue, TIterator>
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as RecursiveIterator<TKey, TValue>
*
* @template-implements RecursiveIterator<TKey, TValue>
* @template-extends CallbackFilterIterator<TKey, TValue, TIterator>
*/
class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator {
/**
* @param TIterator $iterator
* @param callable(TValue, TKey, TIterator): bool $callback
*/
public function __construct(RecursiveIterator $iterator, callable $callback) {}
/**
* @return RecursiveCallbackFilterIterator<TKey, TValue, TIterator>
*/
public function getChildren() {}
/**
* @return bool
*/
public function hasChildren() {}
/**
* @return TValue|null current value or null when iterator is drained
*/
public function current() {}
/**
* @return TKey|null current value or null when iterator is drained
*/
public function key() {}
}
/**
* @template-implements RecursiveIterator<string, RecursiveDirectoryIterator|string|SplFileInfo>
* @template-implements SeekableIterator<string, RecursiveDirectoryIterator|string|SplFileInfo>
*/
class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator, SeekableIterator {
const CURRENT_AS_PATHNAME = 32 ;
const CURRENT_AS_FILEINFO = 0 ;
const CURRENT_AS_SELF = 16 ;
const CURRENT_MODE_MASK = 240 ;
const KEY_AS_PATHNAME = 0 ;
const KEY_AS_FILENAME = 256 ;
const FOLLOW_SYMLINKS = 512 ;
const KEY_MODE_MASK = 3840 ;
const NEW_CURRENT_AND_KEY = 256 ;
const SKIP_DOTS = 4096 ;
const UNIX_PATHS = 8192 ;
/**
* @param string $path
* @param int-mask<self::CURRENT_AS_PATHNAME,self::CURRENT_AS_FILEINFO,self::CURRENT_AS_SELF,self::KEY_AS_PATHNAME,self::KEY_AS_FILENAME,self::FOLLOW_SYMLINKS,self::NEW_CURRENT_AND_KEY,self::SKIP_DOTS,self::UNIX_PATHS> $flags
*/
public function __construct(string $path, int $flags = self::KEY_AS_PATHNAME|self::CURRENT_AS_FILEINFO) {}
/**
* @return string
*/
public function getSubPath() {}
/**
* @return string
*/
public function getSubPathname() {}
/**
* @return RecursiveDirectoryIterator|string|SplFileInfo|null current value or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function current() {}
/**
* @return string|null current key or null when iterator is drained
* @psalm-ignore-nullable-return
*/
public function key() {}
}
/**
* @template TIterator as RecursiveIterator|IteratorAggregate
* @mixin TIterator
*/
class RecursiveIteratorIterator implements OuterIterator {
/**
* @param TIterator $iterator
* @param int $mode
* @param int $flags
*
* @return void
*/
public function __construct($iterator, $mode = 0, $flags = 0) {}
}
/**
* @template TKey
* @template TValue
* @template TIterator as RecursiveIterator<TKey, TValue>
*
* @template-implements RecursiveIterator<TKey, TValue>
* @template-extends RegexIterator<TKey, TValue, TIterator>
*/
class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {
const MATCH = 0 ;
const GET_MATCH = 1 ;
const ALL_MATCHES = 2 ;
const SPLIT = 3 ;
const REPLACE = 4 ;
const USE_KEY = 1 ;
/**
* @param TIterator $iterator
* @param string $regex
* @param self::MATH|self::GET_MATCH|self::ALL_MATCHES|self::SPLIT|self::REPLACE $mode
* @param self::USE_KEY|0 $flags
* @param int $preg_flags
*/
public function __construct(RecursiveIterator $iterator, string $regex, int $mode = self::MATCH, int $flags = 0, int $preg_flags = 0) {}
/**
* @return RecursiveRegexIterator<TKey, TValue>
*/
public function getChildren() {}
}
/**
* @template TKey
* @template TValue
*
* @template-extends RecursiveIteratorIterator<TKey, TValue>
* @template-implements OuterIterator<TKey, TValue>
*/
class RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator {
const LEAVES_ONLY = 0 ;
const SELF_FIRST = 1 ;
const CHILD_FIRST = 2 ;
const CATCH_GET_CHILD = 16 ;
const BYPASS_CURRENT = 4 ;
const BYPASS_KEY = 8 ;
const PREFIX_LEFT = 0 ;
const PREFIX_MID_HAS_NEXT = 1 ;
const PREFIX_MID_LAST = 2 ;
const PREFIX_END_HAS_NEXT = 3 ;
const PREFIX_END_LAST = 4 ;
const PREFIX_RIGHT = 5 ;
/**
* @return void
*/
public function beginChildren() {}
/**
* @return RecursiveIterator
*/
public function beginIteration() {}
/**
* @return RecursiveIterator
*/
public function callGetChildren() {}
/**
* @return bool
*/
public function callHasChildren() {}
/**
* @param RecursiveIterator<TKey, TValue>|IteratorAggregate<TKey, TValue> $it
* @param int-mask<self::BYPASS_CURRENT, self::BYPASS_KEY> $flags
* @param int-mask<self::CATCH_GET_CHILD> $cit_flags
* @param self::LEAVES_ONLY|self::SELF_FIRST|self::CHILD_FIRST $mode
*/
public function __construct($it, int $flags = self::BYPASS_KEY, int $cit_flags = self::CATCH_GET_CHILD, int $mode = self::SELF_FIRST) {}
/**
* @return string
*/
public function current() {}