Debian Codegraph @

codelitephp/resources/cc/SPL.php

raw
1 <?php
2
3 // Start of SPL v.0.2
4
5 class LogicException extends Exception {
6 protected $message;
7 protected $code;
8 protected $file;
9 protected $line;
10
11
12 final private function __clone () {}
13
14 /**
15 * @param message[optional]
16 * @param code[optional]
17 * @param previous[optional]
18 */
19 public function __construct ($message, $code, $previous) {}
20
21 final public function getMessage () {}
22
23 final public function getCode () {}
24
25 final public function getFile () {}
26
27 final public function getLine () {}
28
29 final public function getTrace () {}
30
31 final public function getPrevious () {}
32
33 final public function getTraceAsString () {}
34
35 public function __toString () {}
36
37 }
38
39 class BadFunctionCallException extends LogicException {
40 protected $message;
41 protected $code;
42 protected $file;
43 protected $line;
44
45
46 final private function __clone () {}
47
48 /**
49 * @param message[optional]
50 * @param code[optional]
51 * @param previous[optional]
52 */
53 public function __construct ($message, $code, $previous) {}
54
55 final public function getMessage () {}
56
57 final public function getCode () {}
58
59 final public function getFile () {}
60
61 final public function getLine () {}
62
63 final public function getTrace () {}
64
65 final public function getPrevious () {}
66
67 final public function getTraceAsString () {}
68
69 public function __toString () {}
70
71 }
72
73 class BadMethodCallException extends BadFunctionCallException {
74 protected $message;
75 protected $code;
76 protected $file;
77 protected $line;
78
79
80 final private function __clone () {}
81
82 /**
83 * @param message[optional]
84 * @param code[optional]
85 * @param previous[optional]
86 */
87 public function __construct ($message, $code, $previous) {}
88
89 final public function getMessage () {}
90
91 final public function getCode () {}
92
93 final public function getFile () {}
94
95 final public function getLine () {}
96
97 final public function getTrace () {}
98
99 final public function getPrevious () {}
100
101 final public function getTraceAsString () {}
102
103 public function __toString () {}
104
105 }
106
107 class DomainException extends LogicException {
108 protected $message;
109 protected $code;
110 protected $file;
111 protected $line;
112
113
114 final private function __clone () {}
115
116 /**
117 * @param message[optional]
118 * @param code[optional]
119 * @param previous[optional]
120 */
121 public function __construct ($message, $code, $previous) {}
122
123 final public function getMessage () {}
124
125 final public function getCode () {}
126
127 final public function getFile () {}
128
129 final public function getLine () {}
130
131 final public function getTrace () {}
132
133 final public function getPrevious () {}
134
135 final public function getTraceAsString () {}
136
137 public function __toString () {}
138
139 }
140
141 class InvalidArgumentException extends LogicException {
142 protected $message;
143 protected $code;
144 protected $file;
145 protected $line;
146
147
148 final private function __clone () {}
149
150 /**
151 * @param message[optional]
152 * @param code[optional]
153 * @param previous[optional]
154 */
155 public function __construct ($message, $code, $previous) {}
156
157 final public function getMessage () {}
158
159 final public function getCode () {}
160
161 final public function getFile () {}
162
163 final public function getLine () {}
164
165 final public function getTrace () {}
166
167 final public function getPrevious () {}
168
169 final public function getTraceAsString () {}
170
171 public function __toString () {}
172
173 }
174
175 class LengthException extends LogicException {
176 protected $message;
177 protected $code;
178 protected $file;
179 protected $line;
180
181
182 final private function __clone () {}
183
184 /**
185 * @param message[optional]
186 * @param code[optional]
187 * @param previous[optional]
188 */
189 public function __construct ($message, $code, $previous) {}
190
191 final public function getMessage () {}
192
193 final public function getCode () {}
194
195 final public function getFile () {}
196
197 final public function getLine () {}
198
199 final public function getTrace () {}
200
201 final public function getPrevious () {}
202
203 final public function getTraceAsString () {}
204
205 public function __toString () {}
206
207 }
208
209 class OutOfRangeException extends LogicException {
210 protected $message;
211 protected $code;
212 protected $file;
213 protected $line;
214
215
216 final private function __clone () {}
217
218 /**
219 * @param message[optional]
220 * @param code[optional]
221 * @param previous[optional]
222 */
223 public function __construct ($message, $code, $previous) {}
224
225 final public function getMessage () {}
226
227 final public function getCode () {}
228
229 final public function getFile () {}
230
231 final public function getLine () {}
232
233 final public function getTrace () {}
234
235 final public function getPrevious () {}
236
237 final public function getTraceAsString () {}
238
239 public function __toString () {}
240
241 }
242
243 class RuntimeException extends Exception {
244 protected $message;
245 protected $code;
246 protected $file;
247 protected $line;
248
249
250 final private function __clone () {}
251
252 /**
253 * @param message[optional]
254 * @param code[optional]
255 * @param previous[optional]
256 */
257 public function __construct ($message, $code, $previous) {}
258
259 final public function getMessage () {}
260
261 final public function getCode () {}
262
263 final public function getFile () {}
264
265 final public function getLine () {}
266
267 final public function getTrace () {}
268
269 final public function getPrevious () {}
270
271 final public function getTraceAsString () {}
272
273 public function __toString () {}
274
275 }
276
277 class OutOfBoundsException extends RuntimeException {
278 protected $message;
279 protected $code;
280 protected $file;
281 protected $line;
282
283
284 final private function __clone () {}
285
286 /**
287 * @param message[optional]
288 * @param code[optional]
289 * @param previous[optional]
290 */
291 public function __construct ($message, $code, $previous) {}
292
293 final public function getMessage () {}
294
295 final public function getCode () {}
296
297 final public function getFile () {}
298
299 final public function getLine () {}
300
301 final public function getTrace () {}
302
303 final public function getPrevious () {}
304
305 final public function getTraceAsString () {}
306
307 public function __toString () {}
308
309 }
310
311 class OverflowException extends RuntimeException {
312 protected $message;
313 protected $code;
314 protected $file;
315 protected $line;
316
317
318 final private function __clone () {}
319
320 /**
321 * @param message[optional]
322 * @param code[optional]
323 * @param previous[optional]
324 */
325 public function __construct ($message, $code, $previous) {}
326
327 final public function getMessage () {}
328
329 final public function getCode () {}
330
331 final public function getFile () {}
332
333 final public function getLine () {}
334
335 final public function getTrace () {}
336
337 final public function getPrevious () {}
338
339 final public function getTraceAsString () {}
340
341 public function __toString () {}
342
343 }
344
345 class RangeException extends RuntimeException {
346 protected $message;
347 protected $code;
348 protected $file;
349 protected $line;
350
351
352 final private function __clone () {}
353
354 /**
355 * @param message[optional]
356 * @param code[optional]
357 * @param previous[optional]
358 */
359 public function __construct ($message, $code, $previous) {}
360
361 final public function getMessage () {}
362
363 final public function getCode () {}
364
365 final public function getFile () {}
366
367 final public function getLine () {}
368
369 final public function getTrace () {}
370
371 final public function getPrevious () {}
372
373 final public function getTraceAsString () {}
374
375 public function __toString () {}
376
377 }
378
379 class UnderflowException extends RuntimeException {
380 protected $message;
381 protected $code;
382 protected $file;
383 protected $line;
384
385
386 final private function __clone () {}
387
388 /**
389 * @param message[optional]
390 * @param code[optional]
391 * @param previous[optional]
392 */
393 public function __construct ($message, $code, $previous) {}
394
395 final public function getMessage () {}
396
397 final public function getCode () {}
398
399 final public function getFile () {}
400
401 final public function getLine () {}
402
403 final public function getTrace () {}
404
405 final public function getPrevious () {}
406
407 final public function getTraceAsString () {}
408
409 public function __toString () {}
410
411 }
412
413 class UnexpectedValueException extends RuntimeException {
414 protected $message;
415 protected $code;
416 protected $file;
417 protected $line;
418
419
420 final private function __clone () {}
421
422 /**
423 * @param message[optional]
424 * @param code[optional]
425 * @param previous[optional]
426 */
427 public function __construct ($message, $code, $previous) {}
428
429 final public function getMessage () {}
430
431 final public function getCode () {}
432
433 final public function getFile () {}
434
435 final public function getLine () {}
436
437 final public function getTrace () {}
438
439 final public function getPrevious () {}
440
441 final public function getTraceAsString () {}
442
443 public function __toString () {}
444
445 }
446
447 interface RecursiveIterator extends Iterator, Traversable {
448
449 /**
450 * Returns if an iterator can be created fot the current entry.
451 * @link http://www.php.net/manual/en/recursiveiterator.haschildren.php
452 * @return bool true if the current entry can be iterated over, otherwise returns false.
453 */
454 abstract public function hasChildren () ;
455
456 /**
457 * Returns an iterator for the current entry.
458 * @link http://www.php.net/manual/en/recursiveiterator.getchildren.php
459 * @return RecursiveIterator An iterator for the current entry.
460 */
461 abstract public function getChildren () ;
462
463 abstract public function current () ;
464
465 abstract public function next () ;
466
467 abstract public function key () ;
468
469 abstract public function valid () ;
470
471 abstract public function rewind () ;
472
473 }
474
475 class RecursiveIteratorIterator implements Iterator, Traversable, OuterIterator {
476 const LEAVES_ONLY = 0;
477 const SELF_FIRST = 1;
478 const CHILD_FIRST = 2;
479 const CATCH_GET_CHILD = 16;
480
481
482 /**
483 * Construct a RecursiveIteratorIterator
484 * @link http://www.php.net/manual/en/recursiveiteratoriterator.construct.php
485 * @param iterator Traversable
486 * @param mode[optional]
487 * @param flags[optional]
488 */
489 public function __construct (Traversable $iterator, $mode, $flags) {}
490
491 /**
492 * Rewind the iterator to the first element of the top level inner iterator
493 * @link http://www.php.net/manual/en/recursiveiteratoriterator.rewind.php
494 * @return void
495 */
496 public function rewind () {}
497
498 /**
499 * Check whether the current position is valid
500 * @link http://www.php.net/manual/en/recursiveiteratoriterator.valid.php
501 * @return bool true if the current position is valid, otherwise false
502 */
503 public function valid () {}
504
505 /**
506 * Access the current key
507 * @link http://www.php.net/manual/en/recursiveiteratoriterator.key.php
508 * @return mixed The current key.
509 */
510 public function key () {}
511
512 /**
513 * Access the current element value
514 * @link http://www.php.net/manual/en/recursiveiteratoriterator.current.php
515 * @return mixed The current elements value.
516 */
517 public function current () {}
518
519 /**
520 * Move forward to the next element
521 * @link http://www.php.net/manual/en/recursiveiteratoriterator.next.php
522 * @return void
523 */
524 public function next () {}
525
526 /**
527 * Get the current depth of the recursive iteration
528 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getdepth.php
529 * @return int The current depth of the recursive iteration.
530 */
531 public function getDepth () {}
532
533 /**
534 * The current active sub iterator
535 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getsubiterator.php
536 * @param level int[optional] <p>
537 *
538 * </p>
539 * @return RecursiveIterator The current active sub iterator.
540 */
541 public function getSubIterator ($level = null) {}
542
543 /**
544 * Get inner iterator
545 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getinneriterator.php
546 * @return iterator The current active sub iterator.
547 */
548 public function getInnerIterator () {}
549
550 /**
551 * Begin Iteration
552 * @link http://www.php.net/manual/en/recursiveiteratoriterator.beginiteration.php
553 * @return void
554 */
555 public function beginIteration () {}
556
557 /**
558 * End Iteration
559 * @link http://www.php.net/manual/en/recursiveiteratoriterator.enditeration.php
560 * @return void
561 */
562 public function endIteration () {}
563
564 /**
565 * Has children
566 * @link http://www.php.net/manual/en/recursiveiteratoriterator.callhaschildren.php
567 * @return bool true if the element has children, otherwise false
568 */
569 public function callHasChildren () {}
570
571 /**
572 * Get children
573 * @link http://www.php.net/manual/en/recursiveiteratoriterator.callgetchildren.php
574 * @return RecursiveIterator A RecursiveIterator.
575 */
576 public function callGetChildren () {}
577
578 /**
579 * Begin children
580 * @link http://www.php.net/manual/en/recursiveiteratoriterator.beginchildren.php
581 * @return void
582 */
583 public function beginChildren () {}
584
585 /**
586 * End children
587 * @link http://www.php.net/manual/en/recursiveiteratoriterator.endchildren.php
588 * @return void
589 */
590 public function endChildren () {}
591
592 /**
593 * Next element
594 * @link http://www.php.net/manual/en/recursiveiteratoriterator.nextelement.php
595 * @return void
596 */
597 public function nextElement () {}
598
599 /**
600 * Set max depth
601 * @link http://www.php.net/manual/en/recursiveiteratoriterator.setmaxdepth.php
602 * @param max_depth string[optional] <p>
603 * The maximum allowed depth. -1 is used
604 * for any depth.
605 * </p>
606 * @return void
607 */
608 public function setMaxDepth ($max_depth = null) {}
609
610 /**
611 * Get max depth
612 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getmaxdepth.php
613 * @return mixed The maximum accepted depth, or false if any depth is allowed.
614 */
615 public function getMaxDepth () {}
616
617 }
618
619 interface OuterIterator extends Iterator, Traversable {
620
621 /**
622 * Returns the inner iterator for the current entry.
623 * @link http://www.php.net/manual/en/outeriterator.getinneriterator.php
624 * @return Iterator The inner iterator for the current entry.
625 */
626 abstract public function getInnerIterator () ;
627
628 abstract public function current () ;
629
630 abstract public function next () ;
631
632 abstract public function key () ;
633
634 abstract public function valid () ;
635
636 abstract public function rewind () ;
637
638 }
639
640 class IteratorIterator implements Iterator, Traversable, OuterIterator {
641
642 /**
643 * Create an iterator from anything that is traversable
644 * @link http://www.php.net/manual/en/iteratoriterator.construct.php
645 * @param iterator Traversable
646 */
647 public function __construct (Traversable $iterator) {}
648
649 /**
650 * Rewind to the first element
651 * @link http://www.php.net/manual/en/iteratoriterator.rewind.php
652 * @return void
653 */
654 public function rewind () {}
655
656 /**
657 * Checks if the iterator is valid
658 * @link http://www.php.net/manual/en/iteratoriterator.valid.php
659 * @return bool true if the iterator is valid, otherwise false
660 */
661 public function valid () {}
662
663 /**
664 * Get the key of the current element
665 * @link http://www.php.net/manual/en/iteratoriterator.key.php
666 * @return scalar The key of the current element.
667 */
668 public function key () {}
669
670 /**
671 * Get the current value
672 * @link http://www.php.net/manual/en/iteratoriterator.current.php
673 * @return mixed The value of the current element.
674 */
675 public function current () {}
676
677 /**
678 * Forward to the next element
679 * @link http://www.php.net/manual/en/iteratoriterator.next.php
680 * @return void
681 */
682 public function next () {}
683
684 /**
685 * Get the inner iterator
686 * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php
687 * @return Traversable The inner iterator as passed to IteratorIterator::__construct.
688 */
689 public function getInnerIterator () {}
690
691 }
692
693 class FilterIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
694
695 /**
696 * Construct a filterIterator
697 * @link http://www.php.net/manual/en/filteriterator.construct.php
698 * @param iterator Iterator
699 */
700 public function __construct (Iterator $iterator) {}
701
702 /**
703 * Rewind the iterator
704 * @link http://www.php.net/manual/en/filteriterator.rewind.php
705 * @return void
706 */
707 public function rewind () {}
708
709 /**
710 * Check whether the current element is valid
711 * @link http://www.php.net/manual/en/filteriterator.valid.php
712 * @return bool true if the current element is valid, otherwise false
713 */
714 public function valid () {}
715
716 /**
717 * Get the current key
718 * @link http://www.php.net/manual/en/filteriterator.key.php
719 * @return mixed The current key.
720 */
721 public function key () {}
722
723 /**
724 * Get the current element value
725 * @link http://www.php.net/manual/en/filteriterator.current.php
726 * @return mixed The current element value.
727 */
728 public function current () {}
729
730 /**
731 * Move the iterator forward
732 * @link http://www.php.net/manual/en/filteriterator.next.php
733 * @return void
734 */
735 public function next () {}
736
737 /**
738 * Get the inner iterator
739 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
740 * @return Iterator The inner iterator.
741 */
742 public function getInnerIterator () {}
743
744 /**
745 * Check whether the current element of the iterator is acceptable
746 * @link http://www.php.net/manual/en/filteriterator.accept.php
747 * @return bool true if the current element is acceptable, otherwise false.
748 */
749 abstract public function accept () {}
750
751 }
752
753 class RecursiveFilterIterator extends FilterIterator implements Iterator, Traversable, OuterIterator, RecursiveIterator {
754
755 /**
756 * Create a RecursiveFilterIterator from a RecursiveIterator
757 * @link http://www.php.net/manual/en/recursivefilteriterator.construct.php
758 * @param iterator RecursiveIterator
759 */
760 public function __construct (RecursiveIterator $iterator) {}
761
762 /**
763 * Check whether the inner iterator's current element has children
764 * @link http://www.php.net/manual/en/recursivefilteriterator.haschildren.php
765 * @return bool true if the inner iterator has children, otherwise false
766 */
767 public function hasChildren () {}
768
769 /**
770 * Return the inner iterator's children contained in a RecursiveFilterIterator
771 * @link http://www.php.net/manual/en/recursivefilteriterator.getchildren.php
772 * @return RecursiveFilterIterator a RecursiveFilterIterator containing the inner iterator's children.
773 */
774 public function getChildren () {}
775
776 /**
777 * Rewind the iterator
778 * @link http://www.php.net/manual/en/filteriterator.rewind.php
779 * @return void
780 */
781 public function rewind () {}
782
783 /**
784 * Check whether the current element is valid
785 * @link http://www.php.net/manual/en/filteriterator.valid.php
786 * @return bool true if the current element is valid, otherwise false
787 */
788 public function valid () {}
789
790 /**
791 * Get the current key
792 * @link http://www.php.net/manual/en/filteriterator.key.php
793 * @return mixed The current key.
794 */
795 public function key () {}
796
797 /**
798 * Get the current element value
799 * @link http://www.php.net/manual/en/filteriterator.current.php
800 * @return mixed The current element value.
801 */
802 public function current () {}
803
804 /**
805 * Move the iterator forward
806 * @link http://www.php.net/manual/en/filteriterator.next.php
807 * @return void
808 */
809 public function next () {}
810
811 /**
812 * Get the inner iterator
813 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
814 * @return Iterator The inner iterator.
815 */
816 public function getInnerIterator () {}
817
818 /**
819 * Check whether the current element of the iterator is acceptable
820 * @link http://www.php.net/manual/en/filteriterator.accept.php
821 * @return bool true if the current element is acceptable, otherwise false.
822 */
823 abstract public function accept () {}
824
825 }
826
827 class CallbackFilterIterator extends FilterIterator implements Iterator, Traversable, OuterIterator {
828
829 /**
830 * Create a filtered iterator from another iterator
831 * @link http://www.php.net/manual/en/callbackfilteriterator.construct.php
832 * @param iterator Iterator
833 * @param callback
834 */
835 public function __construct (Iterator $iterator, $callback) {}
836
837 /**
838 * Calls the callback with the current value, the current key and the inner iterator as arguments
839 * @link http://www.php.net/manual/en/callbackfilteriterator.accept.php
840 * @return string true to accept the current item, or false otherwise.
841 */
842 public function accept () {}
843
844 /**
845 * Rewind the iterator
846 * @link http://www.php.net/manual/en/filteriterator.rewind.php
847 * @return void
848 */
849 public function rewind () {}
850
851 /**
852 * Check whether the current element is valid
853 * @link http://www.php.net/manual/en/filteriterator.valid.php
854 * @return bool true if the current element is valid, otherwise false
855 */
856 public function valid () {}
857
858 /**
859 * Get the current key
860 * @link http://www.php.net/manual/en/filteriterator.key.php
861 * @return mixed The current key.
862 */
863 public function key () {}
864
865 /**
866 * Get the current element value
867 * @link http://www.php.net/manual/en/filteriterator.current.php
868 * @return mixed The current element value.
869 */
870 public function current () {}
871
872 /**
873 * Move the iterator forward
874 * @link http://www.php.net/manual/en/filteriterator.next.php
875 * @return void
876 */
877 public function next () {}
878
879 /**
880 * Get the inner iterator
881 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
882 * @return Iterator The inner iterator.
883 */
884 public function getInnerIterator () {}
885
886 }
887
888 class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements OuterIterator, Traversable, Iterator, RecursiveIterator {
889
890 /**
891 * Create a RecursiveCallbackFilterIterator from a RecursiveIterator
892 * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.construct.php
893 * @param iterator RecursiveIterator
894 * @param callback
895 */
896 public function __construct (RecursiveIterator $iterator, $callback) {}
897
898 /**
899 * Check whether the inner iterator's current element has children
900 * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.haschildren.php
901 * @return void true if the current element has children, false otherwise.
902 */
903 public function hasChildren () {}
904
905 /**
906 * Return the inner iterator's children contained in a RecursiveCallbackFilterIterator
907 * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.getchildren.php
908 * @return RecursiveCallbackFilterIterator a RecursiveCallbackFilterIterator containing
909 * the children.
910 */
911 public function getChildren () {}
912
913 /**
914 * Calls the callback with the current value, the current key and the inner iterator as arguments
915 * @link http://www.php.net/manual/en/callbackfilteriterator.accept.php
916 * @return string true to accept the current item, or false otherwise.
917 */
918 public function accept () {}
919
920 /**
921 * Rewind the iterator
922 * @link http://www.php.net/manual/en/filteriterator.rewind.php
923 * @return void
924 */
925 public function rewind () {}
926
927 /**
928 * Check whether the current element is valid
929 * @link http://www.php.net/manual/en/filteriterator.valid.php
930 * @return bool true if the current element is valid, otherwise false
931 */
932 public function valid () {}
933
934 /**
935 * Get the current key
936 * @link http://www.php.net/manual/en/filteriterator.key.php
937 * @return mixed The current key.
938 */
939 public function key () {}
940
941 /**
942 * Get the current element value
943 * @link http://www.php.net/manual/en/filteriterator.current.php
944 * @return mixed The current element value.
945 */
946 public function current () {}
947
948 /**
949 * Move the iterator forward
950 * @link http://www.php.net/manual/en/filteriterator.next.php
951 * @return void
952 */
953 public function next () {}
954
955 /**
956 * Get the inner iterator
957 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
958 * @return Iterator The inner iterator.
959 */
960 public function getInnerIterator () {}
961
962 }
963
964 class ParentIterator extends RecursiveFilterIterator implements RecursiveIterator, OuterIterator, Traversable, Iterator {
965
966 /**
967 * Constructs a ParentIterator
968 * @link http://www.php.net/manual/en/parentiterator.construct.php
969 * @param iterator RecursiveIterator
970 */
971 public function __construct (RecursiveIterator $iterator) {}
972
973 /**
974 * Determines acceptability
975 * @link http://www.php.net/manual/en/parentiterator.accept.php
976 * @return bool true if the current element is acceptable, otherwise false.
977 */
978 public function accept () {}
979
980 /**
981 * Check whether the inner iterator's current element has children
982 * @link http://www.php.net/manual/en/recursivefilteriterator.haschildren.php
983 * @return bool true if the inner iterator has children, otherwise false
984 */
985 public function hasChildren () {}
986
987 /**
988 * Return the inner iterator's children contained in a RecursiveFilterIterator
989 * @link http://www.php.net/manual/en/recursivefilteriterator.getchildren.php
990 * @return RecursiveFilterIterator a RecursiveFilterIterator containing the inner iterator's children.
991 */
992 public function getChildren () {}
993
994 /**
995 * Rewind the iterator
996 * @link http://www.php.net/manual/en/filteriterator.rewind.php
997 * @return void
998 */
999 public function rewind () {}
1000
1001 /**
1002 * Check whether the current element is valid
1003 * @link http://www.php.net/manual/en/filteriterator.valid.php
1004 * @return bool true if the current element is valid, otherwise false
1005 */
1006 public function valid () {}
1007
1008 /**
1009 * Get the current key
1010 * @link http://www.php.net/manual/en/filteriterator.key.php
1011 * @return mixed The current key.
1012 */
1013 public function key () {}
1014
1015 /**
1016 * Get the current element value
1017 * @link http://www.php.net/manual/en/filteriterator.current.php
1018 * @return mixed The current element value.
1019 */
1020 public function current () {}
1021
1022 /**
1023 * Move the iterator forward
1024 * @link http://www.php.net/manual/en/filteriterator.next.php
1025 * @return void
1026 */
1027 public function next () {}
1028
1029 /**
1030 * Get the inner iterator
1031 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
1032 * @return Iterator The inner iterator.
1033 */
1034 public function getInnerIterator () {}
1035
1036 }
1037
1038 interface Countable {
1039
1040 /**
1041 * Count elements of an object
1042 * @link http://www.php.net/manual/en/countable.count.php
1043 * @param mode int[optional] <p>
1044 * The optional mode parameter will be set to
1045 * COUNT_NORMAL or COUNT_RECURSIVE, depending
1046 * on what value was passed to the second parameter of count.
1047 * This is particularly useful for counting all the elements of
1048 * a multidimensional array/Countable combination.
1049 * </p>
1050 * @return int The custom count as an integer.
1051 * </p>
1052 *
1053 * <p>
1054 * The return value is cast to an integer.
1055 */
1056 abstract public function count ($mode = null) ;
1057
1058 }
1059
1060 interface SeekableIterator extends Iterator, Traversable {
1061
1062 /**
1063 * Seeks to a position
1064 * @link http://www.php.net/manual/en/seekableiterator.seek.php
1065 * @param position int <p>
1066 * The position to seek to.
1067 * </p>
1068 * @return void
1069 */
1070 abstract public function seek ($position) ;
1071
1072 abstract public function current () ;
1073
1074 abstract public function next () ;
1075
1076 abstract public function key () ;
1077
1078 abstract public function valid () ;
1079
1080 abstract public function rewind () ;
1081
1082 }
1083
1084 class LimitIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
1085
1086 /**
1087 * Construct a LimitIterator
1088 * @link http://www.php.net/manual/en/limititerator.construct.php
1089 * @param iterator Iterator
1090 * @param offset[optional]
1091 * @param count[optional]
1092 */
1093 public function __construct (Iterator $iterator, $offset, $count) {}
1094
1095 /**
1096 * Rewind the iterator to the specified starting offset
1097 * @link http://www.php.net/manual/en/limititerator.rewind.php
1098 * @return void
1099 */
1100 public function rewind () {}
1101
1102 /**
1103 * Check whether the current element is valid
1104 * @link http://www.php.net/manual/en/limititerator.valid.php
1105 * @return bool Returns true on success, false on failure.
1106 */
1107 public function valid () {}
1108
1109 /**
1110 * Get current key
1111 * @link http://www.php.net/manual/en/limititerator.key.php
1112 * @return mixed the key for the current item.
1113 */
1114 public function key () {}
1115
1116 /**
1117 * Get current element
1118 * @link http://www.php.net/manual/en/limititerator.current.php
1119 * @return mixed the current element or &null; if there is none.
1120 */
1121 public function current () {}
1122
1123 /**
1124 * Move the iterator forward
1125 * @link http://www.php.net/manual/en/limititerator.next.php
1126 * @return void
1127 */
1128 public function next () {}
1129
1130 /**
1131 * Seek to the given position
1132 * @link http://www.php.net/manual/en/limititerator.seek.php
1133 * @param position int <p>
1134 * The position to seek to.
1135 * </p>
1136 * @return int the offset position after seeking.
1137 */
1138 public function seek ($position) {}
1139
1140 /**
1141 * Return the current position
1142 * @link http://www.php.net/manual/en/limititerator.getposition.php
1143 * @return int The current position.
1144 */
1145 public function getPosition () {}
1146
1147 /**
1148 * Get inner iterator
1149 * @link http://www.php.net/manual/en/limititerator.getinneriterator.php
1150 * @return Iterator The inner iterator passed to LimitIterator::__construct.
1151 */
1152 public function getInnerIterator () {}
1153
1154 }
1155
1156 class CachingIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator, ArrayAccess, Countable {
1157 const CALL_TOSTRING = 1;
1158 const CATCH_GET_CHILD = 16;
1159 const TOSTRING_USE_KEY = 2;
1160 const TOSTRING_USE_CURRENT = 4;
1161 const TOSTRING_USE_INNER = 8;
1162 const FULL_CACHE = 256;
1163
1164
1165 /**
1166 * Construct a new CachingIterator object for the iterator.
1167 * @link http://www.php.net/manual/en/cachingiterator.construct.php
1168 * @param iterator Iterator
1169 * @param flags[optional]
1170 */
1171 public function __construct (Iterator $iterator, $flags) {}
1172
1173 /**
1174 * Rewind the iterator
1175 * @link http://www.php.net/manual/en/cachingiterator.rewind.php
1176 * @return void
1177 */
1178 public function rewind () {}
1179
1180 /**
1181 * Check whether the current element is valid
1182 * @link http://www.php.net/manual/en/cachingiterator.valid.php
1183 * @return void Returns true on success, false on failure.
1184 */
1185 public function valid () {}
1186
1187 /**
1188 * Return the key for the current element
1189 * @link http://www.php.net/manual/en/cachingiterator.key.php
1190 * @return scalar
1191 */
1192 public function key () {}
1193
1194 /**
1195 * Return the current element
1196 * @link http://www.php.net/manual/en/cachingiterator.current.php
1197 * @return void Mixed
1198 */
1199 public function current () {}
1200
1201 /**
1202 * Move the iterator forward
1203 * @link http://www.php.net/manual/en/cachingiterator.next.php
1204 * @return void
1205 */
1206 public function next () {}
1207
1208 /**
1209 * Check whether the inner iterator has a valid next element
1210 * @link http://www.php.net/manual/en/cachingiterator.hasnext.php
1211 * @return void Returns true on success, false on failure.
1212 */
1213 public function hasNext () {}
1214
1215 /**
1216 * Return the string representation of the current element
1217 * @link http://www.php.net/manual/en/cachingiterator.tostring.php
1218 * @return void The string representation of the current element.
1219 */
1220 public function __toString () {}
1221
1222 /**
1223 * Returns the inner iterator
1224 * @link http://www.php.net/manual/en/cachingiterator.getinneriterator.php
1225 * @return Iterator an object implementing the Iterator interface.
1226 */
1227 public function getInnerIterator () {}
1228
1229 /**
1230 * Get flags used
1231 * @link http://www.php.net/manual/en/cachingiterator.getflags.php
1232 * @return void Description...
1233 */
1234 public function getFlags () {}
1235
1236 /**
1237 * The setFlags purpose
1238 * @link http://www.php.net/manual/en/cachingiterator.setflags.php
1239 * @param flags bitmask <p>
1240 * Bitmask of the flags to set.
1241 * </p>
1242 * @return void
1243 */
1244 public function setFlags ($flags) {}
1245
1246 /**
1247 * The offsetGet purpose
1248 * @link http://www.php.net/manual/en/cachingiterator.offsetget.php
1249 * @param index string <p>
1250 * Description...
1251 * </p>
1252 * @return void Description...
1253 */
1254 public function offsetGet ($index) {}
1255
1256 /**
1257 * The offsetSet purpose
1258 * @link http://www.php.net/manual/en/cachingiterator.offsetset.php
1259 * @param index string <p>
1260 * The index of the element to be set.
1261 * </p>
1262 * @param newval string <p>
1263 * The new value for the index.
1264 * </p>
1265 * @return void
1266 */
1267 public function offsetSet ($index, $newval) {}
1268
1269 /**
1270 * The offsetUnset purpose
1271 * @link http://www.php.net/manual/en/cachingiterator.offsetunset.php
1272 * @param index string <p>
1273 * The index of the element to be unset.
1274 * </p>
1275 * @return void
1276 */
1277 public function offsetUnset ($index) {}
1278
1279 /**
1280 * The offsetExists purpose
1281 * @link http://www.php.net/manual/en/cachingiterator.offsetexists.php
1282 * @param index string <p>
1283 * The index being checked.
1284 * </p>
1285 * @return void true if an entry referenced by the offset exists, false otherwise.
1286 */
1287 public function offsetExists ($index) {}
1288
1289 /**
1290 * Retrieve the contents of the cache
1291 * @link http://www.php.net/manual/en/cachingiterator.getcache.php
1292 * @return array An array containing the cache items.
1293 */
1294 public function getCache () {}
1295
1296 /**
1297 * The number of elements in the iterator
1298 * @link http://www.php.net/manual/en/cachingiterator.count.php
1299 * @return int The count of the elements iterated over.
1300 */
1301 public function count () {}
1302
1303 }
1304
1305 class RecursiveCachingIterator extends CachingIterator implements Countable, ArrayAccess, Iterator, Traversable, OuterIterator, RecursiveIterator {
1306 const CALL_TOSTRING = 1;
1307 const CATCH_GET_CHILD = 16;
1308 const TOSTRING_USE_KEY = 2;
1309 const TOSTRING_USE_CURRENT = 4;
1310 const TOSTRING_USE_INNER = 8;
1311 const FULL_CACHE = 256;
1312
1313
1314 /**
1315 * Construct
1316 * @link http://www.php.net/manual/en/recursivecachingiterator.construct.php
1317 * @param iterator Iterator
1318 * @param flags[optional]
1319 */
1320 public function __construct (Iterator $iterator, $flags) {}
1321
1322 /**
1323 * Check whether the current element of the inner iterator has children
1324 * @link http://www.php.net/manual/en/recursivecachingiterator.haschildren.php
1325 * @return bool true if the inner iterator has children, otherwise false
1326 */
1327 public function hasChildren () {}
1328
1329 /**
1330 * Return the inner iterator's children as a RecursiveCachingIterator
1331 * @link http://www.php.net/manual/en/recursivecachingiterator.getchildren.php
1332 * @return RecursiveCachingIterator The inner iterator's children, as a RecursiveCachingIterator.
1333 */
1334 public function getChildren () {}
1335
1336 /**
1337 * Rewind the iterator
1338 * @link http://www.php.net/manual/en/cachingiterator.rewind.php
1339 * @return void
1340 */
1341 public function rewind () {}
1342
1343 /**
1344 * Check whether the current element is valid
1345 * @link http://www.php.net/manual/en/cachingiterator.valid.php
1346 * @return void Returns true on success, false on failure.
1347 */
1348 public function valid () {}
1349
1350 /**
1351 * Return the key for the current element
1352 * @link http://www.php.net/manual/en/cachingiterator.key.php
1353 * @return scalar
1354 */
1355 public function key () {}
1356
1357 /**
1358 * Return the current element
1359 * @link http://www.php.net/manual/en/cachingiterator.current.php
1360 * @return void Mixed
1361 */
1362 public function current () {}
1363
1364 /**
1365 * Move the iterator forward
1366 * @link http://www.php.net/manual/en/cachingiterator.next.php
1367 * @return void
1368 */
1369 public function next () {}
1370
1371 /**
1372 * Check whether the inner iterator has a valid next element
1373 * @link http://www.php.net/manual/en/cachingiterator.hasnext.php
1374 * @return void Returns true on success, false on failure.
1375 */
1376 public function hasNext () {}
1377
1378 /**
1379 * Return the string representation of the current element
1380 * @link http://www.php.net/manual/en/cachingiterator.tostring.php
1381 * @return void The string representation of the current element.
1382 */
1383 public function __toString () {}
1384
1385 /**
1386 * Returns the inner iterator
1387 * @link http://www.php.net/manual/en/cachingiterator.getinneriterator.php
1388 * @return Iterator an object implementing the Iterator interface.
1389 */
1390 public function getInnerIterator () {}
1391
1392 /**
1393 * Get flags used
1394 * @link http://www.php.net/manual/en/cachingiterator.getflags.php
1395 * @return void Description...
1396 */
1397 public function getFlags () {}
1398
1399 /**
1400 * The setFlags purpose
1401 * @link http://www.php.net/manual/en/cachingiterator.setflags.php
1402 * @param flags bitmask <p>
1403 * Bitmask of the flags to set.
1404 * </p>
1405 * @return void
1406 */
1407 public function setFlags ($flags) {}
1408
1409 /**
1410 * The offsetGet purpose
1411 * @link http://www.php.net/manual/en/cachingiterator.offsetget.php
1412 * @param index string <p>
1413 * Description...
1414 * </p>
1415 * @return void Description...
1416 */
1417 public function offsetGet ($index) {}
1418
1419 /**
1420 * The offsetSet purpose
1421 * @link http://www.php.net/manual/en/cachingiterator.offsetset.php
1422 * @param index string <p>
1423 * The index of the element to be set.
1424 * </p>
1425 * @param newval string <p>
1426 * The new value for the index.
1427 * </p>
1428 * @return void
1429 */
1430 public function offsetSet ($index, $newval) {}
1431
1432 /**
1433 * The offsetUnset purpose
1434 * @link http://www.php.net/manual/en/cachingiterator.offsetunset.php
1435 * @param index string <p>
1436 * The index of the element to be unset.
1437 * </p>
1438 * @return void
1439 */
1440 public function offsetUnset ($index) {}
1441
1442 /**
1443 * The offsetExists purpose
1444 * @link http://www.php.net/manual/en/cachingiterator.offsetexists.php
1445 * @param index string <p>
1446 * The index being checked.
1447 * </p>
1448 * @return void true if an entry referenced by the offset exists, false otherwise.
1449 */
1450 public function offsetExists ($index) {}
1451
1452 /**
1453 * Retrieve the contents of the cache
1454 * @link http://www.php.net/manual/en/cachingiterator.getcache.php
1455 * @return array An array containing the cache items.
1456 */
1457 public function getCache () {}
1458
1459 /**
1460 * The number of elements in the iterator
1461 * @link http://www.php.net/manual/en/cachingiterator.count.php
1462 * @return int The count of the elements iterated over.
1463 */
1464 public function count () {}
1465
1466 }
1467
1468 class NoRewindIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
1469
1470 /**
1471 * Construct a NoRewindIterator
1472 * @link http://www.php.net/manual/en/norewinditerator.construct.php
1473 * @param iterator Iterator
1474 */
1475 public function __construct (Iterator $iterator) {}
1476
1477 /**
1478 * Prevents the rewind operation on the inner iterator.
1479 * @link http://www.php.net/manual/en/norewinditerator.rewind.php
1480 * @return void
1481 */
1482 public function rewind () {}
1483
1484 /**
1485 * Validates the iterator
1486 * @link http://www.php.net/manual/en/norewinditerator.valid.php
1487 * @return bool Returns true on success, false on failure.
1488 */
1489 public function valid () {}
1490
1491 /**
1492 * Get the current key
1493 * @link http://www.php.net/manual/en/norewinditerator.key.php
1494 * @return mixed The current key.
1495 */
1496 public function key () {}
1497
1498 /**
1499 * Get the current value
1500 * @link http://www.php.net/manual/en/norewinditerator.current.php
1501 * @return mixed The current value.
1502 */
1503 public function current () {}
1504
1505 /**
1506 * Forward to the next element
1507 * @link http://www.php.net/manual/en/norewinditerator.next.php
1508 * @return void
1509 */
1510 public function next () {}
1511
1512 /**
1513 * Get the inner iterator
1514 * @link http://www.php.net/manual/en/norewinditerator.getinneriterator.php
1515 * @return iterator The inner iterator, as passed to NoRewindIterator::__construct.
1516 */
1517 public function getInnerIterator () {}
1518
1519 }
1520
1521 class AppendIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
1522
1523 /**
1524 * Constructs an AppendIterator
1525 * @link http://www.php.net/manual/en/appenditerator.construct.php
1526 */
1527 public function __construct () {}
1528
1529 /**
1530 * Appends an iterator
1531 * @link http://www.php.net/manual/en/appenditerator.append.php
1532 * @param iterator Iterator <p>
1533 * The iterator to append.
1534 * </p>
1535 * @return void
1536 */
1537 public function append ($iterator) {}
1538
1539 /**
1540 * Rewinds the Iterator
1541 * @link http://www.php.net/manual/en/appenditerator.rewind.php
1542 * @return void
1543 */
1544 public function rewind () {}
1545
1546 /**
1547 * Checks validity of the current element
1548 * @link http://www.php.net/manual/en/appenditerator.valid.php
1549 * @return bool true if the current iteration is valid, false otherwise.
1550 */
1551 public function valid () {}
1552
1553 /**
1554 * Gets the current key
1555 * @link http://www.php.net/manual/en/appenditerator.key.php
1556 * @return scalar The current key if it is valid or &null; otherwise.
1557 */
1558 public function key () {}
1559
1560 /**
1561 * Gets the current value
1562 * @link http://www.php.net/manual/en/appenditerator.current.php
1563 * @return mixed The current value if it is valid or &null; otherwise.
1564 */
1565 public function current () {}
1566
1567 /**
1568 * Moves to the next element
1569 * @link http://www.php.net/manual/en/appenditerator.next.php
1570 * @return void
1571 */
1572 public function next () {}
1573
1574 /**
1575 * Gets the inner iterator
1576 * @link http://www.php.net/manual/en/appenditerator.getinneriterator.php
1577 * @return Iterator The current inner iterator, or &null; if there is not one.
1578 */
1579 public function getInnerIterator () {}
1580
1581 /**
1582 * Gets an index of iterators
1583 * @link http://www.php.net/manual/en/appenditerator.getiteratorindex.php
1584 * @return int an integer, which is the zero-based index
1585 * of the current inner iterator.
1586 */
1587 public function getIteratorIndex () {}
1588
1589 /**
1590 * Gets the ArrayIterator
1591 * @link http://www.php.net/manual/en/appenditerator.getarrayiterator.php
1592 * @return void an ArrayIterator containing
1593 * the appended iterators.
1594 */
1595 public function getArrayIterator () {}
1596
1597 }
1598
1599 class InfiniteIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
1600
1601 /**
1602 * Constructs an InfiniteIterator
1603 * @link http://www.php.net/manual/en/infiniteiterator.construct.php
1604 * @param iterator Iterator
1605 */
1606 public function __construct (Iterator $iterator) {}
1607
1608 /**
1609 * Moves the inner Iterator forward or rewinds it
1610 * @link http://www.php.net/manual/en/infiniteiterator.next.php
1611 * @return void
1612 */
1613 public function next () {}
1614
1615 /**
1616 * Rewind to the first element
1617 * @link http://www.php.net/manual/en/iteratoriterator.rewind.php
1618 * @return void
1619 */
1620 public function rewind () {}
1621
1622 /**
1623 * Checks if the iterator is valid
1624 * @link http://www.php.net/manual/en/iteratoriterator.valid.php
1625 * @return bool true if the iterator is valid, otherwise false
1626 */
1627 public function valid () {}
1628
1629 /**
1630 * Get the key of the current element
1631 * @link http://www.php.net/manual/en/iteratoriterator.key.php
1632 * @return scalar The key of the current element.
1633 */
1634 public function key () {}
1635
1636 /**
1637 * Get the current value
1638 * @link http://www.php.net/manual/en/iteratoriterator.current.php
1639 * @return mixed The value of the current element.
1640 */
1641 public function current () {}
1642
1643 /**
1644 * Get the inner iterator
1645 * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php
1646 * @return Traversable The inner iterator as passed to IteratorIterator::__construct.
1647 */
1648 public function getInnerIterator () {}
1649
1650 }
1651
1652 class RegexIterator extends FilterIterator implements Iterator, Traversable, OuterIterator {
1653 const USE_KEY = 1;
1654 const INVERT_MATCH = 2;
1655 const MATCH = 0;
1656 const GET_MATCH = 1;
1657 const ALL_MATCHES = 2;
1658 const SPLIT = 3;
1659 const REPLACE = 4;
1660
1661 public $replacement;
1662
1663
1664 /**
1665 * Create a new RegexIterator
1666 * @link http://www.php.net/manual/en/regexiterator.construct.php
1667 * @param iterator Iterator
1668 * @param regex
1669 * @param mode[optional]
1670 * @param flags[optional]
1671 * @param preg_flags[optional]
1672 */
1673 public function __construct (Iterator $iterator, $regex, $mode, $flags, $preg_flags) {}
1674
1675 /**
1676 * Get accept status
1677 * @link http://www.php.net/manual/en/regexiterator.accept.php
1678 * @return bool true if a match, false otherwise.
1679 */
1680 public function accept () {}
1681
1682 /**
1683 * Returns operation mode.
1684 * @link http://www.php.net/manual/en/regexiterator.getmode.php
1685 * @return int the operation mode.
1686 */
1687 public function getMode () {}
1688
1689 /**
1690 * Sets the operation mode.
1691 * @link http://www.php.net/manual/en/regexiterator.setmode.php
1692 * @param mode int <p>
1693 * The operation mode.
1694 * </p>
1695 * <p>
1696 * The available modes are listed below. The actual
1697 * meanings of these modes are described in the
1698 * predefined constants.
1699 * <table>
1700 * RegexIterator modes
1701 *
1702 *
1703 * <tr valign="top">
1704 * <td>value</td>
1705 * <td>constant</td>
1706 * </tr>
1707 *
1708 *
1709 * <tr valign="top">
1710 * <td>0</td>
1711 * <td>
1712 * RegexIterator::MATCH
1713 * </td>
1714 * </tr>
1715 * <tr valign="top">
1716 * <td>1</td>
1717 * <td>
1718 * RegexIterator::GET_MATCH
1719 * </td>
1720 * </tr>
1721 * <tr valign="top">
1722 * <td>2</td>
1723 * <td>
1724 * RegexIterator::ALL_MATCHES
1725 * </td>
1726 * </tr>
1727 * <tr valign="top">
1728 * <td>3</td>
1729 * <td>
1730 * RegexIterator::SPLIT
1731 * </td>
1732 * </tr>
1733 * <tr valign="top">
1734 * <td>4</td>
1735 * <td>
1736 * RegexIterator::REPLACE
1737 * </td>
1738 * </tr>
1739 *
1740 *
1741 * </table>
1742 * </p>
1743 * @return void
1744 */
1745 public function setMode ($mode) {}
1746
1747 /**
1748 * Get flags
1749 * @link http://www.php.net/manual/en/regexiterator.getflags.php
1750 * @return int the set flags.
1751 */
1752 public function getFlags () {}
1753
1754 /**
1755 * Sets the flags.
1756 * @link http://www.php.net/manual/en/regexiterator.setflags.php
1757 * @param flags int <p>
1758 * The flags to set, a bitmask of class constants.
1759 * </p>
1760 * <p>
1761 * The available flags are listed below. The actual
1762 * meanings of these flags are described in the
1763 * predefined constants.
1764 * <table>
1765 * RegexIterator flags
1766 *
1767 *
1768 * <tr valign="top">
1769 * <td>value</td>
1770 * <td>constant</td>
1771 * </tr>
1772 *
1773 *
1774 * <tr valign="top">
1775 * <td>1</td>
1776 * <td>
1777 * RegexIterator::USE_KEY
1778 * </td>
1779 * </tr>
1780 *
1781 *
1782 * </table>
1783 * </p>
1784 * @return void
1785 */
1786 public function setFlags ($flags) {}
1787
1788 /**
1789 * Returns the regular expression flags.
1790 * @link http://www.php.net/manual/en/regexiterator.getpregflags.php
1791 * @return int a bitmask of the regular expression flags.
1792 */
1793 public function getPregFlags () {}
1794
1795 /**
1796 * Sets the regular expression flags.
1797 * @link http://www.php.net/manual/en/regexiterator.setpregflags.php
1798 * @param preg_flags int <p>
1799 * The regular expression flags. See RegexIterator::__construct
1800 * for an overview of available flags.
1801 * </p>
1802 * @return void
1803 */
1804 public function setPregFlags ($preg_flags) {}
1805
1806 /**
1807 * Returns current regular expression
1808 * @link http://www.php.net/manual/en/regexiterator.getregex.php
1809 * @return string
1810 */
1811 public function getRegex () {}
1812
1813 /**
1814 * Rewind the iterator
1815 * @link http://www.php.net/manual/en/filteriterator.rewind.php
1816 * @return void
1817 */
1818 public function rewind () {}
1819
1820 /**
1821 * Check whether the current element is valid
1822 * @link http://www.php.net/manual/en/filteriterator.valid.php
1823 * @return bool true if the current element is valid, otherwise false
1824 */
1825 public function valid () {}
1826
1827 /**
1828 * Get the current key
1829 * @link http://www.php.net/manual/en/filteriterator.key.php
1830 * @return mixed The current key.
1831 */
1832 public function key () {}
1833
1834 /**
1835 * Get the current element value
1836 * @link http://www.php.net/manual/en/filteriterator.current.php
1837 * @return mixed The current element value.
1838 */
1839 public function current () {}
1840
1841 /**
1842 * Move the iterator forward
1843 * @link http://www.php.net/manual/en/filteriterator.next.php
1844 * @return void
1845 */
1846 public function next () {}
1847
1848 /**
1849 * Get the inner iterator
1850 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
1851 * @return Iterator The inner iterator.
1852 */
1853 public function getInnerIterator () {}
1854
1855 }
1856
1857 class RecursiveRegexIterator extends RegexIterator implements OuterIterator, Traversable, Iterator, RecursiveIterator {
1858 const USE_KEY = 1;
1859 const INVERT_MATCH = 2;
1860 const MATCH = 0;
1861 const GET_MATCH = 1;
1862 const ALL_MATCHES = 2;
1863 const SPLIT = 3;
1864 const REPLACE = 4;
1865
1866 public $replacement;
1867
1868
1869 /**
1870 * Creates a new RecursiveRegexIterator.
1871 * @link http://www.php.net/manual/en/recursiveregexiterator.construct.php
1872 * @param iterator RecursiveIterator
1873 * @param regex
1874 * @param mode[optional]
1875 * @param flags[optional]
1876 * @param preg_flags[optional]
1877 */
1878 public function __construct (RecursiveIterator $iterator, $regex, $mode, $flags, $preg_flags) {}
1879
1880 /**
1881 * Returns whether an iterator can be obtained for the current entry.
1882 * @link http://www.php.net/manual/en/recursiveregexiterator.haschildren.php
1883 * @return bool true if an iterator can be obtained for the current entry, otherwise returns false.
1884 */
1885 public function hasChildren () {}
1886
1887 /**
1888 * Returns an iterator for the current entry.
1889 * @link http://www.php.net/manual/en/recursiveregexiterator.getchildren.php
1890 * @return RecursiveRegexIterator An iterator for the current entry, if it can be iterated over by the inner iterator.
1891 */
1892 public function getChildren () {}
1893
1894 /**
1895 * Get accept status
1896 * @link http://www.php.net/manual/en/regexiterator.accept.php
1897 * @return bool true if a match, false otherwise.
1898 */
1899 public function accept () {}
1900
1901 /**
1902 * Returns operation mode.
1903 * @link http://www.php.net/manual/en/regexiterator.getmode.php
1904 * @return int the operation mode.
1905 */
1906 public function getMode () {}
1907
1908 /**
1909 * Sets the operation mode.
1910 * @link http://www.php.net/manual/en/regexiterator.setmode.php
1911 * @param mode int <p>
1912 * The operation mode.
1913 * </p>
1914 * <p>
1915 * The available modes are listed below. The actual
1916 * meanings of these modes are described in the
1917 * predefined constants.
1918 * <table>
1919 * RegexIterator modes
1920 *
1921 *
1922 * <tr valign="top">
1923 * <td>value</td>
1924 * <td>constant</td>
1925 * </tr>
1926 *
1927 *
1928 * <tr valign="top">
1929 * <td>0</td>
1930 * <td>
1931 * RegexIterator::MATCH
1932 * </td>
1933 * </tr>
1934 * <tr valign="top">
1935 * <td>1</td>
1936 * <td>
1937 * RegexIterator::GET_MATCH
1938 * </td>
1939 * </tr>
1940 * <tr valign="top">
1941 * <td>2</td>
1942 * <td>
1943 * RegexIterator::ALL_MATCHES
1944 * </td>
1945 * </tr>
1946 * <tr valign="top">
1947 * <td>3</td>
1948 * <td>
1949 * RegexIterator::SPLIT
1950 * </td>
1951 * </tr>
1952 * <tr valign="top">
1953 * <td>4</td>
1954 * <td>
1955 * RegexIterator::REPLACE
1956 * </td>
1957 * </tr>
1958 *
1959 *
1960 * </table>
1961 * </p>
1962 * @return void
1963 */
1964 public function setMode ($mode) {}
1965
1966 /**
1967 * Get flags
1968 * @link http://www.php.net/manual/en/regexiterator.getflags.php
1969 * @return int the set flags.
1970 */
1971 public function getFlags () {}
1972
1973 /**
1974 * Sets the flags.
1975 * @link http://www.php.net/manual/en/regexiterator.setflags.php
1976 * @param flags int <p>
1977 * The flags to set, a bitmask of class constants.
1978 * </p>
1979 * <p>
1980 * The available flags are listed below. The actual
1981 * meanings of these flags are described in the
1982 * predefined constants.
1983 * <table>
1984 * RegexIterator flags
1985 *
1986 *
1987 * <tr valign="top">
1988 * <td>value</td>
1989 * <td>constant</td>
1990 * </tr>
1991 *
1992 *
1993 * <tr valign="top">
1994 * <td>1</td>
1995 * <td>
1996 * RegexIterator::USE_KEY
1997 * </td>
1998 * </tr>
1999 *
2000 *
2001 * </table>
2002 * </p>
2003 * @return void
2004 */
2005 public function setFlags ($flags) {}
2006
2007 /**
2008 * Returns the regular expression flags.
2009 * @link http://www.php.net/manual/en/regexiterator.getpregflags.php
2010 * @return int a bitmask of the regular expression flags.
2011 */
2012 public function getPregFlags () {}
2013
2014 /**
2015 * Sets the regular expression flags.
2016 * @link http://www.php.net/manual/en/regexiterator.setpregflags.php
2017 * @param preg_flags int <p>
2018 * The regular expression flags. See RegexIterator::__construct
2019 * for an overview of available flags.
2020 * </p>
2021 * @return void
2022 */
2023 public function setPregFlags ($preg_flags) {}
2024
2025 /**
2026 * Returns current regular expression
2027 * @link http://www.php.net/manual/en/regexiterator.getregex.php
2028 * @return string
2029 */
2030 public function getRegex () {}
2031
2032 /**
2033 * Rewind the iterator
2034 * @link http://www.php.net/manual/en/filteriterator.rewind.php
2035 * @return void
2036 */
2037 public function rewind () {}
2038
2039 /**
2040 * Check whether the current element is valid
2041 * @link http://www.php.net/manual/en/filteriterator.valid.php
2042 * @return bool true if the current element is valid, otherwise false
2043 */
2044 public function valid () {}
2045
2046 /**
2047 * Get the current key
2048 * @link http://www.php.net/manual/en/filteriterator.key.php
2049 * @return mixed The current key.
2050 */
2051 public function key () {}
2052
2053 /**
2054 * Get the current element value
2055 * @link http://www.php.net/manual/en/filteriterator.current.php
2056 * @return mixed The current element value.
2057 */
2058 public function current () {}
2059
2060 /**
2061 * Move the iterator forward
2062 * @link http://www.php.net/manual/en/filteriterator.next.php
2063 * @return void
2064 */
2065 public function next () {}
2066
2067 /**
2068 * Get the inner iterator
2069 * @link http://www.php.net/manual/en/filteriterator.getinneriterator.php
2070 * @return Iterator The inner iterator.
2071 */
2072 public function getInnerIterator () {}
2073
2074 }
2075
2076 class EmptyIterator implements Iterator, Traversable {
2077
2078 /**
2079 * The rewind() method
2080 * @link http://www.php.net/manual/en/emptyiterator.rewind.php
2081 * @return void
2082 */
2083 public function rewind () {}
2084
2085 /**
2086 * The valid() method
2087 * @link http://www.php.net/manual/en/emptyiterator.valid.php
2088 * @return void false
2089 */
2090 public function valid () {}
2091
2092 /**
2093 * The key() method
2094 * @link http://www.php.net/manual/en/emptyiterator.key.php
2095 * @return void
2096 */
2097 public function key () {}
2098
2099 /**
2100 * The current() method
2101 * @link http://www.php.net/manual/en/emptyiterator.current.php
2102 * @return void
2103 */
2104 public function current () {}
2105
2106 /**
2107 * The next() method
2108 * @link http://www.php.net/manual/en/emptyiterator.next.php
2109 * @return void
2110 */
2111 public function next () {}
2112
2113 }
2114
2115 class RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator, Traversable, Iterator {
2116 const LEAVES_ONLY = 0;
2117 const SELF_FIRST = 1;
2118 const CHILD_FIRST = 2;
2119 const CATCH_GET_CHILD = 16;
2120 const BYPASS_CURRENT = 4;
2121 const BYPASS_KEY = 8;
2122 const PREFIX_LEFT = 0;
2123 const PREFIX_MID_HAS_NEXT = 1;
2124 const PREFIX_MID_LAST = 2;
2125 const PREFIX_END_HAS_NEXT = 3;
2126 const PREFIX_END_LAST = 4;
2127 const PREFIX_RIGHT = 5;
2128
2129
2130 /**
2131 * Construct a RecursiveTreeIterator
2132 * @link http://www.php.net/manual/en/recursivetreeiterator.construct.php
2133 * @param iterator Traversable
2134 * @param flags[optional]
2135 * @param caching_it_flags[optional]
2136 * @param mode[optional]
2137 */
2138 public function __construct (Traversable $iterator, $flags, $caching_it_flags, $mode) {}
2139
2140 /**
2141 * Rewind iterator
2142 * @link http://www.php.net/manual/en/recursivetreeiterator.rewind.php
2143 * @return void
2144 */
2145 public function rewind () {}
2146
2147 /**
2148 * Check validity
2149 * @link http://www.php.net/manual/en/recursivetreeiterator.valid.php
2150 * @return bool true if the current position is valid, otherwise false
2151 */
2152 public function valid () {}
2153
2154 /**
2155 * Get the key of the current element
2156 * @link http://www.php.net/manual/en/recursivetreeiterator.key.php
2157 * @return string the current key prefixed and postfixed.
2158 */
2159 public function key () {}
2160
2161 /**
2162 * Get current element
2163 * @link http://www.php.net/manual/en/recursivetreeiterator.current.php
2164 * @return string the current element prefixed and postfixed.
2165 */
2166 public function current () {}
2167
2168 /**
2169 * Move to next element
2170 * @link http://www.php.net/manual/en/recursivetreeiterator.next.php
2171 * @return void
2172 */
2173 public function next () {}
2174
2175 /**
2176 * Begin iteration
2177 * @link http://www.php.net/manual/en/recursivetreeiterator.beginiteration.php
2178 * @return RecursiveIterator A RecursiveIterator.
2179 */
2180 public function beginIteration () {}
2181
2182 /**
2183 * End iteration
2184 * @link http://www.php.net/manual/en/recursivetreeiterator.enditeration.php
2185 * @return void
2186 */
2187 public function endIteration () {}
2188
2189 /**
2190 * Has children
2191 * @link http://www.php.net/manual/en/recursivetreeiterator.callhaschildren.php
2192 * @return bool true if there are children, otherwise false
2193 */
2194 public function callHasChildren () {}
2195
2196 /**
2197 * Get children
2198 * @link http://www.php.net/manual/en/recursivetreeiterator.callgetchildren.php
2199 * @return RecursiveIterator A RecursiveIterator.
2200 */
2201 public function callGetChildren () {}
2202
2203 /**
2204 * Begin children
2205 * @link http://www.php.net/manual/en/recursivetreeiterator.beginchildren.php
2206 * @return void
2207 */
2208 public function beginChildren () {}
2209
2210 /**
2211 * End children
2212 * @link http://www.php.net/manual/en/recursivetreeiterator.endchildren.php
2213 * @return void
2214 */
2215 public function endChildren () {}
2216
2217 /**
2218 * Next element
2219 * @link http://www.php.net/manual/en/recursivetreeiterator.nextelement.php
2220 * @return void
2221 */
2222 public function nextElement () {}
2223
2224 /**
2225 * Get the prefix
2226 * @link http://www.php.net/manual/en/recursivetreeiterator.getprefix.php
2227 * @return string the string to place in front of current element
2228 */
2229 public function getPrefix () {}
2230
2231 /**
2232 * Set a part of the prefix
2233 * @link http://www.php.net/manual/en/recursivetreeiterator.setprefixpart.php
2234 * @param part int <p>
2235 * One of the RecursiveTreeIterator::PREFIX_* constants.
2236 * </p>
2237 * @param value string <p>
2238 * The value to assign to the part of the prefix specified in part.
2239 * </p>
2240 * @return void
2241 */
2242 public function setPrefixPart ($part, $value) {}
2243
2244 /**
2245 * Get current entry
2246 * @link http://www.php.net/manual/en/recursivetreeiterator.getentry.php
2247 * @return string the part of the tree built for the current element.
2248 */
2249 public function getEntry () {}
2250
2251 public function setPostfix () {}
2252
2253 /**
2254 * Get the postfix
2255 * @link http://www.php.net/manual/en/recursivetreeiterator.getpostfix.php
2256 * @return void the string to place after the current element.
2257 */
2258 public function getPostfix () {}
2259
2260 /**
2261 * Get the current depth of the recursive iteration
2262 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getdepth.php
2263 * @return int The current depth of the recursive iteration.
2264 */
2265 public function getDepth () {}
2266
2267 /**
2268 * The current active sub iterator
2269 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getsubiterator.php
2270 * @param level int[optional] <p>
2271 *
2272 * </p>
2273 * @return RecursiveIterator The current active sub iterator.
2274 */
2275 public function getSubIterator ($level = null) {}
2276
2277 /**
2278 * Get inner iterator
2279 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getinneriterator.php
2280 * @return iterator The current active sub iterator.
2281 */
2282 public function getInnerIterator () {}
2283
2284 /**
2285 * Set max depth
2286 * @link http://www.php.net/manual/en/recursiveiteratoriterator.setmaxdepth.php
2287 * @param max_depth string[optional] <p>
2288 * The maximum allowed depth. -1 is used
2289 * for any depth.
2290 * </p>
2291 * @return void
2292 */
2293 public function setMaxDepth ($max_depth = null) {}
2294
2295 /**
2296 * Get max depth
2297 * @link http://www.php.net/manual/en/recursiveiteratoriterator.getmaxdepth.php
2298 * @return mixed The maximum accepted depth, or false if any depth is allowed.
2299 */
2300 public function getMaxDepth () {}
2301
2302 }
2303
2304 class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable {
2305 const STD_PROP_LIST = 1;
2306 const ARRAY_AS_PROPS = 2;
2307
2308
2309 /**
2310 * Construct a new array object
2311 * @link http://www.php.net/manual/en/arrayobject.construct.php
2312 * @param array
2313 */
2314 public function __construct ($array) {}
2315
2316 /**
2317 * Returns whether the requested index exists
2318 * @link http://www.php.net/manual/en/arrayobject.offsetexists.php
2319 * @param index mixed <p>
2320 * The index being checked.
2321 * </p>
2322 * @return bool true if the requested index exists, otherwise false
2323 */
2324 public function offsetExists ($index) {}
2325
2326 /**
2327 * Returns the value at the specified index
2328 * @link http://www.php.net/manual/en/arrayobject.offsetget.php
2329 * @param index mixed <p>
2330 * The index with the value.
2331 * </p>
2332 * @return mixed The value at the specified index or &null;.
2333 */
2334 public function offsetGet ($index) {}
2335
2336 /**
2337 * Sets the value at the specified index to newval
2338 * @link http://www.php.net/manual/en/arrayobject.offsetset.php
2339 * @param index mixed <p>
2340 * The index being set.
2341 * </p>
2342 * @param newval mixed <p>
2343 * The new value for the index.
2344 * </p>
2345 * @return void
2346 */
2347 public function offsetSet ($index, $newval) {}
2348
2349 /**
2350 * Unsets the value at the specified index
2351 * @link http://www.php.net/manual/en/arrayobject.offsetunset.php
2352 * @param index mixed <p>
2353 * The index being unset.
2354 * </p>
2355 * @return void
2356 */
2357 public function offsetUnset ($index) {}
2358
2359 /**
2360 * Appends the value
2361 * @link http://www.php.net/manual/en/arrayobject.append.php
2362 * @param value mixed <p>
2363 * The value being appended.
2364 * </p>
2365 * @return void
2366 */
2367 public function append ($value) {}
2368
2369 /**
2370 * Creates a copy of the ArrayObject.
2371 * @link http://www.php.net/manual/en/arrayobject.getarraycopy.php
2372 * @return array a copy of the array. When the ArrayObject refers to an object
2373 * an array of the public properties of that object will be returned.
2374 */
2375 public function getArrayCopy () {}
2376
2377 /**
2378 * Get the number of public properties in the ArrayObject
2379 * @link http://www.php.net/manual/en/arrayobject.count.php
2380 * @return int The number of public properties in the ArrayObject.
2381 * </p>
2382 *
2383 * <p>
2384 * When the ArrayObject is constructed from an array all properties are public.
2385 */
2386 public function count () {}
2387
2388 /**
2389 * Gets the behavior flags.
2390 * @link http://www.php.net/manual/en/arrayobject.getflags.php
2391 * @return int the behavior flags of the ArrayObject.
2392 */
2393 public function getFlags () {}
2394
2395 /**
2396 * Sets the behavior flags.
2397 * @link http://www.php.net/manual/en/arrayobject.setflags.php
2398 * @param flags int <p>
2399 * The new ArrayObject behavior.
2400 * It takes on either a bitmask, or named constants. Using named
2401 * constants is strongly encouraged to ensure compatibility for future
2402 * versions.
2403 * </p>
2404 * <p>
2405 * The available behavior flags are listed below. The actual
2406 * meanings of these flags are described in the
2407 * predefined constants.
2408 * <table>
2409 * ArrayObject behavior flags
2410 *
2411 *
2412 * <tr valign="top">
2413 * <td>value</td>
2414 * <td>constant</td>
2415 * </tr>
2416 *
2417 *
2418 * <tr valign="top">
2419 * <td>1</td>
2420 * <td>
2421 * ArrayObject::STD_PROP_LIST
2422 * </td>
2423 * </tr>
2424 * <tr valign="top">
2425 * <td>2</td>
2426 * <td>
2427 * ArrayObject::ARRAY_AS_PROPS
2428 * </td>
2429 * </tr>
2430 *
2431 *
2432 * </table>
2433 * </p>
2434 * @return void
2435 */
2436 public function setFlags ($flags) {}
2437
2438 /**
2439 * Sort the entries by value
2440 * @link http://www.php.net/manual/en/arrayobject.asort.php
2441 * @return void
2442 */
2443 public function asort () {}
2444
2445 /**
2446 * Sort the entries by key
2447 * @link http://www.php.net/manual/en/arrayobject.ksort.php
2448 * @return void
2449 */
2450 public function ksort () {}
2451
2452 /**
2453 * Sort the entries with a user-defined comparison function and maintain key association
2454 * @link http://www.php.net/manual/en/arrayobject.uasort.php
2455 * @param cmp_function callable <p>
2456 * Function cmp_function should accept two
2457 * parameters which will be filled by pairs of entries.
2458 * The comparison function must return an integer less than, equal
2459 * to, or greater than zero if the first argument is considered to
2460 * be respectively less than, equal to, or greater than the
2461 * second.
2462 * </p>
2463 * @return void
2464 */
2465 public function uasort ($cmp_function) {}
2466
2467 /**
2468 * Sort the entries by keys using a user-defined comparison function
2469 * @link http://www.php.net/manual/en/arrayobject.uksort.php
2470 * @param cmp_function callable <p>
2471 * The callback comparison function.
2472 * </p>
2473 * <p>
2474 * Function cmp_function should accept two
2475 * parameters which will be filled by pairs of entry keys.
2476 * The comparison function must return an integer less than, equal
2477 * to, or greater than zero if the first argument is considered to
2478 * be respectively less than, equal to, or greater than the
2479 * second.
2480 * </p>
2481 * @return void
2482 */
2483 public function uksort ($cmp_function) {}
2484
2485 /**
2486 * Sort entries using a "natural order" algorithm
2487 * @link http://www.php.net/manual/en/arrayobject.natsort.php
2488 * @return void
2489 */
2490 public function natsort () {}
2491
2492 /**
2493 * Sort an array using a case insensitive "natural order" algorithm
2494 * @link http://www.php.net/manual/en/arrayobject.natcasesort.php
2495 * @return void
2496 */
2497 public function natcasesort () {}
2498
2499 /**
2500 * Unserialize an ArrayObject
2501 * @link http://www.php.net/manual/en/arrayobject.unserialize.php
2502 * @param serialized string <p>
2503 * The serialized ArrayObject.
2504 * </p>
2505 * @return void The unserialized ArrayObject.
2506 */
2507 public function unserialize ($serialized) {}
2508
2509 /**
2510 * Serialize an ArrayObject
2511 * @link http://www.php.net/manual/en/arrayobject.serialize.php
2512 * @return string The serialized representation of the ArrayObject.
2513 */
2514 public function serialize () {}
2515
2516 /**
2517 * Create a new iterator from an ArrayObject instance
2518 * @link http://www.php.net/manual/en/arrayobject.getiterator.php
2519 * @return ArrayIterator An iterator from an ArrayObject.
2520 */
2521 public function getIterator () {}
2522
2523 /**
2524 * Exchange the array for another one.
2525 * @link http://www.php.net/manual/en/arrayobject.exchangearray.php
2526 * @param input mixed <p>
2527 * The new array or object to exchange with the current array.
2528 * </p>
2529 * @return array the old array.
2530 */
2531 public function exchangeArray ($input) {}
2532
2533 /**
2534 * Sets the iterator classname for the ArrayObject.
2535 * @link http://www.php.net/manual/en/arrayobject.setiteratorclass.php
2536 * @param iterator_class string <p>
2537 * The classname of the array iterator to use when iterating over this object.
2538 * </p>
2539 * @return void
2540 */
2541 public function setIteratorClass ($iterator_class) {}
2542
2543 /**
2544 * Gets the iterator classname for the ArrayObject.
2545 * @link http://www.php.net/manual/en/arrayobject.getiteratorclass.php
2546 * @return string the iterator class name that is used to iterate over this object.
2547 */
2548 public function getIteratorClass () {}
2549
2550 }
2551
2552 class ArrayIterator implements Iterator, Traversable, ArrayAccess, SeekableIterator, Serializable, Countable {
2553 const STD_PROP_LIST = 1;
2554 const ARRAY_AS_PROPS = 2;
2555
2556
2557 /**
2558 * Construct an ArrayIterator
2559 * @link http://www.php.net/manual/en/arrayiterator.construct.php
2560 * @param array
2561 */
2562 public function __construct ($array) {}
2563
2564 /**
2565 * Check if offset exists
2566 * @link http://www.php.net/manual/en/arrayiterator.offsetexists.php
2567 * @param index string <p>
2568 * The offset being checked.
2569 * </p>
2570 * @return void true if the offset exists, otherwise false
2571 */
2572 public function offsetExists ($index) {}
2573
2574 /**
2575 * Get value for an offset
2576 * @link http://www.php.net/manual/en/arrayiterator.offsetget.php
2577 * @param index string <p>
2578 * The offset to get the value from.
2579 * </p>
2580 * @return mixed The value at offset index.
2581 */
2582 public function offsetGet ($index) {}
2583
2584 /**
2585 * Set value for an offset
2586 * @link http://www.php.net/manual/en/arrayiterator.offsetset.php
2587 * @param index string <p>
2588 * The index to set for.
2589 * </p>
2590 * @param newval string <p>
2591 * The new value to store at the index.
2592 * </p>
2593 * @return void
2594 */
2595 public function offsetSet ($index, $newval) {}
2596
2597 /**
2598 * Unset value for an offset
2599 * @link http://www.php.net/manual/en/arrayiterator.offsetunset.php
2600 * @param index string <p>
2601 * The offset to unset.
2602 * </p>
2603 * @return void
2604 */
2605 public function offsetUnset ($index) {}
2606
2607 /**
2608 * Append an element
2609 * @link http://www.php.net/manual/en/arrayiterator.append.php
2610 * @param value mixed <p>
2611 * The value to append.
2612 * </p>
2613 * @return void
2614 */
2615 public function append ($value) {}
2616
2617 /**
2618 * Get array copy
2619 * @link http://www.php.net/manual/en/arrayiterator.getarraycopy.php
2620 * @return array A copy of the array, or array of public properties
2621 * if ArrayIterator refers to an object.
2622 */
2623 public function getArrayCopy () {}
2624
2625 /**
2626 * Count elements
2627 * @link http://www.php.net/manual/en/arrayiterator.count.php
2628 * @return int The number of elements or public properties in the associated
2629 * array or object, respectively.
2630 */
2631 public function count () {}
2632
2633 /**
2634 * Get flags
2635 * @link http://www.php.net/manual/en/arrayiterator.getflags.php
2636 * @return void The current flags.
2637 */
2638 public function getFlags () {}
2639
2640 /**
2641 * Set behaviour flags
2642 * @link http://www.php.net/manual/en/arrayiterator.setflags.php
2643 * @param flags string <p>
2644 * A bitmask as follows:
2645 *
2646 *
2647 * 0 = Properties of the object have their normal functionality
2648 * when accessed as list (var_dump, foreach, etc.).
2649 *
2650 *
2651 * 1 = Array indices can be accessed as properties in read/write.
2652 *
2653 *
2654 * </p>
2655 * @return void
2656 */
2657 public function setFlags ($flags) {}
2658
2659 /**
2660 * Sort array by values
2661 * @link http://www.php.net/manual/en/arrayiterator.asort.php
2662 * @return void
2663 */
2664 public function asort () {}
2665
2666 /**
2667 * Sort array by keys
2668 * @link http://www.php.net/manual/en/arrayiterator.ksort.php
2669 * @return void
2670 */
2671 public function ksort () {}
2672
2673 /**
2674 * User defined sort
2675 * @link http://www.php.net/manual/en/arrayiterator.uasort.php
2676 * @param cmp_function string <p>
2677 * The compare function used for the sort.
2678 * </p>
2679 * @return void
2680 */
2681 public function uasort ($cmp_function) {}
2682
2683 /**
2684 * User defined sort
2685 * @link http://www.php.net/manual/en/arrayiterator.uksort.php
2686 * @param cmp_function string <p>
2687 * The compare function used for the sort.
2688 * </p>
2689 * @return void
2690 */
2691 public function uksort ($cmp_function) {}
2692
2693 /**
2694 * Sort an array naturally
2695 * @link http://www.php.net/manual/en/arrayiterator.natsort.php
2696 * @return void
2697 */
2698 public function natsort () {}
2699
2700 /**
2701 * Sort an array naturally, case insensitive
2702 * @link http://www.php.net/manual/en/arrayiterator.natcasesort.php
2703 * @return void
2704 */
2705 public function natcasesort () {}
2706
2707 /**
2708 * Unserialize
2709 * @link http://www.php.net/manual/en/arrayiterator.unserialize.php
2710 * @param serialized string <p>
2711 * The serialized ArrayIterator object to be unserialized.
2712 * </p>
2713 * @return string The ArrayIterator.
2714 */
2715 public function unserialize ($serialized) {}
2716
2717 /**
2718 * Serialize
2719 * @link http://www.php.net/manual/en/arrayiterator.serialize.php
2720 * @return string The serialized ArrayIterator.
2721 */
2722 public function serialize () {}
2723
2724 /**
2725 * Rewind array back to the start
2726 * @link http://www.php.net/manual/en/arrayiterator.rewind.php
2727 * @return void
2728 */
2729 public function rewind () {}
2730
2731 /**
2732 * Return current array entry
2733 * @link http://www.php.net/manual/en/arrayiterator.current.php
2734 * @return mixed The current array entry.
2735 */
2736 public function current () {}
2737
2738 /**
2739 * Return current array key
2740 * @link http://www.php.net/manual/en/arrayiterator.key.php
2741 * @return mixed The current array key.
2742 */
2743 public function key () {}
2744
2745 /**
2746 * Move to next entry
2747 * @link http://www.php.net/manual/en/arrayiterator.next.php
2748 * @return void
2749 */
2750 public function next () {}
2751
2752 /**
2753 * Check whether array contains more entries
2754 * @link http://www.php.net/manual/en/arrayiterator.valid.php
2755 * @return bool
2756 */
2757 public function valid () {}
2758
2759 /**
2760 * Seek to position
2761 * @link http://www.php.net/manual/en/arrayiterator.seek.php
2762 * @param position int <p>
2763 * The position to seek to.
2764 * </p>
2765 * @return void
2766 */
2767 public function seek ($position) {}
2768
2769 }
2770
2771 class RecursiveArrayIterator extends ArrayIterator implements Countable, Serializable, SeekableIterator, ArrayAccess, Traversable, Iterator, RecursiveIterator {
2772 const CHILD_ARRAYS_ONLY = 4;
2773
2774
2775 /**
2776 * Returns whether current entry is an array or an object.
2777 * @link http://www.php.net/manual/en/recursivearrayiterator.haschildren.php
2778 * @return bool true if the current entry is an array or an object,
2779 * otherwise false is returned.
2780 */
2781 public function hasChildren () {}
2782
2783 /**
2784 * Returns an iterator for the current entry if it is an <type>array</type> or an <type>object</type>.
2785 * @link http://www.php.net/manual/en/recursivearrayiterator.getchildren.php
2786 * @return RecursiveArrayIterator An iterator for the current entry, if it is an array or object.
2787 */
2788 public function getChildren () {}
2789
2790 /**
2791 * Construct an ArrayIterator
2792 * @link http://www.php.net/manual/en/arrayiterator.construct.php
2793 * @param array
2794 */
2795 public function __construct ($array) {}
2796
2797 /**
2798 * Check if offset exists
2799 * @link http://www.php.net/manual/en/arrayiterator.offsetexists.php
2800 * @param index string <p>
2801 * The offset being checked.
2802 * </p>
2803 * @return void true if the offset exists, otherwise false
2804 */
2805 public function offsetExists ($index) {}
2806
2807 /**
2808 * Get value for an offset
2809 * @link http://www.php.net/manual/en/arrayiterator.offsetget.php
2810 * @param index string <p>
2811 * The offset to get the value from.
2812 * </p>
2813 * @return mixed The value at offset index.
2814 */
2815 public function offsetGet ($index) {}
2816
2817 /**
2818 * Set value for an offset
2819 * @link http://www.php.net/manual/en/arrayiterator.offsetset.php
2820 * @param index string <p>
2821 * The index to set for.
2822 * </p>
2823 * @param newval string <p>
2824 * The new value to store at the index.
2825 * </p>
2826 * @return void
2827 */
2828 public function offsetSet ($index, $newval) {}
2829
2830 /**
2831 * Unset value for an offset
2832 * @link http://www.php.net/manual/en/arrayiterator.offsetunset.php
2833 * @param index string <p>
2834 * The offset to unset.
2835 * </p>
2836 * @return void
2837 */
2838 public function offsetUnset ($index) {}
2839
2840 /**
2841 * Append an element
2842 * @link http://www.php.net/manual/en/arrayiterator.append.php
2843 * @param value mixed <p>
2844 * The value to append.
2845 * </p>
2846 * @return void
2847 */
2848 public function append ($value) {}
2849
2850 /**
2851 * Get array copy
2852 * @link http://www.php.net/manual/en/arrayiterator.getarraycopy.php
2853 * @return array A copy of the array, or array of public properties
2854 * if ArrayIterator refers to an object.
2855 */
2856 public function getArrayCopy () {}
2857
2858 /**
2859 * Count elements
2860 * @link http://www.php.net/manual/en/arrayiterator.count.php
2861 * @return int The number of elements or public properties in the associated
2862 * array or object, respectively.
2863 */
2864 public function count () {}
2865
2866 /**
2867 * Get flags
2868 * @link http://www.php.net/manual/en/arrayiterator.getflags.php
2869 * @return void The current flags.
2870 */
2871 public function getFlags () {}
2872
2873 /**
2874 * Set behaviour flags
2875 * @link http://www.php.net/manual/en/arrayiterator.setflags.php
2876 * @param flags string <p>
2877 * A bitmask as follows:
2878 *
2879 *
2880 * 0 = Properties of the object have their normal functionality
2881 * when accessed as list (var_dump, foreach, etc.).
2882 *
2883 *
2884 * 1 = Array indices can be accessed as properties in read/write.
2885 *
2886 *
2887 * </p>
2888 * @return void
2889 */
2890 public function setFlags ($flags) {}
2891
2892 /**
2893 * Sort array by values
2894 * @link http://www.php.net/manual/en/arrayiterator.asort.php
2895 * @return void
2896 */
2897 public function asort () {}
2898
2899 /**
2900 * Sort array by keys
2901 * @link http://www.php.net/manual/en/arrayiterator.ksort.php
2902 * @return void
2903 */
2904 public function ksort () {}
2905
2906 /**
2907 * User defined sort
2908 * @link http://www.php.net/manual/en/arrayiterator.uasort.php
2909 * @param cmp_function string <p>
2910 * The compare function used for the sort.
2911 * </p>
2912 * @return void
2913 */
2914 public function uasort ($cmp_function) {}
2915
2916 /**
2917 * User defined sort
2918 * @link http://www.php.net/manual/en/arrayiterator.uksort.php
2919 * @param cmp_function string <p>
2920 * The compare function used for the sort.
2921 * </p>
2922 * @return void
2923 */
2924 public function uksort ($cmp_function) {}
2925
2926 /**
2927 * Sort an array naturally
2928 * @link http://www.php.net/manual/en/arrayiterator.natsort.php
2929 * @return void
2930 */
2931 public function natsort () {}
2932
2933 /**
2934 * Sort an array naturally, case insensitive
2935 * @link http://www.php.net/manual/en/arrayiterator.natcasesort.php
2936 * @return void
2937 */
2938 public function natcasesort () {}
2939
2940 /**
2941 * Unserialize
2942 * @link http://www.php.net/manual/en/arrayiterator.unserialize.php
2943 * @param serialized string <p>
2944 * The serialized ArrayIterator object to be unserialized.
2945 * </p>
2946 * @return string The ArrayIterator.
2947 */
2948 public function unserialize ($serialized) {}
2949
2950 /**
2951 * Serialize
2952 * @link http://www.php.net/manual/en/arrayiterator.serialize.php
2953 * @return string The serialized ArrayIterator.
2954 */
2955 public function serialize () {}
2956
2957 /**
2958 * Rewind array back to the start
2959 * @link http://www.php.net/manual/en/arrayiterator.rewind.php
2960 * @return void
2961 */
2962 public function rewind () {}
2963
2964 /**
2965 * Return current array entry
2966 * @link http://www.php.net/manual/en/arrayiterator.current.php
2967 * @return mixed The current array entry.
2968 */
2969 public function current () {}
2970
2971 /**
2972 * Return current array key
2973 * @link http://www.php.net/manual/en/arrayiterator.key.php
2974 * @return mixed The current array key.
2975 */
2976 public function key () {}
2977
2978 /**
2979 * Move to next entry
2980 * @link http://www.php.net/manual/en/arrayiterator.next.php
2981 * @return void
2982 */
2983 public function next () {}
2984
2985 /**
2986 * Check whether array contains more entries
2987 * @link http://www.php.net/manual/en/arrayiterator.valid.php
2988 * @return bool
2989 */
2990 public function valid () {}
2991
2992 /**
2993 * Seek to position
2994 * @link http://www.php.net/manual/en/arrayiterator.seek.php
2995 * @param position int <p>
2996 * The position to seek to.
2997 * </p>
2998 * @return void
2999 */
3000 public function seek ($position) {}
3001
3002 }
3003
3004 class SplFileInfo {
3005
3006 /**
3007 * Construct a new SplFileInfo object
3008 * @link http://www.php.net/manual/en/splfileinfo.construct.php
3009 * @param file_name
3010 */
3011 public function __construct ($file_name) {}
3012
3013 /**
3014 * Gets the path without filename
3015 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
3016 * @return string the path to the file.
3017 */
3018 public function getPath () {}
3019
3020 /**
3021 * Gets the filename
3022 * @link http://www.php.net/manual/en/splfileinfo.getfilename.php
3023 * @return string The filename.
3024 */
3025 public function getFilename () {}
3026
3027 /**
3028 * Gets the file extension
3029 * @link http://www.php.net/manual/en/splfileinfo.getextension.php
3030 * @return string a string containing the file extension, or an
3031 * empty string if the file has no extension.
3032 */
3033 public function getExtension () {}
3034
3035 /**
3036 * Gets the base name of the file
3037 * @link http://www.php.net/manual/en/splfileinfo.getbasename.php
3038 * @param suffix string[optional] <p>
3039 * Optional suffix to omit from the base name returned.
3040 * </p>
3041 * @return string the base name without path information.
3042 */
3043 public function getBasename ($suffix = null) {}
3044
3045 /**
3046 * Gets the path to the file
3047 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
3048 * @return string The path to the file.
3049 */
3050 public function getPathname () {}
3051
3052 /**
3053 * Gets file permissions
3054 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
3055 * @return int the file permissions.
3056 */
3057 public function getPerms () {}
3058
3059 /**
3060 * Gets the inode for the file
3061 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
3062 * @return int the inode number for the filesystem object.
3063 */
3064 public function getInode () {}
3065
3066 /**
3067 * Gets file size
3068 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
3069 * @return int The filesize in bytes.
3070 */
3071 public function getSize () {}
3072
3073 /**
3074 * Gets the owner of the file
3075 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
3076 * @return int The owner id in numerical format.
3077 */
3078 public function getOwner () {}
3079
3080 /**
3081 * Gets the file group
3082 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
3083 * @return int The group id in numerical format.
3084 */
3085 public function getGroup () {}
3086
3087 /**
3088 * Gets last access time of the file
3089 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
3090 * @return int the time the file was last accessed.
3091 */
3092 public function getATime () {}
3093
3094 /**
3095 * Gets the last modified time
3096 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
3097 * @return int the last modified time for the file, in a Unix timestamp.
3098 */
3099 public function getMTime () {}
3100
3101 /**
3102 * Gets the inode change time
3103 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
3104 * @return int The last change time, in a Unix timestamp.
3105 */
3106 public function getCTime () {}
3107
3108 /**
3109 * Gets file type
3110 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
3111 * @return string A string representing the type of the entry.
3112 * May be one of file, link,
3113 * or dir
3114 */
3115 public function getType () {}
3116
3117 /**
3118 * Tells if the entry is writable
3119 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
3120 * @return bool true if writable, false otherwise;
3121 */
3122 public function isWritable () {}
3123
3124 /**
3125 * Tells if file is readable
3126 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
3127 * @return bool true if readable, false otherwise.
3128 */
3129 public function isReadable () {}
3130
3131 /**
3132 * Tells if the file is executable
3133 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
3134 * @return bool true if executable, false otherwise.
3135 */
3136 public function isExecutable () {}
3137
3138 /**
3139 * Tells if the object references a regular file
3140 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
3141 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
3142 */
3143 public function isFile () {}
3144
3145 /**
3146 * Tells if the file is a directory
3147 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
3148 * @return bool true if a directory, false otherwise.
3149 */
3150 public function isDir () {}
3151
3152 /**
3153 * Tells if the file is a link
3154 * @link http://www.php.net/manual/en/splfileinfo.islink.php
3155 * @return bool true if the file is a link, false otherwise.
3156 */
3157 public function isLink () {}
3158
3159 /**
3160 * Gets the target of a link
3161 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
3162 * @return string the target of the filesystem link.
3163 */
3164 public function getLinkTarget () {}
3165
3166 /**
3167 * Gets absolute path to file
3168 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
3169 * @return string the path to the file.
3170 */
3171 public function getRealPath () {}
3172
3173 /**
3174 * Gets an SplFileInfo object for the file
3175 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
3176 * @param class_name string[optional] <p>
3177 * Name of an SplFileInfo derived class to use.
3178 * </p>
3179 * @return SplFileInfo An SplFileInfo object created for the file.
3180 */
3181 public function getFileInfo ($class_name = null) {}
3182
3183 /**
3184 * Gets an SplFileInfo object for the path
3185 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
3186 * @param class_name string[optional] <p>
3187 * Name of an SplFileInfo derived class to use.
3188 * </p>
3189 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
3190 */
3191 public function getPathInfo ($class_name = null) {}
3192
3193 /**
3194 * Gets an SplFileObject object for the file
3195 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
3196 * @param open_mode string[optional] <p>
3197 * The mode for opening the file. See the fopen
3198 * documentation for descriptions of possible modes. The default
3199 * is read only.
3200 * </p>
3201 * @param use_include_path bool[optional] <p>
3202 * &parameter.use_include_path;
3203 * </p>
3204 * @param context resource[optional] <p>
3205 * &parameter.context;
3206 * </p>
3207 * @return SplFileObject The opened file as an SplFileObject object.
3208 */
3209 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
3210
3211 /**
3212 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
3213 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
3214 * @param class_name string[optional] <p>
3215 * The class name to use when openFile() is called.
3216 * </p>
3217 * @return void
3218 */
3219 public function setFileClass ($class_name = null) {}
3220
3221 /**
3222 * Sets the class used with getFileInfo and getPathInfo
3223 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
3224 * @param class_name string[optional] <p>
3225 * The class name to use.
3226 * </p>
3227 * @return void
3228 */
3229 public function setInfoClass ($class_name = null) {}
3230
3231 final public function _bad_state_ex () {}
3232
3233 /**
3234 * Returns the path to the file as a string
3235 * @link http://www.php.net/manual/en/splfileinfo.tostring.php
3236 * @return void the path to the file.
3237 */
3238 public function __toString () {}
3239
3240 }
3241
3242 class DirectoryIterator extends SplFileInfo implements Iterator, Traversable, SeekableIterator {
3243
3244 /**
3245 * Constructs a new directory iterator from a path
3246 * @link http://www.php.net/manual/en/directoryiterator.construct.php
3247 * @param path
3248 */
3249 public function __construct ($path) {}
3250
3251 /**
3252 * Return file name of current DirectoryIterator item.
3253 * @link http://www.php.net/manual/en/directoryiterator.getfilename.php
3254 * @return string the file name of the current DirectoryIterator item.
3255 */
3256 public function getFilename () {}
3257
3258 /**
3259 * Gets the file extension
3260 * @link http://www.php.net/manual/en/directoryiterator.getextension.php
3261 * @return string a string containing the file extension, or an
3262 * empty string if the file has no extension.
3263 */
3264 public function getExtension () {}
3265
3266 /**
3267 * Get base name of current DirectoryIterator item.
3268 * @link http://www.php.net/manual/en/directoryiterator.getbasename.php
3269 * @param suffix string[optional] <p>
3270 * If the base name ends in suffix,
3271 * this will be cut.
3272 * </p>
3273 * @return string The base name of the current DirectoryIterator item.
3274 */
3275 public function getBasename ($suffix = null) {}
3276
3277 /**
3278 * Determine if current DirectoryIterator item is '.' or '..'
3279 * @link http://www.php.net/manual/en/directoryiterator.isdot.php
3280 * @return bool true if the entry is . or ..,
3281 * otherwise false
3282 */
3283 public function isDot () {}
3284
3285 /**
3286 * Rewind the DirectoryIterator back to the start
3287 * @link http://www.php.net/manual/en/directoryiterator.rewind.php
3288 * @return void
3289 */
3290 public function rewind () {}
3291
3292 /**
3293 * Check whether current DirectoryIterator position is a valid file
3294 * @link http://www.php.net/manual/en/directoryiterator.valid.php
3295 * @return bool true if the position is valid, otherwise false
3296 */
3297 public function valid () {}
3298
3299 /**
3300 * Return the key for the current DirectoryIterator item
3301 * @link http://www.php.net/manual/en/directoryiterator.key.php
3302 * @return string The key for the current DirectoryIterator item.
3303 */
3304 public function key () {}
3305
3306 /**
3307 * Return the current DirectoryIterator item.
3308 * @link http://www.php.net/manual/en/directoryiterator.current.php
3309 * @return DirectoryIterator The current DirectoryIterator item.
3310 */
3311 public function current () {}
3312
3313 /**
3314 * Move forward to next DirectoryIterator item
3315 * @link http://www.php.net/manual/en/directoryiterator.next.php
3316 * @return void
3317 */
3318 public function next () {}
3319
3320 /**
3321 * Seek to a DirectoryIterator item
3322 * @link http://www.php.net/manual/en/directoryiterator.seek.php
3323 * @param position int <p>
3324 * The zero-based numeric position to seek to.
3325 * </p>
3326 * @return void
3327 */
3328 public function seek ($position) {}
3329
3330 /**
3331 * Get file name as a string
3332 * @link http://www.php.net/manual/en/directoryiterator.tostring.php
3333 * @return string the file name of the current DirectoryIterator item.
3334 */
3335 public function __toString () {}
3336
3337 /**
3338 * Gets the path without filename
3339 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
3340 * @return string the path to the file.
3341 */
3342 public function getPath () {}
3343
3344 /**
3345 * Gets the path to the file
3346 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
3347 * @return string The path to the file.
3348 */
3349 public function getPathname () {}
3350
3351 /**
3352 * Gets file permissions
3353 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
3354 * @return int the file permissions.
3355 */
3356 public function getPerms () {}
3357
3358 /**
3359 * Gets the inode for the file
3360 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
3361 * @return int the inode number for the filesystem object.
3362 */
3363 public function getInode () {}
3364
3365 /**
3366 * Gets file size
3367 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
3368 * @return int The filesize in bytes.
3369 */
3370 public function getSize () {}
3371
3372 /**
3373 * Gets the owner of the file
3374 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
3375 * @return int The owner id in numerical format.
3376 */
3377 public function getOwner () {}
3378
3379 /**
3380 * Gets the file group
3381 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
3382 * @return int The group id in numerical format.
3383 */
3384 public function getGroup () {}
3385
3386 /**
3387 * Gets last access time of the file
3388 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
3389 * @return int the time the file was last accessed.
3390 */
3391 public function getATime () {}
3392
3393 /**
3394 * Gets the last modified time
3395 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
3396 * @return int the last modified time for the file, in a Unix timestamp.
3397 */
3398 public function getMTime () {}
3399
3400 /**
3401 * Gets the inode change time
3402 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
3403 * @return int The last change time, in a Unix timestamp.
3404 */
3405 public function getCTime () {}
3406
3407 /**
3408 * Gets file type
3409 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
3410 * @return string A string representing the type of the entry.
3411 * May be one of file, link,
3412 * or dir
3413 */
3414 public function getType () {}
3415
3416 /**
3417 * Tells if the entry is writable
3418 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
3419 * @return bool true if writable, false otherwise;
3420 */
3421 public function isWritable () {}
3422
3423 /**
3424 * Tells if file is readable
3425 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
3426 * @return bool true if readable, false otherwise.
3427 */
3428 public function isReadable () {}
3429
3430 /**
3431 * Tells if the file is executable
3432 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
3433 * @return bool true if executable, false otherwise.
3434 */
3435 public function isExecutable () {}
3436
3437 /**
3438 * Tells if the object references a regular file
3439 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
3440 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
3441 */
3442 public function isFile () {}
3443
3444 /**
3445 * Tells if the file is a directory
3446 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
3447 * @return bool true if a directory, false otherwise.
3448 */
3449 public function isDir () {}
3450
3451 /**
3452 * Tells if the file is a link
3453 * @link http://www.php.net/manual/en/splfileinfo.islink.php
3454 * @return bool true if the file is a link, false otherwise.
3455 */
3456 public function isLink () {}
3457
3458 /**
3459 * Gets the target of a link
3460 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
3461 * @return string the target of the filesystem link.
3462 */
3463 public function getLinkTarget () {}
3464
3465 /**
3466 * Gets absolute path to file
3467 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
3468 * @return string the path to the file.
3469 */
3470 public function getRealPath () {}
3471
3472 /**
3473 * Gets an SplFileInfo object for the file
3474 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
3475 * @param class_name string[optional] <p>
3476 * Name of an SplFileInfo derived class to use.
3477 * </p>
3478 * @return SplFileInfo An SplFileInfo object created for the file.
3479 */
3480 public function getFileInfo ($class_name = null) {}
3481
3482 /**
3483 * Gets an SplFileInfo object for the path
3484 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
3485 * @param class_name string[optional] <p>
3486 * Name of an SplFileInfo derived class to use.
3487 * </p>
3488 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
3489 */
3490 public function getPathInfo ($class_name = null) {}
3491
3492 /**
3493 * Gets an SplFileObject object for the file
3494 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
3495 * @param open_mode string[optional] <p>
3496 * The mode for opening the file. See the fopen
3497 * documentation for descriptions of possible modes. The default
3498 * is read only.
3499 * </p>
3500 * @param use_include_path bool[optional] <p>
3501 * &parameter.use_include_path;
3502 * </p>
3503 * @param context resource[optional] <p>
3504 * &parameter.context;
3505 * </p>
3506 * @return SplFileObject The opened file as an SplFileObject object.
3507 */
3508 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
3509
3510 /**
3511 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
3512 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
3513 * @param class_name string[optional] <p>
3514 * The class name to use when openFile() is called.
3515 * </p>
3516 * @return void
3517 */
3518 public function setFileClass ($class_name = null) {}
3519
3520 /**
3521 * Sets the class used with getFileInfo and getPathInfo
3522 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
3523 * @param class_name string[optional] <p>
3524 * The class name to use.
3525 * </p>
3526 * @return void
3527 */
3528 public function setInfoClass ($class_name = null) {}
3529
3530 final public function _bad_state_ex () {}
3531
3532 }
3533
3534 class FilesystemIterator extends DirectoryIterator implements SeekableIterator, Traversable, Iterator {
3535 const CURRENT_MODE_MASK = 240;
3536 const CURRENT_AS_PATHNAME = 32;
3537 const CURRENT_AS_FILEINFO = 0;
3538 const CURRENT_AS_SELF = 16;
3539 const KEY_MODE_MASK = 3840;
3540 const KEY_AS_PATHNAME = 0;
3541 const FOLLOW_SYMLINKS = 512;
3542 const KEY_AS_FILENAME = 256;
3543 const NEW_CURRENT_AND_KEY = 256;
3544 const OTHER_MODE_MASK = 12288;
3545 const SKIP_DOTS = 4096;
3546 const UNIX_PATHS = 8192;
3547
3548
3549 /**
3550 * Constructs a new filesystem iterator
3551 * @link http://www.php.net/manual/en/filesystemiterator.construct.php
3552 * @param path
3553 * @param flags[optional]
3554 */
3555 public function __construct ($path, $flags) {}
3556
3557 /**
3558 * Rewinds back to the beginning
3559 * @link http://www.php.net/manual/en/filesystemiterator.rewind.php
3560 * @return void
3561 */
3562 public function rewind () {}
3563
3564 /**
3565 * Move to the next file
3566 * @link http://www.php.net/manual/en/filesystemiterator.next.php
3567 * @return void
3568 */
3569 public function next () {}
3570
3571 /**
3572 * Retrieve the key for the current file
3573 * @link http://www.php.net/manual/en/filesystemiterator.key.php
3574 * @return string the pathname or filename depending on the set flags.
3575 * See the FilesystemIterator constants.
3576 */
3577 public function key () {}
3578
3579 /**
3580 * The current file
3581 * @link http://www.php.net/manual/en/filesystemiterator.current.php
3582 * @return mixed The filename, file information, or $this depending on the set flags.
3583 * See the FilesystemIterator constants.
3584 */
3585 public function current () {}
3586
3587 /**
3588 * Get the handling flags
3589 * @link http://www.php.net/manual/en/filesystemiterator.getflags.php
3590 * @return int The integer value of the set flags.
3591 */
3592 public function getFlags () {}
3593
3594 /**
3595 * Sets handling flags
3596 * @link http://www.php.net/manual/en/filesystemiterator.setflags.php
3597 * @param flags int[optional] <p>
3598 * The handling flags to set.
3599 * See the FilesystemIterator constants.
3600 * </p>
3601 * @return void
3602 */
3603 public function setFlags ($flags = null) {}
3604
3605 /**
3606 * Return file name of current DirectoryIterator item.
3607 * @link http://www.php.net/manual/en/directoryiterator.getfilename.php
3608 * @return string the file name of the current DirectoryIterator item.
3609 */
3610 public function getFilename () {}
3611
3612 /**
3613 * Gets the file extension
3614 * @link http://www.php.net/manual/en/directoryiterator.getextension.php
3615 * @return string a string containing the file extension, or an
3616 * empty string if the file has no extension.
3617 */
3618 public function getExtension () {}
3619
3620 /**
3621 * Get base name of current DirectoryIterator item.
3622 * @link http://www.php.net/manual/en/directoryiterator.getbasename.php
3623 * @param suffix string[optional] <p>
3624 * If the base name ends in suffix,
3625 * this will be cut.
3626 * </p>
3627 * @return string The base name of the current DirectoryIterator item.
3628 */
3629 public function getBasename ($suffix = null) {}
3630
3631 /**
3632 * Determine if current DirectoryIterator item is '.' or '..'
3633 * @link http://www.php.net/manual/en/directoryiterator.isdot.php
3634 * @return bool true if the entry is . or ..,
3635 * otherwise false
3636 */
3637 public function isDot () {}
3638
3639 /**
3640 * Check whether current DirectoryIterator position is a valid file
3641 * @link http://www.php.net/manual/en/directoryiterator.valid.php
3642 * @return bool true if the position is valid, otherwise false
3643 */
3644 public function valid () {}
3645
3646 /**
3647 * Seek to a DirectoryIterator item
3648 * @link http://www.php.net/manual/en/directoryiterator.seek.php
3649 * @param position int <p>
3650 * The zero-based numeric position to seek to.
3651 * </p>
3652 * @return void
3653 */
3654 public function seek ($position) {}
3655
3656 /**
3657 * Get file name as a string
3658 * @link http://www.php.net/manual/en/directoryiterator.tostring.php
3659 * @return string the file name of the current DirectoryIterator item.
3660 */
3661 public function __toString () {}
3662
3663 /**
3664 * Gets the path without filename
3665 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
3666 * @return string the path to the file.
3667 */
3668 public function getPath () {}
3669
3670 /**
3671 * Gets the path to the file
3672 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
3673 * @return string The path to the file.
3674 */
3675 public function getPathname () {}
3676
3677 /**
3678 * Gets file permissions
3679 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
3680 * @return int the file permissions.
3681 */
3682 public function getPerms () {}
3683
3684 /**
3685 * Gets the inode for the file
3686 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
3687 * @return int the inode number for the filesystem object.
3688 */
3689 public function getInode () {}
3690
3691 /**
3692 * Gets file size
3693 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
3694 * @return int The filesize in bytes.
3695 */
3696 public function getSize () {}
3697
3698 /**
3699 * Gets the owner of the file
3700 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
3701 * @return int The owner id in numerical format.
3702 */
3703 public function getOwner () {}
3704
3705 /**
3706 * Gets the file group
3707 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
3708 * @return int The group id in numerical format.
3709 */
3710 public function getGroup () {}
3711
3712 /**
3713 * Gets last access time of the file
3714 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
3715 * @return int the time the file was last accessed.
3716 */
3717 public function getATime () {}
3718
3719 /**
3720 * Gets the last modified time
3721 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
3722 * @return int the last modified time for the file, in a Unix timestamp.
3723 */
3724 public function getMTime () {}
3725
3726 /**
3727 * Gets the inode change time
3728 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
3729 * @return int The last change time, in a Unix timestamp.
3730 */
3731 public function getCTime () {}
3732
3733 /**
3734 * Gets file type
3735 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
3736 * @return string A string representing the type of the entry.
3737 * May be one of file, link,
3738 * or dir
3739 */
3740 public function getType () {}
3741
3742 /**
3743 * Tells if the entry is writable
3744 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
3745 * @return bool true if writable, false otherwise;
3746 */
3747 public function isWritable () {}
3748
3749 /**
3750 * Tells if file is readable
3751 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
3752 * @return bool true if readable, false otherwise.
3753 */
3754 public function isReadable () {}
3755
3756 /**
3757 * Tells if the file is executable
3758 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
3759 * @return bool true if executable, false otherwise.
3760 */
3761 public function isExecutable () {}
3762
3763 /**
3764 * Tells if the object references a regular file
3765 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
3766 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
3767 */
3768 public function isFile () {}
3769
3770 /**
3771 * Tells if the file is a directory
3772 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
3773 * @return bool true if a directory, false otherwise.
3774 */
3775 public function isDir () {}
3776
3777 /**
3778 * Tells if the file is a link
3779 * @link http://www.php.net/manual/en/splfileinfo.islink.php
3780 * @return bool true if the file is a link, false otherwise.
3781 */
3782 public function isLink () {}
3783
3784 /**
3785 * Gets the target of a link
3786 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
3787 * @return string the target of the filesystem link.
3788 */
3789 public function getLinkTarget () {}
3790
3791 /**
3792 * Gets absolute path to file
3793 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
3794 * @return string the path to the file.
3795 */
3796 public function getRealPath () {}
3797
3798 /**
3799 * Gets an SplFileInfo object for the file
3800 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
3801 * @param class_name string[optional] <p>
3802 * Name of an SplFileInfo derived class to use.
3803 * </p>
3804 * @return SplFileInfo An SplFileInfo object created for the file.
3805 */
3806 public function getFileInfo ($class_name = null) {}
3807
3808 /**
3809 * Gets an SplFileInfo object for the path
3810 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
3811 * @param class_name string[optional] <p>
3812 * Name of an SplFileInfo derived class to use.
3813 * </p>
3814 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
3815 */
3816 public function getPathInfo ($class_name = null) {}
3817
3818 /**
3819 * Gets an SplFileObject object for the file
3820 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
3821 * @param open_mode string[optional] <p>
3822 * The mode for opening the file. See the fopen
3823 * documentation for descriptions of possible modes. The default
3824 * is read only.
3825 * </p>
3826 * @param use_include_path bool[optional] <p>
3827 * &parameter.use_include_path;
3828 * </p>
3829 * @param context resource[optional] <p>
3830 * &parameter.context;
3831 * </p>
3832 * @return SplFileObject The opened file as an SplFileObject object.
3833 */
3834 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
3835
3836 /**
3837 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
3838 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
3839 * @param class_name string[optional] <p>
3840 * The class name to use when openFile() is called.
3841 * </p>
3842 * @return void
3843 */
3844 public function setFileClass ($class_name = null) {}
3845
3846 /**
3847 * Sets the class used with getFileInfo and getPathInfo
3848 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
3849 * @param class_name string[optional] <p>
3850 * The class name to use.
3851 * </p>
3852 * @return void
3853 */
3854 public function setInfoClass ($class_name = null) {}
3855
3856 final public function _bad_state_ex () {}
3857
3858 }
3859
3860 class RecursiveDirectoryIterator extends FilesystemIterator implements Iterator, Traversable, SeekableIterator, RecursiveIterator {
3861 const CURRENT_MODE_MASK = 240;
3862 const CURRENT_AS_PATHNAME = 32;
3863 const CURRENT_AS_FILEINFO = 0;
3864 const CURRENT_AS_SELF = 16;
3865 const KEY_MODE_MASK = 3840;
3866 const KEY_AS_PATHNAME = 0;
3867 const FOLLOW_SYMLINKS = 512;
3868 const KEY_AS_FILENAME = 256;
3869 const NEW_CURRENT_AND_KEY = 256;
3870 const OTHER_MODE_MASK = 12288;
3871 const SKIP_DOTS = 4096;
3872 const UNIX_PATHS = 8192;
3873
3874
3875 /**
3876 * Constructs a RecursiveDirectoryIterator
3877 * @link http://www.php.net/manual/en/recursivedirectoryiterator.construct.php
3878 * @param path
3879 * @param flags[optional]
3880 */
3881 public function __construct ($path, $flags) {}
3882
3883 /**
3884 * Returns whether current entry is a directory and not '.' or '..'
3885 * @link http://www.php.net/manual/en/recursivedirectoryiterator.haschildren.php
3886 * @param allow_links bool[optional] <p>
3887 *
3888 * </p>
3889 * @return bool whether the current entry is a directory, but not '.' or '..'
3890 */
3891 public function hasChildren ($allow_links = null) {}
3892
3893 /**
3894 * Returns an iterator for the current entry if it is a directory
3895 * @link http://www.php.net/manual/en/recursivedirectoryiterator.getchildren.php
3896 * @return mixed The filename, file information, or $this depending on the set flags.
3897 * See the FilesystemIterator
3898 * constants.
3899 */
3900 public function getChildren () {}
3901
3902 /**
3903 * Get sub path
3904 * @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpath.php
3905 * @return string The sub path (sub directory).
3906 */
3907 public function getSubPath () {}
3908
3909 /**
3910 * Get sub path and name
3911 * @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpathname.php
3912 * @return string The sub path (sub directory) and filename.
3913 */
3914 public function getSubPathname () {}
3915
3916 /**
3917 * Rewinds back to the beginning
3918 * @link http://www.php.net/manual/en/filesystemiterator.rewind.php
3919 * @return void
3920 */
3921 public function rewind () {}
3922
3923 /**
3924 * Move to the next file
3925 * @link http://www.php.net/manual/en/filesystemiterator.next.php
3926 * @return void
3927 */
3928 public function next () {}
3929
3930 /**
3931 * Retrieve the key for the current file
3932 * @link http://www.php.net/manual/en/filesystemiterator.key.php
3933 * @return string the pathname or filename depending on the set flags.
3934 * See the FilesystemIterator constants.
3935 */
3936 public function key () {}
3937
3938 /**
3939 * The current file
3940 * @link http://www.php.net/manual/en/filesystemiterator.current.php
3941 * @return mixed The filename, file information, or $this depending on the set flags.
3942 * See the FilesystemIterator constants.
3943 */
3944 public function current () {}
3945
3946 /**
3947 * Get the handling flags
3948 * @link http://www.php.net/manual/en/filesystemiterator.getflags.php
3949 * @return int The integer value of the set flags.
3950 */
3951 public function getFlags () {}
3952
3953 /**
3954 * Sets handling flags
3955 * @link http://www.php.net/manual/en/filesystemiterator.setflags.php
3956 * @param flags int[optional] <p>
3957 * The handling flags to set.
3958 * See the FilesystemIterator constants.
3959 * </p>
3960 * @return void
3961 */
3962 public function setFlags ($flags = null) {}
3963
3964 /**
3965 * Return file name of current DirectoryIterator item.
3966 * @link http://www.php.net/manual/en/directoryiterator.getfilename.php
3967 * @return string the file name of the current DirectoryIterator item.
3968 */
3969 public function getFilename () {}
3970
3971 /**
3972 * Gets the file extension
3973 * @link http://www.php.net/manual/en/directoryiterator.getextension.php
3974 * @return string a string containing the file extension, or an
3975 * empty string if the file has no extension.
3976 */
3977 public function getExtension () {}
3978
3979 /**
3980 * Get base name of current DirectoryIterator item.
3981 * @link http://www.php.net/manual/en/directoryiterator.getbasename.php
3982 * @param suffix string[optional] <p>
3983 * If the base name ends in suffix,
3984 * this will be cut.
3985 * </p>
3986 * @return string The base name of the current DirectoryIterator item.
3987 */
3988 public function getBasename ($suffix = null) {}
3989
3990 /**
3991 * Determine if current DirectoryIterator item is '.' or '..'
3992 * @link http://www.php.net/manual/en/directoryiterator.isdot.php
3993 * @return bool true if the entry is . or ..,
3994 * otherwise false
3995 */
3996 public function isDot () {}
3997
3998 /**
3999 * Check whether current DirectoryIterator position is a valid file
4000 * @link http://www.php.net/manual/en/directoryiterator.valid.php
4001 * @return bool true if the position is valid, otherwise false
4002 */
4003 public function valid () {}
4004
4005 /**
4006 * Seek to a DirectoryIterator item
4007 * @link http://www.php.net/manual/en/directoryiterator.seek.php
4008 * @param position int <p>
4009 * The zero-based numeric position to seek to.
4010 * </p>
4011 * @return void
4012 */
4013 public function seek ($position) {}
4014
4015 /**
4016 * Get file name as a string
4017 * @link http://www.php.net/manual/en/directoryiterator.tostring.php
4018 * @return string the file name of the current DirectoryIterator item.
4019 */
4020 public function __toString () {}
4021
4022 /**
4023 * Gets the path without filename
4024 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
4025 * @return string the path to the file.
4026 */
4027 public function getPath () {}
4028
4029 /**
4030 * Gets the path to the file
4031 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
4032 * @return string The path to the file.
4033 */
4034 public function getPathname () {}
4035
4036 /**
4037 * Gets file permissions
4038 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
4039 * @return int the file permissions.
4040 */
4041 public function getPerms () {}
4042
4043 /**
4044 * Gets the inode for the file
4045 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
4046 * @return int the inode number for the filesystem object.
4047 */
4048 public function getInode () {}
4049
4050 /**
4051 * Gets file size
4052 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
4053 * @return int The filesize in bytes.
4054 */
4055 public function getSize () {}
4056
4057 /**
4058 * Gets the owner of the file
4059 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
4060 * @return int The owner id in numerical format.
4061 */
4062 public function getOwner () {}
4063
4064 /**
4065 * Gets the file group
4066 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
4067 * @return int The group id in numerical format.
4068 */
4069 public function getGroup () {}
4070
4071 /**
4072 * Gets last access time of the file
4073 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
4074 * @return int the time the file was last accessed.
4075 */
4076 public function getATime () {}
4077
4078 /**
4079 * Gets the last modified time
4080 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
4081 * @return int the last modified time for the file, in a Unix timestamp.
4082 */
4083 public function getMTime () {}
4084
4085 /**
4086 * Gets the inode change time
4087 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
4088 * @return int The last change time, in a Unix timestamp.
4089 */
4090 public function getCTime () {}
4091
4092 /**
4093 * Gets file type
4094 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
4095 * @return string A string representing the type of the entry.
4096 * May be one of file, link,
4097 * or dir
4098 */
4099 public function getType () {}
4100
4101 /**
4102 * Tells if the entry is writable
4103 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
4104 * @return bool true if writable, false otherwise;
4105 */
4106 public function isWritable () {}
4107
4108 /**
4109 * Tells if file is readable
4110 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
4111 * @return bool true if readable, false otherwise.
4112 */
4113 public function isReadable () {}
4114
4115 /**
4116 * Tells if the file is executable
4117 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
4118 * @return bool true if executable, false otherwise.
4119 */
4120 public function isExecutable () {}
4121
4122 /**
4123 * Tells if the object references a regular file
4124 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
4125 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
4126 */
4127 public function isFile () {}
4128
4129 /**
4130 * Tells if the file is a directory
4131 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
4132 * @return bool true if a directory, false otherwise.
4133 */
4134 public function isDir () {}
4135
4136 /**
4137 * Tells if the file is a link
4138 * @link http://www.php.net/manual/en/splfileinfo.islink.php
4139 * @return bool true if the file is a link, false otherwise.
4140 */
4141 public function isLink () {}
4142
4143 /**
4144 * Gets the target of a link
4145 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
4146 * @return string the target of the filesystem link.
4147 */
4148 public function getLinkTarget () {}
4149
4150 /**
4151 * Gets absolute path to file
4152 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
4153 * @return string the path to the file.
4154 */
4155 public function getRealPath () {}
4156
4157 /**
4158 * Gets an SplFileInfo object for the file
4159 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
4160 * @param class_name string[optional] <p>
4161 * Name of an SplFileInfo derived class to use.
4162 * </p>
4163 * @return SplFileInfo An SplFileInfo object created for the file.
4164 */
4165 public function getFileInfo ($class_name = null) {}
4166
4167 /**
4168 * Gets an SplFileInfo object for the path
4169 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
4170 * @param class_name string[optional] <p>
4171 * Name of an SplFileInfo derived class to use.
4172 * </p>
4173 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
4174 */
4175 public function getPathInfo ($class_name = null) {}
4176
4177 /**
4178 * Gets an SplFileObject object for the file
4179 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
4180 * @param open_mode string[optional] <p>
4181 * The mode for opening the file. See the fopen
4182 * documentation for descriptions of possible modes. The default
4183 * is read only.
4184 * </p>
4185 * @param use_include_path bool[optional] <p>
4186 * &parameter.use_include_path;
4187 * </p>
4188 * @param context resource[optional] <p>
4189 * &parameter.context;
4190 * </p>
4191 * @return SplFileObject The opened file as an SplFileObject object.
4192 */
4193 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
4194
4195 /**
4196 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
4197 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
4198 * @param class_name string[optional] <p>
4199 * The class name to use when openFile() is called.
4200 * </p>
4201 * @return void
4202 */
4203 public function setFileClass ($class_name = null) {}
4204
4205 /**
4206 * Sets the class used with getFileInfo and getPathInfo
4207 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
4208 * @param class_name string[optional] <p>
4209 * The class name to use.
4210 * </p>
4211 * @return void
4212 */
4213 public function setInfoClass ($class_name = null) {}
4214
4215 final public function _bad_state_ex () {}
4216
4217 }
4218
4219 class GlobIterator extends FilesystemIterator implements Iterator, Traversable, SeekableIterator, Countable {
4220 const CURRENT_MODE_MASK = 240;
4221 const CURRENT_AS_PATHNAME = 32;
4222 const CURRENT_AS_FILEINFO = 0;
4223 const CURRENT_AS_SELF = 16;
4224 const KEY_MODE_MASK = 3840;
4225 const KEY_AS_PATHNAME = 0;
4226 const FOLLOW_SYMLINKS = 512;
4227 const KEY_AS_FILENAME = 256;
4228 const NEW_CURRENT_AND_KEY = 256;
4229 const OTHER_MODE_MASK = 12288;
4230 const SKIP_DOTS = 4096;
4231 const UNIX_PATHS = 8192;
4232
4233
4234 /**
4235 * Construct a directory using glob
4236 * @link http://www.php.net/manual/en/globiterator.construct.php
4237 * @param path
4238 * @param flags[optional]
4239 */
4240 public function __construct ($path, $flags) {}
4241
4242 /**
4243 * Get the number of directories and files
4244 * @link http://www.php.net/manual/en/globiterator.count.php
4245 * @return int The number of returned directories and files, as an
4246 * integer.
4247 */
4248 public function count () {}
4249
4250 /**
4251 * Rewinds back to the beginning
4252 * @link http://www.php.net/manual/en/filesystemiterator.rewind.php
4253 * @return void
4254 */
4255 public function rewind () {}
4256
4257 /**
4258 * Move to the next file
4259 * @link http://www.php.net/manual/en/filesystemiterator.next.php
4260 * @return void
4261 */
4262 public function next () {}
4263
4264 /**
4265 * Retrieve the key for the current file
4266 * @link http://www.php.net/manual/en/filesystemiterator.key.php
4267 * @return string the pathname or filename depending on the set flags.
4268 * See the FilesystemIterator constants.
4269 */
4270 public function key () {}
4271
4272 /**
4273 * The current file
4274 * @link http://www.php.net/manual/en/filesystemiterator.current.php
4275 * @return mixed The filename, file information, or $this depending on the set flags.
4276 * See the FilesystemIterator constants.
4277 */
4278 public function current () {}
4279
4280 /**
4281 * Get the handling flags
4282 * @link http://www.php.net/manual/en/filesystemiterator.getflags.php
4283 * @return int The integer value of the set flags.
4284 */
4285 public function getFlags () {}
4286
4287 /**
4288 * Sets handling flags
4289 * @link http://www.php.net/manual/en/filesystemiterator.setflags.php
4290 * @param flags int[optional] <p>
4291 * The handling flags to set.
4292 * See the FilesystemIterator constants.
4293 * </p>
4294 * @return void
4295 */
4296 public function setFlags ($flags = null) {}
4297
4298 /**
4299 * Return file name of current DirectoryIterator item.
4300 * @link http://www.php.net/manual/en/directoryiterator.getfilename.php
4301 * @return string the file name of the current DirectoryIterator item.
4302 */
4303 public function getFilename () {}
4304
4305 /**
4306 * Gets the file extension
4307 * @link http://www.php.net/manual/en/directoryiterator.getextension.php
4308 * @return string a string containing the file extension, or an
4309 * empty string if the file has no extension.
4310 */
4311 public function getExtension () {}
4312
4313 /**
4314 * Get base name of current DirectoryIterator item.
4315 * @link http://www.php.net/manual/en/directoryiterator.getbasename.php
4316 * @param suffix string[optional] <p>
4317 * If the base name ends in suffix,
4318 * this will be cut.
4319 * </p>
4320 * @return string The base name of the current DirectoryIterator item.
4321 */
4322 public function getBasename ($suffix = null) {}
4323
4324 /**
4325 * Determine if current DirectoryIterator item is '.' or '..'
4326 * @link http://www.php.net/manual/en/directoryiterator.isdot.php
4327 * @return bool true if the entry is . or ..,
4328 * otherwise false
4329 */
4330 public function isDot () {}
4331
4332 /**
4333 * Check whether current DirectoryIterator position is a valid file
4334 * @link http://www.php.net/manual/en/directoryiterator.valid.php
4335 * @return bool true if the position is valid, otherwise false
4336 */
4337 public function valid () {}
4338
4339 /**
4340 * Seek to a DirectoryIterator item
4341 * @link http://www.php.net/manual/en/directoryiterator.seek.php
4342 * @param position int <p>
4343 * The zero-based numeric position to seek to.
4344 * </p>
4345 * @return void
4346 */
4347 public function seek ($position) {}
4348
4349 /**
4350 * Get file name as a string
4351 * @link http://www.php.net/manual/en/directoryiterator.tostring.php
4352 * @return string the file name of the current DirectoryIterator item.
4353 */
4354 public function __toString () {}
4355
4356 /**
4357 * Gets the path without filename
4358 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
4359 * @return string the path to the file.
4360 */
4361 public function getPath () {}
4362
4363 /**
4364 * Gets the path to the file
4365 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
4366 * @return string The path to the file.
4367 */
4368 public function getPathname () {}
4369
4370 /**
4371 * Gets file permissions
4372 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
4373 * @return int the file permissions.
4374 */
4375 public function getPerms () {}
4376
4377 /**
4378 * Gets the inode for the file
4379 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
4380 * @return int the inode number for the filesystem object.
4381 */
4382 public function getInode () {}
4383
4384 /**
4385 * Gets file size
4386 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
4387 * @return int The filesize in bytes.
4388 */
4389 public function getSize () {}
4390
4391 /**
4392 * Gets the owner of the file
4393 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
4394 * @return int The owner id in numerical format.
4395 */
4396 public function getOwner () {}
4397
4398 /**
4399 * Gets the file group
4400 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
4401 * @return int The group id in numerical format.
4402 */
4403 public function getGroup () {}
4404
4405 /**
4406 * Gets last access time of the file
4407 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
4408 * @return int the time the file was last accessed.
4409 */
4410 public function getATime () {}
4411
4412 /**
4413 * Gets the last modified time
4414 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
4415 * @return int the last modified time for the file, in a Unix timestamp.
4416 */
4417 public function getMTime () {}
4418
4419 /**
4420 * Gets the inode change time
4421 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
4422 * @return int The last change time, in a Unix timestamp.
4423 */
4424 public function getCTime () {}
4425
4426 /**
4427 * Gets file type
4428 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
4429 * @return string A string representing the type of the entry.
4430 * May be one of file, link,
4431 * or dir
4432 */
4433 public function getType () {}
4434
4435 /**
4436 * Tells if the entry is writable
4437 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
4438 * @return bool true if writable, false otherwise;
4439 */
4440 public function isWritable () {}
4441
4442 /**
4443 * Tells if file is readable
4444 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
4445 * @return bool true if readable, false otherwise.
4446 */
4447 public function isReadable () {}
4448
4449 /**
4450 * Tells if the file is executable
4451 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
4452 * @return bool true if executable, false otherwise.
4453 */
4454 public function isExecutable () {}
4455
4456 /**
4457 * Tells if the object references a regular file
4458 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
4459 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
4460 */
4461 public function isFile () {}
4462
4463 /**
4464 * Tells if the file is a directory
4465 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
4466 * @return bool true if a directory, false otherwise.
4467 */
4468 public function isDir () {}
4469
4470 /**
4471 * Tells if the file is a link
4472 * @link http://www.php.net/manual/en/splfileinfo.islink.php
4473 * @return bool true if the file is a link, false otherwise.
4474 */
4475 public function isLink () {}
4476
4477 /**
4478 * Gets the target of a link
4479 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
4480 * @return string the target of the filesystem link.
4481 */
4482 public function getLinkTarget () {}
4483
4484 /**
4485 * Gets absolute path to file
4486 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
4487 * @return string the path to the file.
4488 */
4489 public function getRealPath () {}
4490
4491 /**
4492 * Gets an SplFileInfo object for the file
4493 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
4494 * @param class_name string[optional] <p>
4495 * Name of an SplFileInfo derived class to use.
4496 * </p>
4497 * @return SplFileInfo An SplFileInfo object created for the file.
4498 */
4499 public function getFileInfo ($class_name = null) {}
4500
4501 /**
4502 * Gets an SplFileInfo object for the path
4503 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
4504 * @param class_name string[optional] <p>
4505 * Name of an SplFileInfo derived class to use.
4506 * </p>
4507 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
4508 */
4509 public function getPathInfo ($class_name = null) {}
4510
4511 /**
4512 * Gets an SplFileObject object for the file
4513 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
4514 * @param open_mode string[optional] <p>
4515 * The mode for opening the file. See the fopen
4516 * documentation for descriptions of possible modes. The default
4517 * is read only.
4518 * </p>
4519 * @param use_include_path bool[optional] <p>
4520 * &parameter.use_include_path;
4521 * </p>
4522 * @param context resource[optional] <p>
4523 * &parameter.context;
4524 * </p>
4525 * @return SplFileObject The opened file as an SplFileObject object.
4526 */
4527 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
4528
4529 /**
4530 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
4531 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
4532 * @param class_name string[optional] <p>
4533 * The class name to use when openFile() is called.
4534 * </p>
4535 * @return void
4536 */
4537 public function setFileClass ($class_name = null) {}
4538
4539 /**
4540 * Sets the class used with getFileInfo and getPathInfo
4541 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
4542 * @param class_name string[optional] <p>
4543 * The class name to use.
4544 * </p>
4545 * @return void
4546 */
4547 public function setInfoClass ($class_name = null) {}
4548
4549 final public function _bad_state_ex () {}
4550
4551 }
4552
4553 class SplFileObject extends SplFileInfo implements RecursiveIterator, Traversable, Iterator, SeekableIterator {
4554 const DROP_NEW_LINE = 1;
4555 const READ_AHEAD = 2;
4556 const SKIP_EMPTY = 4;
4557 const READ_CSV = 8;
4558
4559
4560 /**
4561 * Construct a new file object.
4562 * @link http://www.php.net/manual/en/splfileobject.construct.php
4563 * @param file_name
4564 * @param open_mode[optional]
4565 * @param use_include_path[optional]
4566 * @param context[optional]
4567 */
4568 public function __construct ($file_name, $open_mode, $use_include_path, $context) {}
4569
4570 /**
4571 * Rewind the file to the first line
4572 * @link http://www.php.net/manual/en/splfileobject.rewind.php
4573 * @return void
4574 */
4575 public function rewind () {}
4576
4577 /**
4578 * Reached end of file
4579 * @link http://www.php.net/manual/en/splfileobject.eof.php
4580 * @return bool true if file is at EOF, false otherwise.
4581 */
4582 public function eof () {}
4583
4584 /**
4585 * Not at EOF
4586 * @link http://www.php.net/manual/en/splfileobject.valid.php
4587 * @return bool true if not reached EOF, false otherwise.
4588 */
4589 public function valid () {}
4590
4591 /**
4592 * Gets line from file
4593 * @link http://www.php.net/manual/en/splfileobject.fgets.php
4594 * @return string a string containing the next line from the file, or false on error.
4595 */
4596 public function fgets () {}
4597
4598 /**
4599 * Gets line from file and parse as CSV fields
4600 * @link http://www.php.net/manual/en/splfileobject.fgetcsv.php
4601 * @param delimiter string[optional] <p>
4602 * The field delimiter (one character only). Defaults as a comma or the value set using SplFileObject::setCsvControl.
4603 * </p>
4604 * @param enclosure string[optional] <p>
4605 * The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl.
4606 * </p>
4607 * @param escape string[optional] <p>
4608 * The escape character (one character only). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl.
4609 * </p>
4610 * @return array an indexed array containing the fields read, or false on error.
4611 * </p>
4612 *
4613 * <p>
4614 * A blank line in a CSV file will be returned as an array
4615 * comprising a single &null; field unless using SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE,
4616 * in which case empty lines are skipped.
4617 */
4618 public function fgetcsv ($delimiter = null, $enclosure = null, $escape = null) {}
4619
4620 /**
4621 * Write a field array as a CSV line
4622 * @link http://www.php.net/manual/en/splfileobject.fputcsv.php
4623 * @param fields array <p>
4624 * An array of values.
4625 * </p>
4626 * @param delimiter string[optional] <p>
4627 * The optional delimiter parameter sets the field
4628 * delimiter (one character only).
4629 * </p>
4630 * @param enclosure string[optional] <p>
4631 * The optional enclosure parameter sets the field
4632 * enclosure (one character only).
4633 * </p>
4634 * @return int the length of the written string&return.falseforfailure;.
4635 * </p>
4636 * <p>
4637 * Returns false, and does not write the CSV line to the file, if the
4638 * delimiter or enclosure
4639 * parameter is not a single character.
4640 */
4641 public function fputcsv (array $fields, $delimiter = null, $enclosure = null) {}
4642
4643 /**
4644 * Set the delimiter and enclosure character for CSV
4645 * @link http://www.php.net/manual/en/splfileobject.setcsvcontrol.php
4646 * @param delimiter string[optional] <p>
4647 * The field delimiter (one character only).
4648 * </p>
4649 * @param enclosure string[optional] <p>
4650 * The field enclosure character (one character only).
4651 * </p>
4652 * @param escape string[optional] <p>
4653 * The field escape character (one character only).
4654 * </p>
4655 * @return void
4656 */
4657 public function setCsvControl ($delimiter = null, $enclosure = null, $escape = null) {}
4658
4659 /**
4660 * Get the delimiter and enclosure character for CSV
4661 * @link http://www.php.net/manual/en/splfileobject.getcsvcontrol.php
4662 * @return array an indexed array containing the delimiter and enclosure character.
4663 */
4664 public function getCsvControl () {}
4665
4666 /**
4667 * Portable file locking
4668 * @link http://www.php.net/manual/en/splfileobject.flock.php
4669 * @param operation int <p>
4670 * operation is one of the following:
4671 *
4672 *
4673 *
4674 * LOCK_SH to acquire a shared lock (reader).
4675 * @param wouldblock int[optional] <p>
4676 * Set to true if the lock would block (EWOULDBLOCK errno condition).
4677 * </p>
4678 * @return bool Returns true on success, false on failure.
4679 */
4680 public function flock ($operation, &$wouldblock = null) {}
4681
4682 /**
4683 * Flushes the output to the file
4684 * @link http://www.php.net/manual/en/splfileobject.fflush.php
4685 * @return bool Returns true on success, false on failure.
4686 */
4687 public function fflush () {}
4688
4689 /**
4690 * Return current file position
4691 * @link http://www.php.net/manual/en/splfileobject.ftell.php
4692 * @return int the position of the file pointer as an integer, or false on error.
4693 */
4694 public function ftell () {}
4695
4696 /**
4697 * Seek to a position
4698 * @link http://www.php.net/manual/en/splfileobject.fseek.php
4699 * @param offset int <p>
4700 * The offset. A negative value can be used to move backwards through the file which
4701 * is useful when SEEK_END is used as the whence value.
4702 * </p>
4703 * @param whence int[optional] <p>
4704 * whence values are:
4705 *
4706 * SEEK_SET - Set position equal to offset bytes.
4707 * SEEK_CUR - Set position to current location plus offset.
4708 * SEEK_END - Set position to end-of-file plus offset.
4709 *
4710 * </p>
4711 * <p>
4712 * If whence is not specified, it is assumed to be SEEK_SET.
4713 * </p>
4714 * @return int 0 if the seek was successful, -1 otherwise. Note that seeking
4715 * past EOF is not considered an error.
4716 */
4717 public function fseek ($offset, $whence = null) {}
4718
4719 /**
4720 * Gets character from file
4721 * @link http://www.php.net/manual/en/splfileobject.fgetc.php
4722 * @return string a string containing a single character read from the file or false on EOF.
4723 */
4724 public function fgetc () {}
4725
4726 /**
4727 * Output all remaining data on a file pointer
4728 * @link http://www.php.net/manual/en/splfileobject.fpassthru.php
4729 * @return int the number of characters read from handle
4730 * and passed through to the output.
4731 */
4732 public function fpassthru () {}
4733
4734 /**
4735 * Gets line from file and strip HTML tags
4736 * @link http://www.php.net/manual/en/splfileobject.fgetss.php
4737 * @param allowable_tags string[optional] <p>
4738 * Optional parameter to specify tags which should not be stripped.
4739 * </p>
4740 * @return string a string containing the next line of the file with HTML and PHP
4741 * code stripped, or false on error.
4742 */
4743 public function fgetss ($allowable_tags = null) {}
4744
4745 /**
4746 * Parses input from file according to a format
4747 * @link http://www.php.net/manual/en/splfileobject.fscanf.php
4748 * @param format string <p>
4749 * The specified format as described in the sprintf documentation.
4750 * </p>
4751 * @param _ mixed[optional]
4752 * @return mixed If only one parameter is passed to this method, the values parsed will be
4753 * returned as an array. Otherwise, if optional parameters are passed, the
4754 * function will return the number of assigned values. The optional
4755 * parameters must be passed by reference.
4756 */
4757 public function fscanf ($format, &$_ = null) {}
4758
4759 /**
4760 * Write to file
4761 * @link http://www.php.net/manual/en/splfileobject.fwrite.php
4762 * @param str string <p>
4763 * The string to be written to the file.
4764 * </p>
4765 * @param length int[optional] <p>
4766 * If the length argument is given, writing will
4767 * stop after length bytes have been written or
4768 * the end of string is reached, whichever comes
4769 * first.
4770 * </p>
4771 * @return int the number of bytes written, or &null; on error.
4772 */
4773 public function fwrite ($str, $length = null) {}
4774
4775 /**
4776 * Read from file
4777 * @link http://www.php.net/manual/en/splfileobject.fread.php
4778 * @param length int <p>
4779 * The number of bytes to read.
4780 * </p>
4781 * @return string the string read from the file &return.falseforfailure;.
4782 */
4783 public function fread ($length) {}
4784
4785 /**
4786 * Gets information about the file
4787 * @link http://www.php.net/manual/en/splfileobject.fstat.php
4788 * @return array an array with the statistics of the file; the format of the array
4789 * is described in detail on the stat manual page.
4790 */
4791 public function fstat () {}
4792
4793 /**
4794 * Truncates the file to a given length
4795 * @link http://www.php.net/manual/en/splfileobject.ftruncate.php
4796 * @param size int <p>
4797 * The size to truncate to.
4798 * </p>
4799 *
4800 * <p>
4801 * If size is larger than the file it is extended with null bytes.
4802 * </p>
4803 * <p>
4804 * If size is smaller than the file, the extra data will be lost.
4805 * </p>
4806 * @return bool Returns true on success, false on failure.
4807 */
4808 public function ftruncate ($size) {}
4809
4810 /**
4811 * Retrieve current line of file
4812 * @link http://www.php.net/manual/en/splfileobject.current.php
4813 * @return string|array Retrieves the current line of the file. If the SplFileObject::READ_CSV flag is set, this method returns an array containing the current line parsed as CSV data.
4814 */
4815 public function current () {}
4816
4817 /**
4818 * Get line number
4819 * @link http://www.php.net/manual/en/splfileobject.key.php
4820 * @return int the current line number.
4821 */
4822 public function key () {}
4823
4824 /**
4825 * Read next line
4826 * @link http://www.php.net/manual/en/splfileobject.next.php
4827 * @return void
4828 */
4829 public function next () {}
4830
4831 /**
4832 * Sets flags for the SplFileObject
4833 * @link http://www.php.net/manual/en/splfileobject.setflags.php
4834 * @param flags int <p>
4835 * Bit mask of the flags to set. See
4836 * SplFileObject constants
4837 * for the available flags.
4838 * </p>
4839 * @return void
4840 */
4841 public function setFlags ($flags) {}
4842
4843 /**
4844 * Gets flags for the SplFileObject
4845 * @link http://www.php.net/manual/en/splfileobject.getflags.php
4846 * @return int an integer representing the flags.
4847 */
4848 public function getFlags () {}
4849
4850 /**
4851 * Set maximum line length
4852 * @link http://www.php.net/manual/en/splfileobject.setmaxlinelen.php
4853 * @param max_len int <p>
4854 * The maximum length of a line.
4855 * </p>
4856 * @return void
4857 */
4858 public function setMaxLineLen ($max_len) {}
4859
4860 /**
4861 * Get maximum line length
4862 * @link http://www.php.net/manual/en/splfileobject.getmaxlinelen.php
4863 * @return int the maximum line length if one has been set with
4864 * SplFileObject::setMaxLineLen, default is 0.
4865 */
4866 public function getMaxLineLen () {}
4867
4868 /**
4869 * SplFileObject does not have children
4870 * @link http://www.php.net/manual/en/splfileobject.haschildren.php
4871 * @return bool false
4872 */
4873 public function hasChildren () {}
4874
4875 /**
4876 * No purpose
4877 * @link http://www.php.net/manual/en/splfileobject.getchildren.php
4878 * @return void
4879 */
4880 public function getChildren () {}
4881
4882 /**
4883 * Seek to specified line
4884 * @link http://www.php.net/manual/en/splfileobject.seek.php
4885 * @param line_pos int <p>
4886 * The zero-based line number to seek to.
4887 * </p>
4888 * @return void
4889 */
4890 public function seek ($line_pos) {}
4891
4892 /**
4893 * Alias of <methodname>SplFileObject::fgets</methodname>
4894 * @link http://www.php.net/manual/en/splfileobject.getcurrentline.php
4895 */
4896 public function getCurrentLine () {}
4897
4898 /**
4899 * Alias of <methodname>SplFileObject::current</methodname>
4900 * @link http://www.php.net/manual/en/splfileobject.tostring.php
4901 * @return void
4902 */
4903 public function __toString () {}
4904
4905 /**
4906 * Gets the path without filename
4907 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
4908 * @return string the path to the file.
4909 */
4910 public function getPath () {}
4911
4912 /**
4913 * Gets the filename
4914 * @link http://www.php.net/manual/en/splfileinfo.getfilename.php
4915 * @return string The filename.
4916 */
4917 public function getFilename () {}
4918
4919 /**
4920 * Gets the file extension
4921 * @link http://www.php.net/manual/en/splfileinfo.getextension.php
4922 * @return string a string containing the file extension, or an
4923 * empty string if the file has no extension.
4924 */
4925 public function getExtension () {}
4926
4927 /**
4928 * Gets the base name of the file
4929 * @link http://www.php.net/manual/en/splfileinfo.getbasename.php
4930 * @param suffix string[optional] <p>
4931 * Optional suffix to omit from the base name returned.
4932 * </p>
4933 * @return string the base name without path information.
4934 */
4935 public function getBasename ($suffix = null) {}
4936
4937 /**
4938 * Gets the path to the file
4939 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
4940 * @return string The path to the file.
4941 */
4942 public function getPathname () {}
4943
4944 /**
4945 * Gets file permissions
4946 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
4947 * @return int the file permissions.
4948 */
4949 public function getPerms () {}
4950
4951 /**
4952 * Gets the inode for the file
4953 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
4954 * @return int the inode number for the filesystem object.
4955 */
4956 public function getInode () {}
4957
4958 /**
4959 * Gets file size
4960 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
4961 * @return int The filesize in bytes.
4962 */
4963 public function getSize () {}
4964
4965 /**
4966 * Gets the owner of the file
4967 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
4968 * @return int The owner id in numerical format.
4969 */
4970 public function getOwner () {}
4971
4972 /**
4973 * Gets the file group
4974 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
4975 * @return int The group id in numerical format.
4976 */
4977 public function getGroup () {}
4978
4979 /**
4980 * Gets last access time of the file
4981 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
4982 * @return int the time the file was last accessed.
4983 */
4984 public function getATime () {}
4985
4986 /**
4987 * Gets the last modified time
4988 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
4989 * @return int the last modified time for the file, in a Unix timestamp.
4990 */
4991 public function getMTime () {}
4992
4993 /**
4994 * Gets the inode change time
4995 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
4996 * @return int The last change time, in a Unix timestamp.
4997 */
4998 public function getCTime () {}
4999
5000 /**
5001 * Gets file type
5002 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
5003 * @return string A string representing the type of the entry.
5004 * May be one of file, link,
5005 * or dir
5006 */
5007 public function getType () {}
5008
5009 /**
5010 * Tells if the entry is writable
5011 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
5012 * @return bool true if writable, false otherwise;
5013 */
5014 public function isWritable () {}
5015
5016 /**
5017 * Tells if file is readable
5018 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
5019 * @return bool true if readable, false otherwise.
5020 */
5021 public function isReadable () {}
5022
5023 /**
5024 * Tells if the file is executable
5025 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
5026 * @return bool true if executable, false otherwise.
5027 */
5028 public function isExecutable () {}
5029
5030 /**
5031 * Tells if the object references a regular file
5032 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
5033 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
5034 */
5035 public function isFile () {}
5036
5037 /**
5038 * Tells if the file is a directory
5039 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
5040 * @return bool true if a directory, false otherwise.
5041 */
5042 public function isDir () {}
5043
5044 /**
5045 * Tells if the file is a link
5046 * @link http://www.php.net/manual/en/splfileinfo.islink.php
5047 * @return bool true if the file is a link, false otherwise.
5048 */
5049 public function isLink () {}
5050
5051 /**
5052 * Gets the target of a link
5053 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
5054 * @return string the target of the filesystem link.
5055 */
5056 public function getLinkTarget () {}
5057
5058 /**
5059 * Gets absolute path to file
5060 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
5061 * @return string the path to the file.
5062 */
5063 public function getRealPath () {}
5064
5065 /**
5066 * Gets an SplFileInfo object for the file
5067 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
5068 * @param class_name string[optional] <p>
5069 * Name of an SplFileInfo derived class to use.
5070 * </p>
5071 * @return SplFileInfo An SplFileInfo object created for the file.
5072 */
5073 public function getFileInfo ($class_name = null) {}
5074
5075 /**
5076 * Gets an SplFileInfo object for the path
5077 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
5078 * @param class_name string[optional] <p>
5079 * Name of an SplFileInfo derived class to use.
5080 * </p>
5081 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
5082 */
5083 public function getPathInfo ($class_name = null) {}
5084
5085 /**
5086 * Gets an SplFileObject object for the file
5087 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
5088 * @param open_mode string[optional] <p>
5089 * The mode for opening the file. See the fopen
5090 * documentation for descriptions of possible modes. The default
5091 * is read only.
5092 * </p>
5093 * @param use_include_path bool[optional] <p>
5094 * &parameter.use_include_path;
5095 * </p>
5096 * @param context resource[optional] <p>
5097 * &parameter.context;
5098 * </p>
5099 * @return SplFileObject The opened file as an SplFileObject object.
5100 */
5101 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
5102
5103 /**
5104 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
5105 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
5106 * @param class_name string[optional] <p>
5107 * The class name to use when openFile() is called.
5108 * </p>
5109 * @return void
5110 */
5111 public function setFileClass ($class_name = null) {}
5112
5113 /**
5114 * Sets the class used with getFileInfo and getPathInfo
5115 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
5116 * @param class_name string[optional] <p>
5117 * The class name to use.
5118 * </p>
5119 * @return void
5120 */
5121 public function setInfoClass ($class_name = null) {}
5122
5123 final public function _bad_state_ex () {}
5124
5125 }
5126
5127 class SplTempFileObject extends SplFileObject implements SeekableIterator, Iterator, Traversable, RecursiveIterator {
5128 const DROP_NEW_LINE = 1;
5129 const READ_AHEAD = 2;
5130 const SKIP_EMPTY = 4;
5131 const READ_CSV = 8;
5132
5133
5134 /**
5135 * Construct a new temporary file object
5136 * @link http://www.php.net/manual/en/spltempfileobject.construct.php
5137 * @param max_memory[optional]
5138 */
5139 public function __construct ($max_memory) {}
5140
5141 /**
5142 * Rewind the file to the first line
5143 * @link http://www.php.net/manual/en/splfileobject.rewind.php
5144 * @return void
5145 */
5146 public function rewind () {}
5147
5148 /**
5149 * Reached end of file
5150 * @link http://www.php.net/manual/en/splfileobject.eof.php
5151 * @return bool true if file is at EOF, false otherwise.
5152 */
5153 public function eof () {}
5154
5155 /**
5156 * Not at EOF
5157 * @link http://www.php.net/manual/en/splfileobject.valid.php
5158 * @return bool true if not reached EOF, false otherwise.
5159 */
5160 public function valid () {}
5161
5162 /**
5163 * Gets line from file
5164 * @link http://www.php.net/manual/en/splfileobject.fgets.php
5165 * @return string a string containing the next line from the file, or false on error.
5166 */
5167 public function fgets () {}
5168
5169 /**
5170 * Gets line from file and parse as CSV fields
5171 * @link http://www.php.net/manual/en/splfileobject.fgetcsv.php
5172 * @param delimiter string[optional] <p>
5173 * The field delimiter (one character only). Defaults as a comma or the value set using SplFileObject::setCsvControl.
5174 * </p>
5175 * @param enclosure string[optional] <p>
5176 * The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl.
5177 * </p>
5178 * @param escape string[optional] <p>
5179 * The escape character (one character only). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl.
5180 * </p>
5181 * @return array an indexed array containing the fields read, or false on error.
5182 * </p>
5183 *
5184 * <p>
5185 * A blank line in a CSV file will be returned as an array
5186 * comprising a single &null; field unless using SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE,
5187 * in which case empty lines are skipped.
5188 */
5189 public function fgetcsv ($delimiter = null, $enclosure = null, $escape = null) {}
5190
5191 /**
5192 * Write a field array as a CSV line
5193 * @link http://www.php.net/manual/en/splfileobject.fputcsv.php
5194 * @param fields array <p>
5195 * An array of values.
5196 * </p>
5197 * @param delimiter string[optional] <p>
5198 * The optional delimiter parameter sets the field
5199 * delimiter (one character only).
5200 * </p>
5201 * @param enclosure string[optional] <p>
5202 * The optional enclosure parameter sets the field
5203 * enclosure (one character only).
5204 * </p>
5205 * @return int the length of the written string&return.falseforfailure;.
5206 * </p>
5207 * <p>
5208 * Returns false, and does not write the CSV line to the file, if the
5209 * delimiter or enclosure
5210 * parameter is not a single character.
5211 */
5212 public function fputcsv (array $fields, $delimiter = null, $enclosure = null) {}
5213
5214 /**
5215 * Set the delimiter and enclosure character for CSV
5216 * @link http://www.php.net/manual/en/splfileobject.setcsvcontrol.php
5217 * @param delimiter string[optional] <p>
5218 * The field delimiter (one character only).
5219 * </p>
5220 * @param enclosure string[optional] <p>
5221 * The field enclosure character (one character only).
5222 * </p>
5223 * @param escape string[optional] <p>
5224 * The field escape character (one character only).
5225 * </p>
5226 * @return void
5227 */
5228 public function setCsvControl ($delimiter = null, $enclosure = null, $escape = null) {}
5229
5230 /**
5231 * Get the delimiter and enclosure character for CSV
5232 * @link http://www.php.net/manual/en/splfileobject.getcsvcontrol.php
5233 * @return array an indexed array containing the delimiter and enclosure character.
5234 */
5235 public function getCsvControl () {}
5236
5237 /**
5238 * Portable file locking
5239 * @link http://www.php.net/manual/en/splfileobject.flock.php
5240 * @param operation int <p>
5241 * operation is one of the following:
5242 *
5243 *
5244 *
5245 * LOCK_SH to acquire a shared lock (reader).
5246 * @param wouldblock int[optional] <p>
5247 * Set to true if the lock would block (EWOULDBLOCK errno condition).
5248 * </p>
5249 * @return bool Returns true on success, false on failure.
5250 */
5251 public function flock ($operation, &$wouldblock = null) {}
5252
5253 /**
5254 * Flushes the output to the file
5255 * @link http://www.php.net/manual/en/splfileobject.fflush.php
5256 * @return bool Returns true on success, false on failure.
5257 */
5258 public function fflush () {}
5259
5260 /**
5261 * Return current file position
5262 * @link http://www.php.net/manual/en/splfileobject.ftell.php
5263 * @return int the position of the file pointer as an integer, or false on error.
5264 */
5265 public function ftell () {}
5266
5267 /**
5268 * Seek to a position
5269 * @link http://www.php.net/manual/en/splfileobject.fseek.php
5270 * @param offset int <p>
5271 * The offset. A negative value can be used to move backwards through the file which
5272 * is useful when SEEK_END is used as the whence value.
5273 * </p>
5274 * @param whence int[optional] <p>
5275 * whence values are:
5276 *
5277 * SEEK_SET - Set position equal to offset bytes.
5278 * SEEK_CUR - Set position to current location plus offset.
5279 * SEEK_END - Set position to end-of-file plus offset.
5280 *
5281 * </p>
5282 * <p>
5283 * If whence is not specified, it is assumed to be SEEK_SET.
5284 * </p>
5285 * @return int 0 if the seek was successful, -1 otherwise. Note that seeking
5286 * past EOF is not considered an error.
5287 */
5288 public function fseek ($offset, $whence = null) {}
5289
5290 /**
5291 * Gets character from file
5292 * @link http://www.php.net/manual/en/splfileobject.fgetc.php
5293 * @return string a string containing a single character read from the file or false on EOF.
5294 */
5295 public function fgetc () {}
5296
5297 /**
5298 * Output all remaining data on a file pointer
5299 * @link http://www.php.net/manual/en/splfileobject.fpassthru.php
5300 * @return int the number of characters read from handle
5301 * and passed through to the output.
5302 */
5303 public function fpassthru () {}
5304
5305 /**
5306 * Gets line from file and strip HTML tags
5307 * @link http://www.php.net/manual/en/splfileobject.fgetss.php
5308 * @param allowable_tags string[optional] <p>
5309 * Optional parameter to specify tags which should not be stripped.
5310 * </p>
5311 * @return string a string containing the next line of the file with HTML and PHP
5312 * code stripped, or false on error.
5313 */
5314 public function fgetss ($allowable_tags = null) {}
5315
5316 /**
5317 * Parses input from file according to a format
5318 * @link http://www.php.net/manual/en/splfileobject.fscanf.php
5319 * @param format string <p>
5320 * The specified format as described in the sprintf documentation.
5321 * </p>
5322 * @param _ mixed[optional]
5323 * @return mixed If only one parameter is passed to this method, the values parsed will be
5324 * returned as an array. Otherwise, if optional parameters are passed, the
5325 * function will return the number of assigned values. The optional
5326 * parameters must be passed by reference.
5327 */
5328 public function fscanf ($format, &$_ = null) {}
5329
5330 /**
5331 * Write to file
5332 * @link http://www.php.net/manual/en/splfileobject.fwrite.php
5333 * @param str string <p>
5334 * The string to be written to the file.
5335 * </p>
5336 * @param length int[optional] <p>
5337 * If the length argument is given, writing will
5338 * stop after length bytes have been written or
5339 * the end of string is reached, whichever comes
5340 * first.
5341 * </p>
5342 * @return int the number of bytes written, or &null; on error.
5343 */
5344 public function fwrite ($str, $length = null) {}
5345
5346 /**
5347 * Read from file
5348 * @link http://www.php.net/manual/en/splfileobject.fread.php
5349 * @param length int <p>
5350 * The number of bytes to read.
5351 * </p>
5352 * @return string the string read from the file &return.falseforfailure;.
5353 */
5354 public function fread ($length) {}
5355
5356 /**
5357 * Gets information about the file
5358 * @link http://www.php.net/manual/en/splfileobject.fstat.php
5359 * @return array an array with the statistics of the file; the format of the array
5360 * is described in detail on the stat manual page.
5361 */
5362 public function fstat () {}
5363
5364 /**
5365 * Truncates the file to a given length
5366 * @link http://www.php.net/manual/en/splfileobject.ftruncate.php
5367 * @param size int <p>
5368 * The size to truncate to.
5369 * </p>
5370 *
5371 * <p>
5372 * If size is larger than the file it is extended with null bytes.
5373 * </p>
5374 * <p>
5375 * If size is smaller than the file, the extra data will be lost.
5376 * </p>
5377 * @return bool Returns true on success, false on failure.
5378 */
5379 public function ftruncate ($size) {}
5380
5381 /**
5382 * Retrieve current line of file
5383 * @link http://www.php.net/manual/en/splfileobject.current.php
5384 * @return string|array Retrieves the current line of the file. If the SplFileObject::READ_CSV flag is set, this method returns an array containing the current line parsed as CSV data.
5385 */
5386 public function current () {}
5387
5388 /**
5389 * Get line number
5390 * @link http://www.php.net/manual/en/splfileobject.key.php
5391 * @return int the current line number.
5392 */
5393 public function key () {}
5394
5395 /**
5396 * Read next line
5397 * @link http://www.php.net/manual/en/splfileobject.next.php
5398 * @return void
5399 */
5400 public function next () {}
5401
5402 /**
5403 * Sets flags for the SplFileObject
5404 * @link http://www.php.net/manual/en/splfileobject.setflags.php
5405 * @param flags int <p>
5406 * Bit mask of the flags to set. See
5407 * SplFileObject constants
5408 * for the available flags.
5409 * </p>
5410 * @return void
5411 */
5412 public function setFlags ($flags) {}
5413
5414 /**
5415 * Gets flags for the SplFileObject
5416 * @link http://www.php.net/manual/en/splfileobject.getflags.php
5417 * @return int an integer representing the flags.
5418 */
5419 public function getFlags () {}
5420
5421 /**
5422 * Set maximum line length
5423 * @link http://www.php.net/manual/en/splfileobject.setmaxlinelen.php
5424 * @param max_len int <p>
5425 * The maximum length of a line.
5426 * </p>
5427 * @return void
5428 */
5429 public function setMaxLineLen ($max_len) {}
5430
5431 /**
5432 * Get maximum line length
5433 * @link http://www.php.net/manual/en/splfileobject.getmaxlinelen.php
5434 * @return int the maximum line length if one has been set with
5435 * SplFileObject::setMaxLineLen, default is 0.
5436 */
5437 public function getMaxLineLen () {}
5438
5439 /**
5440 * SplFileObject does not have children
5441 * @link http://www.php.net/manual/en/splfileobject.haschildren.php
5442 * @return bool false
5443 */
5444 public function hasChildren () {}
5445
5446 /**
5447 * No purpose
5448 * @link http://www.php.net/manual/en/splfileobject.getchildren.php
5449 * @return void
5450 */
5451 public function getChildren () {}
5452
5453 /**
5454 * Seek to specified line
5455 * @link http://www.php.net/manual/en/splfileobject.seek.php
5456 * @param line_pos int <p>
5457 * The zero-based line number to seek to.
5458 * </p>
5459 * @return void
5460 */
5461 public function seek ($line_pos) {}
5462
5463 /**
5464 * Alias of <methodname>SplFileObject::fgets</methodname>
5465 * @link http://www.php.net/manual/en/splfileobject.getcurrentline.php
5466 */
5467 public function getCurrentLine () {}
5468
5469 /**
5470 * Alias of <methodname>SplFileObject::current</methodname>
5471 * @link http://www.php.net/manual/en/splfileobject.tostring.php
5472 * @return void
5473 */
5474 public function __toString () {}
5475
5476 /**
5477 * Gets the path without filename
5478 * @link http://www.php.net/manual/en/splfileinfo.getpath.php
5479 * @return string the path to the file.
5480 */
5481 public function getPath () {}
5482
5483 /**
5484 * Gets the filename
5485 * @link http://www.php.net/manual/en/splfileinfo.getfilename.php
5486 * @return string The filename.
5487 */
5488 public function getFilename () {}
5489
5490 /**
5491 * Gets the file extension
5492 * @link http://www.php.net/manual/en/splfileinfo.getextension.php
5493 * @return string a string containing the file extension, or an
5494 * empty string if the file has no extension.
5495 */
5496 public function getExtension () {}
5497
5498 /**
5499 * Gets the base name of the file
5500 * @link http://www.php.net/manual/en/splfileinfo.getbasename.php
5501 * @param suffix string[optional] <p>
5502 * Optional suffix to omit from the base name returned.
5503 * </p>
5504 * @return string the base name without path information.
5505 */
5506 public function getBasename ($suffix = null) {}
5507
5508 /**
5509 * Gets the path to the file
5510 * @link http://www.php.net/manual/en/splfileinfo.getpathname.php
5511 * @return string The path to the file.
5512 */
5513 public function getPathname () {}
5514
5515 /**
5516 * Gets file permissions
5517 * @link http://www.php.net/manual/en/splfileinfo.getperms.php
5518 * @return int the file permissions.
5519 */
5520 public function getPerms () {}
5521
5522 /**
5523 * Gets the inode for the file
5524 * @link http://www.php.net/manual/en/splfileinfo.getinode.php
5525 * @return int the inode number for the filesystem object.
5526 */
5527 public function getInode () {}
5528
5529 /**
5530 * Gets file size
5531 * @link http://www.php.net/manual/en/splfileinfo.getsize.php
5532 * @return int The filesize in bytes.
5533 */
5534 public function getSize () {}
5535
5536 /**
5537 * Gets the owner of the file
5538 * @link http://www.php.net/manual/en/splfileinfo.getowner.php
5539 * @return int The owner id in numerical format.
5540 */
5541 public function getOwner () {}
5542
5543 /**
5544 * Gets the file group
5545 * @link http://www.php.net/manual/en/splfileinfo.getgroup.php
5546 * @return int The group id in numerical format.
5547 */
5548 public function getGroup () {}
5549
5550 /**
5551 * Gets last access time of the file
5552 * @link http://www.php.net/manual/en/splfileinfo.getatime.php
5553 * @return int the time the file was last accessed.
5554 */
5555 public function getATime () {}
5556
5557 /**
5558 * Gets the last modified time
5559 * @link http://www.php.net/manual/en/splfileinfo.getmtime.php
5560 * @return int the last modified time for the file, in a Unix timestamp.
5561 */
5562 public function getMTime () {}
5563
5564 /**
5565 * Gets the inode change time
5566 * @link http://www.php.net/manual/en/splfileinfo.getctime.php
5567 * @return int The last change time, in a Unix timestamp.
5568 */
5569 public function getCTime () {}
5570
5571 /**
5572 * Gets file type
5573 * @link http://www.php.net/manual/en/splfileinfo.gettype.php
5574 * @return string A string representing the type of the entry.
5575 * May be one of file, link,
5576 * or dir
5577 */
5578 public function getType () {}
5579
5580 /**
5581 * Tells if the entry is writable
5582 * @link http://www.php.net/manual/en/splfileinfo.iswritable.php
5583 * @return bool true if writable, false otherwise;
5584 */
5585 public function isWritable () {}
5586
5587 /**
5588 * Tells if file is readable
5589 * @link http://www.php.net/manual/en/splfileinfo.isreadable.php
5590 * @return bool true if readable, false otherwise.
5591 */
5592 public function isReadable () {}
5593
5594 /**
5595 * Tells if the file is executable
5596 * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php
5597 * @return bool true if executable, false otherwise.
5598 */
5599 public function isExecutable () {}
5600
5601 /**
5602 * Tells if the object references a regular file
5603 * @link http://www.php.net/manual/en/splfileinfo.isfile.php
5604 * @return bool true if the file exists and is a regular file (not a link), false otherwise.
5605 */
5606 public function isFile () {}
5607
5608 /**
5609 * Tells if the file is a directory
5610 * @link http://www.php.net/manual/en/splfileinfo.isdir.php
5611 * @return bool true if a directory, false otherwise.
5612 */
5613 public function isDir () {}
5614
5615 /**
5616 * Tells if the file is a link
5617 * @link http://www.php.net/manual/en/splfileinfo.islink.php
5618 * @return bool true if the file is a link, false otherwise.
5619 */
5620 public function isLink () {}
5621
5622 /**
5623 * Gets the target of a link
5624 * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php
5625 * @return string the target of the filesystem link.
5626 */
5627 public function getLinkTarget () {}
5628
5629 /**
5630 * Gets absolute path to file
5631 * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php
5632 * @return string the path to the file.
5633 */
5634 public function getRealPath () {}
5635
5636 /**
5637 * Gets an SplFileInfo object for the file
5638 * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php
5639 * @param class_name string[optional] <p>
5640 * Name of an SplFileInfo derived class to use.
5641 * </p>
5642 * @return SplFileInfo An SplFileInfo object created for the file.
5643 */
5644 public function getFileInfo ($class_name = null) {}
5645
5646 /**
5647 * Gets an SplFileInfo object for the path
5648 * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php
5649 * @param class_name string[optional] <p>
5650 * Name of an SplFileInfo derived class to use.
5651 * </p>
5652 * @return SplFileInfo an SplFileInfo object for the parent path of the file.
5653 */
5654 public function getPathInfo ($class_name = null) {}
5655
5656 /**
5657 * Gets an SplFileObject object for the file
5658 * @link http://www.php.net/manual/en/splfileinfo.openfile.php
5659 * @param open_mode string[optional] <p>
5660 * The mode for opening the file. See the fopen
5661 * documentation for descriptions of possible modes. The default
5662 * is read only.
5663 * </p>
5664 * @param use_include_path bool[optional] <p>
5665 * &parameter.use_include_path;
5666 * </p>
5667 * @param context resource[optional] <p>
5668 * &parameter.context;
5669 * </p>
5670 * @return SplFileObject The opened file as an SplFileObject object.
5671 */
5672 public function openFile ($open_mode = null, $use_include_path = null, $context = null) {}
5673
5674 /**
5675 * Sets the class name used with <methodname>SplFileInfo::openFile</methodname>
5676 * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php
5677 * @param class_name string[optional] <p>
5678 * The class name to use when openFile() is called.
5679 * </p>
5680 * @return void
5681 */
5682 public function setFileClass ($class_name = null) {}
5683
5684 /**
5685 * Sets the class used with getFileInfo and getPathInfo
5686 * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php
5687 * @param class_name string[optional] <p>
5688 * The class name to use.
5689 * </p>
5690 * @return void
5691 */
5692 public function setInfoClass ($class_name = null) {}
5693
5694 final public function _bad_state_ex () {}
5695
5696 }
5697
5698 class SplDoublyLinkedList implements Iterator, Traversable, Countable, ArrayAccess, Serializable {
5699 const IT_MODE_LIFO = 2;
5700 const IT_MODE_FIFO = 0;
5701 const IT_MODE_DELETE = 1;
5702 const IT_MODE_KEEP = 0;
5703
5704
5705 /**
5706 * Pops a node from the end of the doubly linked list
5707 * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php
5708 * @return mixed The value of the popped node.
5709 */
5710 public function pop () {}
5711
5712 /**
5713 * Shifts a node from the beginning of the doubly linked list
5714 * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php
5715 * @return mixed The value of the shifted node.
5716 */
5717 public function shift () {}
5718
5719 /**
5720 * Pushes an element at the end of the doubly linked list
5721 * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php
5722 * @param value mixed <p>
5723 * The value to push.
5724 * </p>
5725 * @return void
5726 */
5727 public function push ($value) {}
5728
5729 /**
5730 * Prepends the doubly linked list with an element
5731 * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php
5732 * @param value mixed <p>
5733 * The value to unshift.
5734 * </p>
5735 * @return void
5736 */
5737 public function unshift ($value) {}
5738
5739 /**
5740 * Peeks at the node from the end of the doubly linked list
5741 * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php
5742 * @return mixed The value of the last node.
5743 */
5744 public function top () {}
5745
5746 /**
5747 * Peeks at the node from the beginning of the doubly linked list
5748 * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php
5749 * @return mixed The value of the first node.
5750 */
5751 public function bottom () {}
5752
5753 /**
5754 * Checks whether the doubly linked list is empty.
5755 * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php
5756 * @return bool whether the doubly linked list is empty.
5757 */
5758 public function isEmpty () {}
5759
5760 /**
5761 * Sets the mode of iteration
5762 * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php
5763 * @param mode int <p>
5764 * There are two orthogonal sets of modes that can be set:
5765 * </p>
5766 *
5767 *
5768 * The direction of the iteration (either one or the other):
5769 *
5770 * SplDoublyLinkedList::IT_MODE_LIFO (Stack style)
5771 * @return void
5772 */
5773 public function setIteratorMode ($mode) {}
5774
5775 /**
5776 * Returns the mode of iteration
5777 * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php
5778 * @return int the different modes and flags that affect the iteration.
5779 */
5780 public function getIteratorMode () {}
5781
5782 /**
5783 * Counts the number of elements in the doubly linked list.
5784 * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php
5785 * @return int the number of elements in the doubly linked list.
5786 */
5787 public function count () {}
5788
5789 /**
5790 * Returns whether the requested $index exists
5791 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php
5792 * @param index mixed <p>
5793 * The index being checked.
5794 * </p>
5795 * @return bool true if the requested index exists, otherwise false
5796 */
5797 public function offsetExists ($index) {}
5798
5799 /**
5800 * Returns the value at the specified $index
5801 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php
5802 * @param index mixed <p>
5803 * The index with the value.
5804 * </p>
5805 * @return mixed The value at the specified index.
5806 */
5807 public function offsetGet ($index) {}
5808
5809 /**
5810 * Sets the value at the specified $index to $newval
5811 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php
5812 * @param index mixed <p>
5813 * The index being set.
5814 * </p>
5815 * @param newval mixed <p>
5816 * The new value for the index.
5817 * </p>
5818 * @return void
5819 */
5820 public function offsetSet ($index, $newval) {}
5821
5822 /**
5823 * Unsets the value at the specified $index
5824 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php
5825 * @param index mixed <p>
5826 * The index being unset.
5827 * </p>
5828 * @return void
5829 */
5830 public function offsetUnset ($index) {}
5831
5832 /**
5833 * Add/insert a new value at the specified index
5834 * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php
5835 * @param index mixed <p>
5836 * The index where the new value is to be inserted.
5837 * </p>
5838 * @param newval mixed <p>
5839 * The new value for the index.
5840 * </p>
5841 * @return void
5842 */
5843 public function add ($index, $newval) {}
5844
5845 /**
5846 * Rewind iterator back to the start
5847 * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php
5848 * @return void
5849 */
5850 public function rewind () {}
5851
5852 /**
5853 * Return current array entry
5854 * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php
5855 * @return mixed The current node value.
5856 */
5857 public function current () {}
5858
5859 /**
5860 * Return current node index
5861 * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php
5862 * @return mixed The current node index.
5863 */
5864 public function key () {}
5865
5866 /**
5867 * Move to next entry
5868 * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php
5869 * @return void
5870 */
5871 public function next () {}
5872
5873 /**
5874 * Move to previous entry
5875 * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php
5876 * @return void
5877 */
5878 public function prev () {}
5879
5880 /**
5881 * Check whether the doubly linked list contains more nodes
5882 * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php
5883 * @return bool true if the doubly linked list contains any more nodes, false otherwise.
5884 */
5885 public function valid () {}
5886
5887 /**
5888 * Unserializes the storage
5889 * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php
5890 * @param serialized string <p>
5891 * The serialized string.
5892 * </p>
5893 * @return void
5894 */
5895 public function unserialize ($serialized) {}
5896
5897 /**
5898 * Serializes the storage
5899 * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php
5900 * @return string The serialized string.
5901 */
5902 public function serialize () {}
5903
5904 }
5905
5906 class SplQueue extends SplDoublyLinkedList implements Serializable, ArrayAccess, Countable, Traversable, Iterator {
5907 const IT_MODE_LIFO = 2;
5908 const IT_MODE_FIFO = 0;
5909 const IT_MODE_DELETE = 1;
5910 const IT_MODE_KEEP = 0;
5911
5912
5913 /**
5914 * Adds an element to the queue.
5915 * @link http://www.php.net/manual/en/splqueue.enqueue.php
5916 * @param value mixed <p>
5917 * The value to enqueue.
5918 * </p>
5919 * @return void
5920 */
5921 public function enqueue ($value) {}
5922
5923 /**
5924 * Dequeues a node from the queue
5925 * @link http://www.php.net/manual/en/splqueue.dequeue.php
5926 * @return mixed The value of the dequeued node.
5927 */
5928 public function dequeue () {}
5929
5930 /**
5931 * Pops a node from the end of the doubly linked list
5932 * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php
5933 * @return mixed The value of the popped node.
5934 */
5935 public function pop () {}
5936
5937 /**
5938 * Shifts a node from the beginning of the doubly linked list
5939 * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php
5940 * @return mixed The value of the shifted node.
5941 */
5942 public function shift () {}
5943
5944 /**
5945 * Pushes an element at the end of the doubly linked list
5946 * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php
5947 * @param value mixed <p>
5948 * The value to push.
5949 * </p>
5950 * @return void
5951 */
5952 public function push ($value) {}
5953
5954 /**
5955 * Prepends the doubly linked list with an element
5956 * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php
5957 * @param value mixed <p>
5958 * The value to unshift.
5959 * </p>
5960 * @return void
5961 */
5962 public function unshift ($value) {}
5963
5964 /**
5965 * Peeks at the node from the end of the doubly linked list
5966 * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php
5967 * @return mixed The value of the last node.
5968 */
5969 public function top () {}
5970
5971 /**
5972 * Peeks at the node from the beginning of the doubly linked list
5973 * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php
5974 * @return mixed The value of the first node.
5975 */
5976 public function bottom () {}
5977
5978 /**
5979 * Checks whether the doubly linked list is empty.
5980 * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php
5981 * @return bool whether the doubly linked list is empty.
5982 */
5983 public function isEmpty () {}
5984
5985 /**
5986 * Sets the mode of iteration
5987 * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php
5988 * @param mode int <p>
5989 * There are two orthogonal sets of modes that can be set:
5990 * </p>
5991 *
5992 *
5993 * The direction of the iteration (either one or the other):
5994 *
5995 * SplDoublyLinkedList::IT_MODE_LIFO (Stack style)
5996 * @return void
5997 */
5998 public function setIteratorMode ($mode) {}
5999
6000 /**
6001 * Returns the mode of iteration
6002 * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php
6003 * @return int the different modes and flags that affect the iteration.
6004 */
6005 public function getIteratorMode () {}
6006
6007 /**
6008 * Counts the number of elements in the doubly linked list.
6009 * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php
6010 * @return int the number of elements in the doubly linked list.
6011 */
6012 public function count () {}
6013
6014 /**
6015 * Returns whether the requested $index exists
6016 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php
6017 * @param index mixed <p>
6018 * The index being checked.
6019 * </p>
6020 * @return bool true if the requested index exists, otherwise false
6021 */
6022 public function offsetExists ($index) {}
6023
6024 /**
6025 * Returns the value at the specified $index
6026 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php
6027 * @param index mixed <p>
6028 * The index with the value.
6029 * </p>
6030 * @return mixed The value at the specified index.
6031 */
6032 public function offsetGet ($index) {}
6033
6034 /**
6035 * Sets the value at the specified $index to $newval
6036 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php
6037 * @param index mixed <p>
6038 * The index being set.
6039 * </p>
6040 * @param newval mixed <p>
6041 * The new value for the index.
6042 * </p>
6043 * @return void
6044 */
6045 public function offsetSet ($index, $newval) {}
6046
6047 /**
6048 * Unsets the value at the specified $index
6049 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php
6050 * @param index mixed <p>
6051 * The index being unset.
6052 * </p>
6053 * @return void
6054 */
6055 public function offsetUnset ($index) {}
6056
6057 /**
6058 * Add/insert a new value at the specified index
6059 * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php
6060 * @param index mixed <p>
6061 * The index where the new value is to be inserted.
6062 * </p>
6063 * @param newval mixed <p>
6064 * The new value for the index.
6065 * </p>
6066 * @return void
6067 */
6068 public function add ($index, $newval) {}
6069
6070 /**
6071 * Rewind iterator back to the start
6072 * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php
6073 * @return void
6074 */
6075 public function rewind () {}
6076
6077 /**
6078 * Return current array entry
6079 * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php
6080 * @return mixed The current node value.
6081 */
6082 public function current () {}
6083
6084 /**
6085 * Return current node index
6086 * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php
6087 * @return mixed The current node index.
6088 */
6089 public function key () {}
6090
6091 /**
6092 * Move to next entry
6093 * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php
6094 * @return void
6095 */
6096 public function next () {}
6097
6098 /**
6099 * Move to previous entry
6100 * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php
6101 * @return void
6102 */
6103 public function prev () {}
6104
6105 /**
6106 * Check whether the doubly linked list contains more nodes
6107 * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php
6108 * @return bool true if the doubly linked list contains any more nodes, false otherwise.
6109 */
6110 public function valid () {}
6111
6112 /**
6113 * Unserializes the storage
6114 * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php
6115 * @param serialized string <p>
6116 * The serialized string.
6117 * </p>
6118 * @return void
6119 */
6120 public function unserialize ($serialized) {}
6121
6122 /**
6123 * Serializes the storage
6124 * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php
6125 * @return string The serialized string.
6126 */
6127 public function serialize () {}
6128
6129 }
6130
6131 class SplStack extends SplDoublyLinkedList implements Serializable, ArrayAccess, Countable, Traversable, Iterator {
6132 const IT_MODE_LIFO = 2;
6133 const IT_MODE_FIFO = 0;
6134 const IT_MODE_DELETE = 1;
6135 const IT_MODE_KEEP = 0;
6136
6137
6138 /**
6139 * Pops a node from the end of the doubly linked list
6140 * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php
6141 * @return mixed The value of the popped node.
6142 */
6143 public function pop () {}
6144
6145 /**
6146 * Shifts a node from the beginning of the doubly linked list
6147 * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php
6148 * @return mixed The value of the shifted node.
6149 */
6150 public function shift () {}
6151
6152 /**
6153 * Pushes an element at the end of the doubly linked list
6154 * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php
6155 * @param value mixed <p>
6156 * The value to push.
6157 * </p>
6158 * @return void
6159 */
6160 public function push ($value) {}
6161
6162 /**
6163 * Prepends the doubly linked list with an element
6164 * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php
6165 * @param value mixed <p>
6166 * The value to unshift.
6167 * </p>
6168 * @return void
6169 */
6170 public function unshift ($value) {}
6171
6172 /**
6173 * Peeks at the node from the end of the doubly linked list
6174 * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php
6175 * @return mixed The value of the last node.
6176 */
6177 public function top () {}
6178
6179 /**
6180 * Peeks at the node from the beginning of the doubly linked list
6181 * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php
6182 * @return mixed The value of the first node.
6183 */
6184 public function bottom () {}
6185
6186 /**
6187 * Checks whether the doubly linked list is empty.
6188 * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php
6189 * @return bool whether the doubly linked list is empty.
6190 */
6191 public function isEmpty () {}
6192
6193 /**
6194 * Sets the mode of iteration
6195 * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php
6196 * @param mode int <p>
6197 * There are two orthogonal sets of modes that can be set:
6198 * </p>
6199 *
6200 *
6201 * The direction of the iteration (either one or the other):
6202 *
6203 * SplDoublyLinkedList::IT_MODE_LIFO (Stack style)
6204 * @return void
6205 */
6206 public function setIteratorMode ($mode) {}
6207
6208 /**
6209 * Returns the mode of iteration
6210 * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php
6211 * @return int the different modes and flags that affect the iteration.
6212 */
6213 public function getIteratorMode () {}
6214
6215 /**
6216 * Counts the number of elements in the doubly linked list.
6217 * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php
6218 * @return int the number of elements in the doubly linked list.
6219 */
6220 public function count () {}
6221
6222 /**
6223 * Returns whether the requested $index exists
6224 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php
6225 * @param index mixed <p>
6226 * The index being checked.
6227 * </p>
6228 * @return bool true if the requested index exists, otherwise false
6229 */
6230 public function offsetExists ($index) {}
6231
6232 /**
6233 * Returns the value at the specified $index
6234 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php
6235 * @param index mixed <p>
6236 * The index with the value.
6237 * </p>
6238 * @return mixed The value at the specified index.
6239 */
6240 public function offsetGet ($index) {}
6241
6242 /**
6243 * Sets the value at the specified $index to $newval
6244 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php
6245 * @param index mixed <p>
6246 * The index being set.
6247 * </p>
6248 * @param newval mixed <p>
6249 * The new value for the index.
6250 * </p>
6251 * @return void
6252 */
6253 public function offsetSet ($index, $newval) {}
6254
6255 /**
6256 * Unsets the value at the specified $index
6257 * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php
6258 * @param index mixed <p>
6259 * The index being unset.
6260 * </p>
6261 * @return void
6262 */
6263 public function offsetUnset ($index) {}
6264
6265 /**
6266 * Add/insert a new value at the specified index
6267 * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php
6268 * @param index mixed <p>
6269 * The index where the new value is to be inserted.
6270 * </p>
6271 * @param newval mixed <p>
6272 * The new value for the index.
6273 * </p>
6274 * @return void
6275 */
6276 public function add ($index, $newval) {}
6277
6278 /**
6279 * Rewind iterator back to the start
6280 * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php
6281 * @return void
6282 */
6283 public function rewind () {}
6284
6285 /**
6286 * Return current array entry
6287 * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php
6288 * @return mixed The current node value.
6289 */
6290 public function current () {}
6291
6292 /**
6293 * Return current node index
6294 * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php
6295 * @return mixed The current node index.
6296 */
6297 public function key () {}
6298
6299 /**
6300 * Move to next entry
6301 * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php
6302 * @return void
6303 */
6304 public function next () {}
6305
6306 /**
6307 * Move to previous entry
6308 * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php
6309 * @return void
6310 */
6311 public function prev () {}
6312
6313 /**
6314 * Check whether the doubly linked list contains more nodes
6315 * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php
6316 * @return bool true if the doubly linked list contains any more nodes, false otherwise.
6317 */
6318 public function valid () {}
6319
6320 /**
6321 * Unserializes the storage
6322 * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php
6323 * @param serialized string <p>
6324 * The serialized string.
6325 * </p>
6326 * @return void
6327 */
6328 public function unserialize ($serialized) {}
6329
6330 /**
6331 * Serializes the storage
6332 * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php
6333 * @return string The serialized string.
6334 */
6335 public function serialize () {}
6336
6337 }
6338
6339 class SplHeap implements Iterator, Traversable, Countable {
6340
6341 /**
6342 * Extracts a node from top of the heap and sift up.
6343 * @link http://www.php.net/manual/en/splheap.extract.php
6344 * @return mixed The value of the extracted node.
6345 */
6346 public function extract () {}
6347
6348 /**
6349 * Inserts an element in the heap by sifting it up.
6350 * @link http://www.php.net/manual/en/splheap.insert.php
6351 * @param value mixed <p>
6352 * The value to insert.
6353 * </p>
6354 * @return void
6355 */
6356 public function insert ($value) {}
6357
6358 /**
6359 * Peeks at the node from the top of the heap
6360 * @link http://www.php.net/manual/en/splheap.top.php
6361 * @return mixed The value of the node on the top.
6362 */
6363 public function top () {}
6364
6365 /**
6366 * Counts the number of elements in the heap.
6367 * @link http://www.php.net/manual/en/splheap.count.php
6368 * @return int the number of elements in the heap.
6369 */
6370 public function count () {}
6371
6372 /**
6373 * Checks whether the heap is empty.
6374 * @link http://www.php.net/manual/en/splheap.isempty.php
6375 * @return bool whether the heap is empty.
6376 */
6377 public function isEmpty () {}
6378
6379 /**
6380 * Rewind iterator back to the start (no-op)
6381 * @link http://www.php.net/manual/en/splheap.rewind.php
6382 * @return void
6383 */
6384 public function rewind () {}
6385
6386 /**
6387 * Return current node pointed by the iterator
6388 * @link http://www.php.net/manual/en/splheap.current.php
6389 * @return mixed The current node value.
6390 */
6391 public function current () {}
6392
6393 /**
6394 * Return current node index
6395 * @link http://www.php.net/manual/en/splheap.key.php
6396 * @return mixed The current node index.
6397 */
6398 public function key () {}
6399
6400 /**
6401 * Move to the next node
6402 * @link http://www.php.net/manual/en/splheap.next.php
6403 * @return void
6404 */
6405 public function next () {}
6406
6407 /**
6408 * Check whether the heap contains more nodes
6409 * @link http://www.php.net/manual/en/splheap.valid.php
6410 * @return bool true if the heap contains any more nodes, false otherwise.
6411 */
6412 public function valid () {}
6413
6414 /**
6415 * Recover from the corrupted state and allow further actions on the heap.
6416 * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php
6417 * @return void
6418 */
6419 public function recoverFromCorruption () {}
6420
6421 /**
6422 * Compare elements in order to place them correctly in the heap while sifting up.
6423 * @link http://www.php.net/manual/en/splheap.compare.php
6424 * @param value1 mixed <p>
6425 * The value of the first node being compared.
6426 * </p>
6427 * @param value2 mixed <p>
6428 * The value of the second node being compared.
6429 * </p>
6430 * @return int Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise.
6431 * </p>
6432 *
6433 * <p>
6434 * Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
6435 */
6436 abstract protected function compare ($value1, $value2) {}
6437
6438 }
6439
6440 class SplMinHeap extends SplHeap implements Countable, Traversable, Iterator {
6441
6442 /**
6443 * Compare elements in order to place them correctly in the heap while sifting up.
6444 * @link http://www.php.net/manual/en/splminheap.compare.php
6445 * @param value1 mixed <p>
6446 * The value of the first node being compared.
6447 * </p>
6448 * @param value2 mixed <p>
6449 * The value of the second node being compared.
6450 * </p>
6451 * @return int Result of the comparison, positive integer if value1 is lower than value2, 0 if they are equal, negative integer otherwise.
6452 * </p>
6453 *
6454 * <p>
6455 * Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
6456 */
6457 protected function compare ($value1, $value2) {}
6458
6459 /**
6460 * Extracts a node from top of the heap and sift up.
6461 * @link http://www.php.net/manual/en/splheap.extract.php
6462 * @return mixed The value of the extracted node.
6463 */
6464 public function extract () {}
6465
6466 /**
6467 * Inserts an element in the heap by sifting it up.
6468 * @link http://www.php.net/manual/en/splheap.insert.php
6469 * @param value mixed <p>
6470 * The value to insert.
6471 * </p>
6472 * @return void
6473 */
6474 public function insert ($value) {}
6475
6476 /**
6477 * Peeks at the node from the top of the heap
6478 * @link http://www.php.net/manual/en/splheap.top.php
6479 * @return mixed The value of the node on the top.
6480 */
6481 public function top () {}
6482
6483 /**
6484 * Counts the number of elements in the heap.
6485 * @link http://www.php.net/manual/en/splheap.count.php
6486 * @return int the number of elements in the heap.
6487 */
6488 public function count () {}
6489
6490 /**
6491 * Checks whether the heap is empty.
6492 * @link http://www.php.net/manual/en/splheap.isempty.php
6493 * @return bool whether the heap is empty.
6494 */
6495 public function isEmpty () {}
6496
6497 /**
6498 * Rewind iterator back to the start (no-op)
6499 * @link http://www.php.net/manual/en/splheap.rewind.php
6500 * @return void
6501 */
6502 public function rewind () {}
6503
6504 /**
6505 * Return current node pointed by the iterator
6506 * @link http://www.php.net/manual/en/splheap.current.php
6507 * @return mixed The current node value.
6508 */
6509 public function current () {}
6510
6511 /**
6512 * Return current node index
6513 * @link http://www.php.net/manual/en/splheap.key.php
6514 * @return mixed The current node index.
6515 */
6516 public function key () {}
6517
6518 /**
6519 * Move to the next node
6520 * @link http://www.php.net/manual/en/splheap.next.php
6521 * @return void
6522 */
6523 public function next () {}
6524
6525 /**
6526 * Check whether the heap contains more nodes
6527 * @link http://www.php.net/manual/en/splheap.valid.php
6528 * @return bool true if the heap contains any more nodes, false otherwise.
6529 */
6530 public function valid () {}
6531
6532 /**
6533 * Recover from the corrupted state and allow further actions on the heap.
6534 * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php
6535 * @return void
6536 */
6537 public function recoverFromCorruption () {}
6538
6539 }
6540
6541 class SplMaxHeap extends SplHeap implements Countable, Traversable, Iterator {
6542
6543 /**
6544 * Compare elements in order to place them correctly in the heap while sifting up.
6545 * @link http://www.php.net/manual/en/splmaxheap.compare.php
6546 * @param value1 mixed <p>
6547 * The value of the first node being compared.
6548 * </p>
6549 * @param value2 mixed <p>
6550 * The value of the second node being compared.
6551 * </p>
6552 * @return int Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise.
6553 * </p>
6554 *
6555 * <p>
6556 * Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
6557 */
6558 protected function compare ($value1, $value2) {}
6559
6560 /**
6561 * Extracts a node from top of the heap and sift up.
6562 * @link http://www.php.net/manual/en/splheap.extract.php
6563 * @return mixed The value of the extracted node.
6564 */
6565 public function extract () {}
6566
6567 /**
6568 * Inserts an element in the heap by sifting it up.
6569 * @link http://www.php.net/manual/en/splheap.insert.php
6570 * @param value mixed <p>
6571 * The value to insert.
6572 * </p>
6573 * @return void
6574 */
6575 public function insert ($value) {}
6576
6577 /**
6578 * Peeks at the node from the top of the heap
6579 * @link http://www.php.net/manual/en/splheap.top.php
6580 * @return mixed The value of the node on the top.
6581 */
6582 public function top () {}
6583
6584 /**
6585 * Counts the number of elements in the heap.
6586 * @link http://www.php.net/manual/en/splheap.count.php
6587 * @return int the number of elements in the heap.
6588 */
6589 public function count () {}
6590
6591 /**
6592 * Checks whether the heap is empty.
6593 * @link http://www.php.net/manual/en/splheap.isempty.php
6594 * @return bool whether the heap is empty.
6595 */
6596 public function isEmpty () {}
6597
6598 /**
6599 * Rewind iterator back to the start (no-op)
6600 * @link http://www.php.net/manual/en/splheap.rewind.php
6601 * @return void
6602 */
6603 public function rewind () {}
6604
6605 /**
6606 * Return current node pointed by the iterator
6607 * @link http://www.php.net/manual/en/splheap.current.php
6608 * @return mixed The current node value.
6609 */
6610 public function current () {}
6611
6612 /**
6613 * Return current node index
6614 * @link http://www.php.net/manual/en/splheap.key.php
6615 * @return mixed The current node index.
6616 */
6617 public function key () {}
6618
6619 /**
6620 * Move to the next node
6621 * @link http://www.php.net/manual/en/splheap.next.php
6622 * @return void
6623 */
6624 public function next () {}
6625
6626 /**
6627 * Check whether the heap contains more nodes
6628 * @link http://www.php.net/manual/en/splheap.valid.php
6629 * @return bool true if the heap contains any more nodes, false otherwise.
6630 */
6631 public function valid () {}
6632
6633 /**
6634 * Recover from the corrupted state and allow further actions on the heap.
6635 * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php
6636 * @return void
6637 */
6638 public function recoverFromCorruption () {}
6639
6640 }
6641
6642 class SplPriorityQueue implements Iterator, Traversable, Countable {
6643 const EXTR_BOTH = 3;
6644 const EXTR_PRIORITY = 2;
6645 const EXTR_DATA = 1;
6646
6647
6648 /**
6649 * Compare priorities in order to place elements correctly in the heap while sifting up.
6650 * @link http://www.php.net/manual/en/splpriorityqueue.compare.php
6651 * @param priority1 mixed <p>
6652 * The priority of the first node being compared.
6653 * </p>
6654 * @param priority2 mixed <p>
6655 * The priority of the second node being compared.
6656 * </p>
6657 * @return int Result of the comparison, positive integer if priority1 is greater than priority2, 0 if they are equal, negative integer otherwise.
6658 * </p>
6659 *
6660 * <p>
6661 * Multiple elements with the same priority will get dequeued in no particular order.
6662 */
6663 public function compare ($priority1, $priority2) {}
6664
6665 /**
6666 * Inserts an element in the queue by sifting it up.
6667 * @link http://www.php.net/manual/en/splpriorityqueue.insert.php
6668 * @param value mixed <p>
6669 * The value to insert.
6670 * </p>
6671 * @param priority mixed <p>
6672 * The associated priority.
6673 * </p>
6674 * @return void
6675 */
6676 public function insert ($value, $priority) {}
6677
6678 /**
6679 * Sets the mode of extraction
6680 * @link http://www.php.net/manual/en/splpriorityqueue.setextractflags.php
6681 * @param flags int <p>
6682 * Defines what is extracted by SplPriorityQueue::current,
6683 * SplPriorityQueue::top and
6684 * SplPriorityQueue::extract.
6685 * </p>
6686 *
6687 * SplPriorityQueue::EXTR_DATA (0x00000001): Extract the data
6688 * @return void
6689 */
6690 public function setExtractFlags ($flags) {}
6691
6692 /**
6693 * Peeks at the node from the top of the queue
6694 * @link http://www.php.net/manual/en/splpriorityqueue.top.php
6695 * @return mixed The value or priority (or both) of the top node, depending on the extract flag.
6696 */
6697 public function top () {}
6698
6699 /**
6700 * Extracts a node from top of the heap and sift up.
6701 * @link http://www.php.net/manual/en/splpriorityqueue.extract.php
6702 * @return mixed The value or priority (or both) of the extracted node, depending on the extract flag.
6703 */
6704 public function extract () {}
6705
6706 /**
6707 * Counts the number of elements in the queue.
6708 * @link http://www.php.net/manual/en/splpriorityqueue.count.php
6709 * @return int the number of elements in the queue.
6710 */
6711 public function count () {}
6712
6713 /**
6714 * Checks whether the queue is empty.
6715 * @link http://www.php.net/manual/en/splpriorityqueue.isempty.php
6716 * @return bool whether the queue is empty.
6717 */
6718 public function isEmpty () {}
6719
6720 /**
6721 * Rewind iterator back to the start (no-op)
6722 * @link http://www.php.net/manual/en/splpriorityqueue.rewind.php
6723 * @return void
6724 */
6725 public function rewind () {}
6726
6727 /**
6728 * Return current node pointed by the iterator
6729 * @link http://www.php.net/manual/en/splpriorityqueue.current.php
6730 * @return mixed The value or priority (or both) of the current node, depending on the extract flag.
6731 */
6732 public function current () {}
6733
6734 /**
6735 * Return current node index
6736 * @link http://www.php.net/manual/en/splpriorityqueue.key.php
6737 * @return mixed The current node index.
6738 */
6739 public function key () {}
6740
6741 /**
6742 * Move to the next node
6743 * @link http://www.php.net/manual/en/splpriorityqueue.next.php
6744 * @return void
6745 */
6746 public function next () {}
6747
6748 /**
6749 * Check whether the queue contains more nodes
6750 * @link http://www.php.net/manual/en/splpriorityqueue.valid.php
6751 * @return bool true if the queue contains any more nodes, false otherwise.
6752 */
6753 public function valid () {}
6754
6755 /**
6756 * Recover from the corrupted state and allow further actions on the queue.
6757 * @link http://www.php.net/manual/en/splpriorityqueue.recoverfromcorruption.php
6758 * @return void
6759 */
6760 public function recoverFromCorruption () {}
6761
6762 }
6763
6764 class SplFixedArray implements Iterator, Traversable, ArrayAccess, Countable {
6765
6766 /**
6767 * Constructs a new fixed array
6768 * @link http://www.php.net/manual/en/splfixedarray.construct.php
6769 * @param size[optional]
6770 */
6771 public function __construct ($size) {}
6772
6773 /**
6774 * Reinitialises the array after being unserialised
6775 * @link http://www.php.net/manual/en/splfixedarray.wakeup.php
6776 * @return void
6777 */
6778 public function __wakeup () {}
6779
6780 /**
6781 * Returns the size of the array
6782 * @link http://www.php.net/manual/en/splfixedarray.count.php
6783 * @return int the size of the array.
6784 */
6785 public function count () {}
6786
6787 /**
6788 * Returns a PHP array from the fixed array
6789 * @link http://www.php.net/manual/en/splfixedarray.toarray.php
6790 * @return array a PHP array, similar to the fixed array.
6791 */
6792 public function toArray () {}
6793
6794 /**
6795 * Import a PHP array in a <classname>SplFixedArray</classname> instance
6796 * @link http://www.php.net/manual/en/splfixedarray.fromarray.php
6797 * @param array array <p>
6798 * The array to import.
6799 * </p>
6800 * @param save_indexes bool[optional] <p>
6801 * Try to save the numeric indexes used in the original array.
6802 * </p>
6803 * @return SplFixedArray an instance of SplFixedArray
6804 * containing the array content.
6805 */
6806 public static function fromArray (array $array, $save_indexes = null) {}
6807
6808 /**
6809 * Gets the size of the array
6810 * @link http://www.php.net/manual/en/splfixedarray.getsize.php
6811 * @return int the size of the array, as an integer.
6812 */
6813 public function getSize () {}
6814
6815 /**
6816 * Change the size of an array
6817 * @link http://www.php.net/manual/en/splfixedarray.setsize.php
6818 * @param size int <p>
6819 * The new array size. This should be a value between 0 and PHP_INT_MAX.
6820 * </p>
6821 * @return int
6822 */
6823 public function setSize ($size) {}
6824
6825 /**
6826 * Returns whether the requested index exists
6827 * @link http://www.php.net/manual/en/splfixedarray.offsetexists.php
6828 * @param index int <p>
6829 * The index being checked.
6830 * </p>
6831 * @return bool true if the requested index exists, otherwise false
6832 */
6833 public function offsetExists ($index) {}
6834
6835 /**
6836 * Returns the value at the specified index
6837 * @link http://www.php.net/manual/en/splfixedarray.offsetget.php
6838 * @param index int <p>
6839 * The index with the value.
6840 * </p>
6841 * @return mixed The value at the specified index.
6842 */
6843 public function offsetGet ($index) {}
6844
6845 /**
6846 * Sets a new value at a specified index
6847 * @link http://www.php.net/manual/en/splfixedarray.offsetset.php
6848 * @param index int <p>
6849 * The index being set.
6850 * </p>
6851 * @param newval mixed <p>
6852 * The new value for the index.
6853 * </p>
6854 * @return void
6855 */
6856 public function offsetSet ($index, $newval) {}
6857
6858 /**
6859 * Unsets the value at the specified $index
6860 * @link http://www.php.net/manual/en/splfixedarray.offsetunset.php
6861 * @param index int <p>
6862 * The index being unset.
6863 * </p>
6864 * @return void
6865 */
6866 public function offsetUnset ($index) {}
6867
6868 /**
6869 * Rewind iterator back to the start
6870 * @link http://www.php.net/manual/en/splfixedarray.rewind.php
6871 * @return void
6872 */
6873 public function rewind () {}
6874
6875 /**
6876 * Return current array entry
6877 * @link http://www.php.net/manual/en/splfixedarray.current.php
6878 * @return mixed The current element value.
6879 */
6880 public function current () {}
6881
6882 /**
6883 * Return current array index
6884 * @link http://www.php.net/manual/en/splfixedarray.key.php
6885 * @return int The current array index.
6886 */
6887 public function key () {}
6888
6889 /**
6890 * Move to next entry
6891 * @link http://www.php.net/manual/en/splfixedarray.next.php
6892 * @return void
6893 */
6894 public function next () {}
6895
6896 /**
6897 * Check whether the array contains more elements
6898 * @link http://www.php.net/manual/en/splfixedarray.valid.php
6899 * @return bool true if the array contains any more elements, false otherwise.
6900 */
6901 public function valid () {}
6902
6903 }
6904
6905 interface SplObserver {
6906
6907 /**
6908 * Receive update from subject
6909 * @link http://www.php.net/manual/en/splobserver.update.php
6910 * @param subject SplSubject <p>
6911 * The SplSubject notifying the observer of an update.
6912 * </p>
6913 * @return void
6914 */
6915 abstract public function update ($subject) ;
6916
6917 }
6918
6919 interface SplSubject {
6920
6921 /**
6922 * Attach an SplObserver
6923 * @link http://www.php.net/manual/en/splsubject.attach.php
6924 * @param observer SplObserver <p>
6925 * The SplObserver to attach.
6926 * </p>
6927 * @return void
6928 */
6929 abstract public function attach ($observer) ;
6930
6931 /**
6932 * Detach an observer
6933 * @link http://www.php.net/manual/en/splsubject.detach.php
6934 * @param observer SplObserver <p>
6935 * The SplObserver to detach.
6936 * </p>
6937 * @return void
6938 */
6939 abstract public function detach ($observer) ;
6940
6941 /**
6942 * Notify an observer
6943 * @link http://www.php.net/manual/en/splsubject.notify.php
6944 * @return void
6945 */
6946 abstract public function notify () ;
6947
6948 }
6949
6950 class SplObjectStorage implements Countable, Iterator, Traversable, Serializable, ArrayAccess {
6951
6952 /**
6953 * Adds an object in the storage
6954 * @link http://www.php.net/manual/en/splobjectstorage.attach.php
6955 * @param object object <p>
6956 * The object to add.
6957 * </p>
6958 * @param data mixed[optional] <p>
6959 * The data to associate with the object.
6960 * </p>
6961 * @return void
6962 */
6963 public function attach ($object, $data = null) {}
6964
6965 /**
6966 * Removes an <type>object</type> from the storage
6967 * @link http://www.php.net/manual/en/splobjectstorage.detach.php
6968 * @param object object <p>
6969 * The object to remove.
6970 * </p>
6971 * @return void
6972 */
6973 public function detach ($object) {}
6974
6975 /**
6976 * Checks if the storage contains a specific object
6977 * @link http://www.php.net/manual/en/splobjectstorage.contains.php
6978 * @param object object <p>
6979 * The object to look for.
6980 * </p>
6981 * @return bool true if the object is in the storage, false otherwise.
6982 */
6983 public function contains ($object) {}
6984
6985 /**
6986 * Adds all objects from another storage
6987 * @link http://www.php.net/manual/en/splobjectstorage.addall.php
6988 * @param storage SplObjectStorage <p>
6989 * The storage you want to import.
6990 * </p>
6991 * @return void
6992 */
6993 public function addAll (SplObjectStorage $storage) {}
6994
6995 /**
6996 * Removes objects contained in another storage from the current storage
6997 * @link http://www.php.net/manual/en/splobjectstorage.removeall.php
6998 * @param storage SplObjectStorage <p>
6999 * The storage containing the elements to remove.
7000 * </p>
7001 * @return void
7002 */
7003 public function removeAll (SplObjectStorage $storage) {}
7004
7005 /**
7006 * Removes all objects except for those contained in another storage from the current storage
7007 * @link http://www.php.net/manual/en/splobjectstorage.removeallexcept.php
7008 * @param storage SplObjectStorage <p>
7009 * The storage containing the elements to retain in the current storage.
7010 * </p>
7011 * @return void
7012 */
7013 public function removeAllExcept (SplObjectStorage $storage) {}
7014
7015 /**
7016 * Returns the data associated with the current iterator entry
7017 * @link http://www.php.net/manual/en/splobjectstorage.getinfo.php
7018 * @return mixed The data associated with the current iterator position.
7019 */
7020 public function getInfo () {}
7021
7022 /**
7023 * Sets the data associated with the current iterator entry
7024 * @link http://www.php.net/manual/en/splobjectstorage.setinfo.php
7025 * @param data mixed <p>
7026 * The data to associate with the current iterator entry.
7027 * </p>
7028 * @return void
7029 */
7030 public function setInfo ($data) {}
7031
7032 /**
7033 * Calculate a unique identifier for the contained objects
7034 * @link http://www.php.net/manual/en/splobjectstorage.gethash.php
7035 * @param object object <p>
7036 * The object whose identifier is to be calculated.
7037 * </p>
7038 * @return string A string with the calculated identifier.
7039 */
7040 public function getHash ($object) {}
7041
7042 /**
7043 * Returns the number of objects in the storage
7044 * @link http://www.php.net/manual/en/splobjectstorage.count.php
7045 * @return int The number of objects in the storage.
7046 */
7047 public function count () {}
7048
7049 /**
7050 * Rewind the iterator to the first storage element
7051 * @link http://www.php.net/manual/en/splobjectstorage.rewind.php
7052 * @return void
7053 */
7054 public function rewind () {}
7055
7056 /**
7057 * Returns if the current iterator entry is valid
7058 * @link http://www.php.net/manual/en/splobjectstorage.valid.php
7059 * @return bool true if the iterator entry is valid, false otherwise.
7060 */
7061 public function valid () {}
7062
7063 /**
7064 * Returns the index at which the iterator currently is
7065 * @link http://www.php.net/manual/en/splobjectstorage.key.php
7066 * @return int The index corresponding to the position of the iterator.
7067 */
7068 public function key () {}
7069
7070 /**
7071 * Returns the current storage entry
7072 * @link http://www.php.net/manual/en/splobjectstorage.current.php
7073 * @return object The object at the current iterator position.
7074 */
7075 public function current () {}
7076
7077 /**
7078 * Move to the next entry
7079 * @link http://www.php.net/manual/en/splobjectstorage.next.php
7080 * @return void
7081 */
7082 public function next () {}
7083
7084 /**
7085 * Unserializes a storage from its string representation
7086 * @link http://www.php.net/manual/en/splobjectstorage.unserialize.php
7087 * @param serialized string <p>
7088 * The serialized representation of a storage.
7089 * </p>
7090 * @return void
7091 */
7092 public function unserialize ($serialized) {}
7093
7094 /**
7095 * Serializes the storage
7096 * @link http://www.php.net/manual/en/splobjectstorage.serialize.php
7097 * @return string A string representing the storage.
7098 */
7099 public function serialize () {}
7100
7101 /**
7102 * Checks whether an object exists in the storage
7103 * @link http://www.php.net/manual/en/splobjectstorage.offsetexists.php
7104 * @param object object <p>
7105 * The object to look for.
7106 * </p>
7107 * @return bool true if the object exists in the storage,
7108 * and false otherwise.
7109 */
7110 public function offsetExists ($object) {}
7111
7112 /**
7113 * Associates data to an object in the storage
7114 * @link http://www.php.net/manual/en/splobjectstorage.offsetset.php
7115 * @param object object <p>
7116 * The object to associate data with.
7117 * </p>
7118 * @param data mixed[optional] <p>
7119 * The data to associate with the object.
7120 * </p>
7121 * @return void
7122 */
7123 public function offsetSet ($object, $data = null) {}
7124
7125 /**
7126 * Removes an object from the storage
7127 * @link http://www.php.net/manual/en/splobjectstorage.offsetunset.php
7128 * @param object object <p>
7129 * The object to remove.
7130 * </p>
7131 * @return void
7132 */
7133 public function offsetUnset ($object) {}
7134
7135 /**
7136 * Returns the data associated with an <type>object</type>
7137 * @link http://www.php.net/manual/en/splobjectstorage.offsetget.php
7138 * @param object object <p>
7139 * The object to look for.
7140 * </p>
7141 * @return mixed The data previously associated with the object in the storage.
7142 */
7143 public function offsetGet ($object) {}
7144
7145 }
7146
7147 class MultipleIterator implements Iterator, Traversable {
7148 const MIT_NEED_ANY = 0;
7149 const MIT_NEED_ALL = 1;
7150 const MIT_KEYS_NUMERIC = 0;
7151 const MIT_KEYS_ASSOC = 2;
7152
7153
7154 /**
7155 * Constructs a new MultipleIterator
7156 * @link http://www.php.net/manual/en/multipleiterator.construct.php
7157 * @param flags
7158 */
7159 public function __construct ($flags) {}
7160
7161 /**
7162 * Gets the flag information
7163 * @link http://www.php.net/manual/en/multipleiterator.getflags.php
7164 * @return void Information about the flags, as an integer.
7165 */
7166 public function getFlags () {}
7167
7168 /**
7169 * Sets flags
7170 * @link http://www.php.net/manual/en/multipleiterator.setflags.php
7171 * @param flags int <p>
7172 * The flags to set, according to the
7173 * Flag Constants
7174 * </p>
7175 * @return void
7176 */
7177 public function setFlags ($flags) {}
7178
7179 /**
7180 * Attaches iterator information
7181 * @link http://www.php.net/manual/en/multipleiterator.attachiterator.php
7182 * @param iterator Iterator <p>
7183 * The new iterator to attach.
7184 * </p>
7185 * @param infos string[optional] <p>
7186 * The associative information for the Iterator, which must be an
7187 * integer, a string, or &null;.
7188 * </p>
7189 * @return void Description...
7190 */
7191 public function attachIterator ($iterator, $infos = null) {}
7192
7193 /**
7194 * Detaches an iterator
7195 * @link http://www.php.net/manual/en/multipleiterator.detachiterator.php
7196 * @param iterator Iterator <p>
7197 * The iterator to detach.
7198 * </p>
7199 * @return void
7200 */
7201 public function detachIterator ($iterator) {}
7202
7203 /**
7204 * Checks if an iterator is attached
7205 * @link http://www.php.net/manual/en/multipleiterator.containsiterator.php
7206 * @param iterator Iterator <p>
7207 * The iterator to check.
7208 * </p>
7209 * @return void Returns true on success, false on failure.
7210 */
7211 public function containsIterator ($iterator) {}
7212
7213 /**
7214 * Gets the number of attached iterator instances
7215 * @link http://www.php.net/manual/en/multipleiterator.countiterators.php
7216 * @return void The number of attached iterator instances (as an integer).
7217 */
7218 public function countIterators () {}
7219
7220 /**
7221 * Rewinds all attached iterator instances
7222 * @link http://www.php.net/manual/en/multipleiterator.rewind.php
7223 * @return void
7224 */
7225 public function rewind () {}
7226
7227 /**
7228 * Checks the validity of sub iterators
7229 * @link http://www.php.net/manual/en/multipleiterator.valid.php
7230 * @return void true if one or all sub iterators are valid depending on flags,
7231 * otherwise false
7232 */
7233 public function valid () {}
7234
7235 /**
7236 * Gets the registered iterator instances
7237 * @link http://www.php.net/manual/en/multipleiterator.key.php
7238 * @return array An array of all registered iterator instances,
7239 * or false if no sub iterator is attached.
7240 */
7241 public function key () {}
7242
7243 /**
7244 * Gets the registered iterator instances
7245 * @link http://www.php.net/manual/en/multipleiterator.current.php
7246 * @return array An array containing the current values of each attached iterator,
7247 * or false if no iterators are attached.
7248 */
7249 public function current () {}
7250
7251 /**
7252 * Moves all attached iterator instances forward
7253 * @link http://www.php.net/manual/en/multipleiterator.next.php
7254 * @return void
7255 */
7256 public function next () {}
7257
7258 }
7259
7260 /**
7261 * Return available SPL classes
7262 * @link http://www.php.net/manual/en/function.spl-classes.php
7263 * @return array an array containing the currently available SPL classes.
7264 */
7265 function spl_classes () {}
7266
7267 /**
7268 * Default implementation for __autoload()
7269 * @link http://www.php.net/manual/en/function.spl-autoload.php
7270 * @param class_name string <p>
7271 * The lowercased name of the class (and namespace) being instantiated.
7272 * </p>
7273 * @param file_extensions string[optional] <p>
7274 * By default it checks all include paths to
7275 * contain filenames built up by the lowercase class name appended by the
7276 * filename extensions .inc and .php.
7277 * </p>
7278 * @return void
7279 */
7280 function spl_autoload ($class_name, $file_extensions = null) {}
7281
7282 /**
7283 * Register and return default file extensions for spl_autoload
7284 * @link http://www.php.net/manual/en/function.spl-autoload-extensions.php
7285 * @param file_extensions string[optional] <p>
7286 * When calling without an argument, it simply returns the current list
7287 * of extensions each separated by comma. To modify the list of file
7288 * extensions, simply invoke the functions with the new list of file
7289 * extensions to use in a single string with each extensions separated
7290 * by comma.
7291 * </p>
7292 * @return string A comma delimited list of default file extensions for
7293 * spl_autoload.
7294 */
7295 function spl_autoload_extensions ($file_extensions = null) {}
7296
7297 /**
7298 * Register given function as __autoload() implementation
7299 * @link http://www.php.net/manual/en/function.spl-autoload-register.php
7300 * @param autoload_function callable[optional] <p>
7301 * The autoload function being registered.
7302 * If no parameter is provided, then the default implementation of
7303 * spl_autoload will be registered.
7304 * </p>
7305 * @param throw bool[optional] <p>
7306 * This parameter specifies whether
7307 * spl_autoload_register should throw
7308 * exceptions when the autoload_function
7309 * cannot be registered.
7310 * </p>
7311 * @param prepend bool[optional] <p>
7312 * If true, spl_autoload_register will prepend
7313 * the autoloader on the autoload queue instead of appending it.
7314 * </p>
7315 * @return bool Returns true on success, false on failure.
7316 */
7317 function spl_autoload_register ($autoload_function = null, $throw = null, $prepend = null) {}
7318
7319 /**
7320 * Unregister given function as __autoload() implementation
7321 * @link http://www.php.net/manual/en/function.spl-autoload-unregister.php
7322 * @param autoload_function mixed <p>
7323 * The autoload function being unregistered.
7324 * </p>
7325 * @return bool Returns true on success, false on failure.
7326 */
7327 function spl_autoload_unregister ($autoload_function) {}
7328
7329 /**
7330 * Return all registered __autoload() functions
7331 * @link http://www.php.net/manual/en/function.spl-autoload-functions.php
7332 * @return array An array of all registered __autoload functions.
7333 * If the autoload queue is not activated then the return value is false.
7334 * If no function is registered the return value will be an empty array.
7335 */
7336 function spl_autoload_functions () {}
7337
7338 /**
7339 * Try all registered __autoload() function to load the requested class
7340 * @link http://www.php.net/manual/en/function.spl-autoload-call.php
7341 * @param class_name string <p>
7342 * The class name being searched.
7343 * </p>
7344 * @return void
7345 */
7346 function spl_autoload_call ($class_name) {}
7347
7348 /**
7349 * Return the parent classes of the given class
7350 * @link http://www.php.net/manual/en/function.class-parents.php
7351 * @param class mixed <p>
7352 * An object (class instance) or a string (class name).
7353 * </p>
7354 * @param autoload bool[optional] <p>
7355 * Whether to allow this function to load the class automatically through
7356 * the __autoload magic method.
7357 * </p>
7358 * @return array An array on success, or false on error.
7359 */
7360 function class_parents ($class, $autoload = null) {}
7361
7362 /**
7363 * Return the interfaces which are implemented by the given class
7364 * @link http://www.php.net/manual/en/function.class-implements.php
7365 * @param class mixed <p>
7366 * An object (class instance) or a string (class name).
7367 * </p>
7368 * @param autoload bool[optional] <p>
7369 * Whether to allow this function to load the class automatically through
7370 * the __autoload magic method.
7371 * </p>
7372 * @return array An array on success, or false on error.
7373 */
7374 function class_implements ($class, $autoload = null) {}
7375
7376 /**
7377 * Return the traits used by the given class
7378 * @link http://www.php.net/manual/en/function.class-uses.php
7379 * @param class mixed <p>
7380 * An object (class instance) or a string (class name).
7381 * </p>
7382 * @param autoload bool[optional] <p>
7383 * Whether to allow this function to load the class automatically through
7384 * the __autoload magic method.
7385 * </p>
7386 * @return array An array on success, or false on error.
7387 */
7388 function class_uses ($class, $autoload = null) {}
7389
7390 /**
7391 * Return hash id for given object
7392 * @link http://www.php.net/manual/en/function.spl-object-hash.php
7393 * @param obj object
7394 * @return string A string that is unique for each currently existing object and is always
7395 * the same for each object.
7396 */
7397 function spl_object_hash ($obj) {}
7398
7399 /**
7400 * Copy the iterator into an array
7401 * @link http://www.php.net/manual/en/function.iterator-to-array.php
7402 * @param iterator Traversable <p>
7403 * The iterator being copied.
7404 * </p>
7405 * @param use_keys bool[optional] <p>
7406 * Whether to use the iterator element keys as index.
7407 * </p>
7408 * <p>
7409 * In PHP 5.5 and later, if a key is an array or
7410 * object, a warning will be generated. &null; keys will be
7411 * converted to an empty string, double keys will be
7412 * truncated to their integer counterpart,
7413 * resource keys will generate a warning and be converted to
7414 * their resource ID, and boolean keys will be converted to
7415 * integers.
7416 * </p>
7417 * @return array An array containing the elements of the iterator.
7418 */
7419 function iterator_to_array ($iterator, $use_keys = null) {}
7420
7421 /**
7422 * Count the elements in an iterator
7423 * @link http://www.php.net/manual/en/function.iterator-count.php
7424 * @param iterator Traversable <p>
7425 * The iterator being counted.
7426 * </p>
7427 * @return int The number of elements in iterator.
7428 */
7429 function iterator_count ($iterator) {}
7430
7431 /**
7432 * Call a function for every element in an iterator
7433 * @link http://www.php.net/manual/en/function.iterator-apply.php
7434 * @param iterator Traversable <p>
7435 * The class to iterate over.
7436 * </p>
7437 * @param function callable <p>
7438 * The callback function to call on every element.
7439 *
7440 *
7441 * The function must return true in order to
7442 * continue iterating over the iterator.
7443 *
7444 *
7445 * </p>
7446 * @param args array[optional] <p>
7447 * Arguments to pass to the callback function.
7448 * </p>
7449 * @return int the iteration count.
7450 */
7451 function iterator_apply ($iterator, $function, array $args = null) {}
7452
7453 // End of SPL v.0.2
7454 ?>