forked from JetBrains/phpstorm-stubs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SPL_c1.php
2263 lines (2004 loc) · 76.2 KB
/
SPL_c1.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// Start of SPL v.0.2
/**
* The SplFileInfo class offers a high-level object oriented interface to
* information for an individual file.
* @link http://php.net/manual/en/class.splfileinfo.php
*/
class SplFileInfo {
/**
* (PHP 5 >= 5.1.2)<br/>
* Construct a new SplFileInfo object
* @link http://php.net/manual/en/splfileinfo.construct.php
* @param $file_name
*/
public function __construct ($file_name) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the path without filename
* @link http://php.net/manual/en/splfileinfo.getpath.php
* @return string the path to the file.
*/
public function getPath () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the filename
* @link http://php.net/manual/en/splfileinfo.getfilename.php
* @return string The filename.
*/
public function getFilename () {}
/**
* (PHP 5 >= 5.3.6)<br/>
* Gets the file extension
* @link http://php.net/manual/en/splfileinfo.getextension.php
* @return string a string containing the file extension, or an
* empty string if the file has no extension.
*/
public function getExtension () {}
/**
* (PHP 5 >= 5.2.2)<br/>
* Gets the base name of the file
* @link http://php.net/manual/en/splfileinfo.getbasename.php
* @param string $suffix [optional] <p>
* Optional suffix to omit from the base name returned.
* </p>
* @return string the base name without path information.
*/
public function getBasename ($suffix = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the path to the file
* @link http://php.net/manual/en/splfileinfo.getpathname.php
* @return string The path to the file.
*/
public function getPathname () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets file permissions
* @link http://php.net/manual/en/splfileinfo.getperms.php
* @return int the file permissions.
*/
public function getPerms () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the inode for the file
* @link http://php.net/manual/en/splfileinfo.getinode.php
* @return int the inode number for the filesystem object.
*/
public function getInode () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets file size
* @link http://php.net/manual/en/splfileinfo.getsize.php
* @return int The filesize in bytes.
*/
public function getSize () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the owner of the file
* @link http://php.net/manual/en/splfileinfo.getowner.php
* @return int The owner id in numerical format.
*/
public function getOwner () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the file group
* @link http://php.net/manual/en/splfileinfo.getgroup.php
* @return int The group id in numerical format.
*/
public function getGroup () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets last access time of the file
* @link http://php.net/manual/en/splfileinfo.getatime.php
* @return int the time the file was last accessed.
*/
public function getATime () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the last modified time
* @link http://php.net/manual/en/splfileinfo.getmtime.php
* @return int the last modified time for the file, in a Unix timestamp.
*/
public function getMTime () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets the inode change time
* @link http://php.net/manual/en/splfileinfo.getctime.php
* @return int The last change time, in a Unix timestamp.
*/
public function getCTime () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets file type
* @link http://php.net/manual/en/splfileinfo.gettype.php
* @return string A string representing the type of the entry.
* May be one of file, link,
* or dir
*/
public function getType () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if the entry is writable
* @link http://php.net/manual/en/splfileinfo.iswritable.php
* @return bool true if writable, false otherwise;
*/
public function isWritable () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if file is readable
* @link http://php.net/manual/en/splfileinfo.isreadable.php
* @return bool true if readable, false otherwise.
*/
public function isReadable () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if the file is executable
* @link http://php.net/manual/en/splfileinfo.isexecutable.php
* @return bool true if executable, false otherwise.
*/
public function isExecutable () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if the object references a regular file
* @link http://php.net/manual/en/splfileinfo.isfile.php
* @return bool true if the file exists and is a regular file (not a link), false otherwise.
*/
public function isFile () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if the file is a directory
* @link http://php.net/manual/en/splfileinfo.isdir.php
* @return bool true if a directory, false otherwise.
*/
public function isDir () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Tells if the file is a link
* @link http://php.net/manual/en/splfileinfo.islink.php
* @return bool true if the file is a link, false otherwise.
*/
public function isLink () {}
/**
* (PHP 5 >= 5.2.2)<br/>
* Gets the target of a link
* @link http://php.net/manual/en/splfileinfo.getlinktarget.php
* @return string the target of the filesystem link.
*/
public function getLinkTarget () {}
/**
* (PHP 5 >= 5.2.2)<br/>
* Gets absolute path to file
* @link http://php.net/manual/en/splfileinfo.getrealpath.php
* @return string the path to the file.
*/
public function getRealPath () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets an SplFileInfo object for the file
* @link http://php.net/manual/en/splfileinfo.getfileinfo.php
* @param string $class_name [optional] <p>
* Name of an <b>SplFileInfo</b> derived class to use.
* </p>
* @return SplFileInfo An <b>SplFileInfo</b> object created for the file.
*/
public function getFileInfo ($class_name = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets an SplFileInfo object for the path
* @link http://php.net/manual/en/splfileinfo.getpathinfo.php
* @param string $class_name [optional] <p>
* Name of an <b>SplFileInfo</b> derived class to use.
* </p>
* @return SplFileInfo an <b>SplFileInfo</b> object for the parent path of the file.
*/
public function getPathInfo ($class_name = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Gets an SplFileObject object for the file
* @link http://php.net/manual/en/splfileinfo.openfile.php
* @param string $open_mode [optional] <p>
* The mode for opening the file. See the <b>fopen</b>
* documentation for descriptions of possible modes. The default
* is read only.
* </p>
* @param bool $use_include_path [optional] <p>
* ¶meter.use_include_path;
* </p>
* @param resource $context [optional] <p>
* ¶meter.context;
* </p>
* @return SplFileObject The opened file as an <b>SplFileObject</b> object.
*/
public function openFile ($open_mode = 'r', $use_include_path = false, $context = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Sets the class name used with <b>SplFileInfo::openFile</b>
* @link http://php.net/manual/en/splfileinfo.setfileclass.php
* @param string $class_name [optional] <p>
* The class name to use when openFile() is called.
* </p>
* @return void
*/
public function setFileClass ($class_name = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Sets the class used with getFileInfo and getPathInfo
* @link http://php.net/manual/en/splfileinfo.setinfoclass.php
* @param string $class_name [optional] <p>
* The class name to use.
* </p>
* @return void
*/
public function setInfoClass ($class_name = null) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Returns the path to the file as a string
* @link http://php.net/manual/en/splfileinfo.tostring.php
* @return string the path to the file.
*/
public function __toString () {}
}
/**
* The DirectoryIterator class provides a simple interface for viewing
* the contents of filesystem directories.
* @link http://php.net/manual/en/class.directoryiterator.php
*/
class DirectoryIterator extends SplFileInfo implements Iterator, Traversable, SeekableIterator {
/**
* (PHP 5)<br/>
* Constructs a new directory iterator from a path
* @link http://php.net/manual/en/directoryiterator.construct.php
* @param $path
*/
public function __construct ($path) {}
/**
* (PHP 5)<br/>
* Determine if current DirectoryIterator item is '.' or '..'
* @link http://php.net/manual/en/directoryiterator.isdot.php
* @return bool true if the entry is . or ..,
* otherwise false
*/
public function isDot () {}
/**
* (PHP 5)<br/>
* Rewind the DirectoryIterator back to the start
* @link http://php.net/manual/en/directoryiterator.rewind.php
* @return void
*/
public function rewind () {}
/**
* (PHP 5)<br/>
* Check whether current DirectoryIterator position is a valid file
* @link http://php.net/manual/en/directoryiterator.valid.php
* @return bool true if the position is valid, otherwise false
*/
public function valid () {}
/**
* (PHP 5)<br/>
* Return the key for the current DirectoryIterator item
* @link http://php.net/manual/en/directoryiterator.key.php
* @return string The key for the current <b>DirectoryIterator</b> item.
*/
public function key () {}
/**
* (PHP 5)<br/>
* Return the current DirectoryIterator item.
* @link http://php.net/manual/en/directoryiterator.current.php
* @return DirectoryIterator The current <b>DirectoryIterator</b> item.
*/
public function current () {}
/**
* (PHP 5)<br/>
* Move forward to next DirectoryIterator item
* @link http://php.net/manual/en/directoryiterator.next.php
* @return void
*/
public function next () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Seek to a DirectoryIterator item
* @link http://php.net/manual/en/directoryiterator.seek.php
* @param int $position <p>
* The zero-based numeric position to seek to.
* </p>
* @return void
*/
public function seek ($position) {}
}
/**
* The Filesystem iterator
* @link http://php.net/manual/en/class.filesystemiterator.php
*/
class FilesystemIterator extends DirectoryIterator implements SeekableIterator, Traversable, Iterator {
const CURRENT_MODE_MASK = 240;
const CURRENT_AS_PATHNAME = 32;
const CURRENT_AS_FILEINFO = 0;
const CURRENT_AS_SELF = 16;
const KEY_MODE_MASK = 3840;
const KEY_AS_PATHNAME = 0;
const FOLLOW_SYMLINKS = 512;
const KEY_AS_FILENAME = 256;
const NEW_CURRENT_AND_KEY = 256;
const SKIP_DOTS = 4096;
const UNIX_PATHS = 8192;
/**
* (PHP 5 >= 5.3.0)<br/>
* Constructs a new filesystem iterator
* @link http://php.net/manual/en/filesystemiterator.construct.php
* @param $path
* @param $flags [optional]
*/
public function __construct ($path, $flags) {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Rewinds back to the beginning
* @link http://php.net/manual/en/filesystemiterator.rewind.php
* @return void
*/
public function rewind () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Move to the next file
* @link http://php.net/manual/en/filesystemiterator.next.php
* @return void
*/
public function next () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Retrieve the key for the current file
* @link http://php.net/manual/en/filesystemiterator.key.php
* @return string the pathname or filename depending on the set flags.
* See the FilesystemIterator constants.
*/
public function key () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* The current file
* @link http://php.net/manual/en/filesystemiterator.current.php
* @return mixed The filename, file information, or $this depending on the set flags.
* See the FilesystemIterator constants.
*/
public function current () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Get the handling flags
* @link http://php.net/manual/en/filesystemiterator.getflags.php
* @return int The integer value of the set flags.
*/
public function getFlags () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Sets handling flags
* @link http://php.net/manual/en/filesystemiterator.setflags.php
* @param int $flags [optional] <p>
* The handling flags to set.
* See the FilesystemIterator constants.
* </p>
* @return void
*/
public function setFlags ($flags = null) {}
}
/**
* The <b>RecursiveDirectoryIterator</b> provides
* an interface for iterating recursively over filesystem directories.
* @link http://php.net/manual/en/class.recursivedirectoryiterator.php
*/
class RecursiveDirectoryIterator extends FilesystemIterator implements Iterator, Traversable, SeekableIterator, RecursiveIterator {
/**
* (PHP 5 >= 5.1.2)<br/>
* Constructs a RecursiveDirectoryIterator
* @link http://php.net/manual/en/recursivedirectoryiterator.construct.php
* @param $path
* @param $flags [optional]
*/
public function __construct ($path, $flags) {}
/**
* (PHP 5)<br/>
* Returns whether current entry is a directory and not '.' or '..'
* @link http://php.net/manual/en/recursivedirectoryiterator.haschildren.php
* @param bool $allow_links [optional] <p>
* </p>
* @return bool whether the current entry is a directory, but not '.' or '..'
*/
public function hasChildren ($allow_links = null) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Returns an iterator for the current entry if it is a directory
* @link http://php.net/manual/en/recursivedirectoryiterator.getchildren.php
* @return object An iterator for the current entry, if it is a directory.
*/
public function getChildren () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Get sub path
* @link http://php.net/manual/en/recursivedirectoryiterator.getsubpath.php
* @return string The sub path (sub directory).
*/
public function getSubPath () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Get sub path and name
* @link http://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php
* @return string The sub path (sub directory) and filename.
*/
public function getSubPathname () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Rewinds back to the beginning
* @link http://php.net/manual/en/filesystemiterator.rewind.php
* @return void
*/
public function rewind () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Move to the next file
* @link http://php.net/manual/en/filesystemiterator.next.php
* @return void
*/
public function next () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Retrieve the key for the current file
* @link http://php.net/manual/en/filesystemiterator.key.php
* @return string the pathname or filename depending on the set flags.
* See the FilesystemIterator constants.
*/
public function key () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* The current file
* @link http://php.net/manual/en/filesystemiterator.current.php
* @return mixed The filename, file information, or $this depending on the set flags.
* See the FilesystemIterator constants.
*/
public function current () {}
}
/**
* Iterates through a file system in a similar fashion to
* <b>glob</b>.
* @link http://php.net/manual/en/class.globiterator.php
*/
class GlobIterator extends FilesystemIterator implements Iterator, Traversable, SeekableIterator, Countable {
/**
* (PHP 5 >= 5.3.0)<br/>
* Construct a directory using glob
* @link http://php.net/manual/en/globiterator.construct.php
* @param $path
* @param $flags [optional]
*/
public function __construct ($path, $flags) {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Get the number of directories and files
* @link http://php.net/manual/en/globiterator.count.php
* @return int The number of returned directories and files, as an
* integer.
*/
public function count () {}
}
/**
* The SplFileObject class offers an object oriented interface for a file.
* @link http://php.net/manual/en/class.splfileobject.php
*/
class SplFileObject extends SplFileInfo implements RecursiveIterator, Traversable, Iterator, SeekableIterator {
const DROP_NEW_LINE = 1;
const READ_AHEAD = 2;
const SKIP_EMPTY = 6;
const READ_CSV = 8;
/**
* (PHP 5 >= 5.1.0)<br/>
* Construct a new file object.
* @link http://php.net/manual/en/splfileobject.construct.php
* @param $file_name
* @param $open_mode [optional]
* @param $use_include_path [optional]
* @param $context [optional]
*/
public function __construct ($file_name, $open_mode, $use_include_path, $context) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Rewind the file to the first line
* @link http://php.net/manual/en/splfileobject.rewind.php
* @return void
*/
public function rewind () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Reached end of file
* @link http://php.net/manual/en/splfileobject.eof.php
* @return bool true if file is at EOF, false otherwise.
*/
public function eof () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Not at EOF
* @link http://php.net/manual/en/splfileobject.valid.php
* @return bool true if not reached EOF, false otherwise.
*/
public function valid () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets line from file
* @link http://php.net/manual/en/splfileobject.fgets.php
* @return string a string containing the next line from the file, or false on error.
*/
public function fgets () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets line from file and parse as CSV fields
* @link http://php.net/manual/en/splfileobject.fgetcsv.php
* @param string $delimiter [optional] <p>
* The field delimiter (one character only). Defaults as a comma or the value set using <b>SplFileObject::setCsvControl</b>.
* </p>
* @param string $enclosure [optional] <p>
* The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <b>SplFileObject::setCsvControl</b>.
* </p>
* @param string $escape [optional] <p>
* The escape character (one character only). Defaults as a backslash (\) or the value set using <b>SplFileObject::setCsvControl</b>.
* </p>
* @return array an indexed array containing the fields read, or false on error.
* </p>
* <p>
* A blank line in a CSV file will be returned as an array
* comprising a single null field unless using <b>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</b>,
* in which case empty lines are skipped.
*/
public function fgetcsv ($delimiter = ",", $enclosure = "\"", $escape = "\\") {}
/**
* PHP >= 5.4.0<br/>
* Write a field array as a CSV line
* @link http://php.net/manual/en/splfileobject.fputcsv.php
* @param array $fields <p>
* An array of values
*</p>
* @param string $delimiter [optional] <p>
* The field delimiter (one character only). Defaults as a comma or the value set using <b>SplFileObject::setCsvControl</b>.
* </p>
* @param string $enclosure [optional] <p>
* The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <b>SplFileObject::setCsvControl</b>.
* </p>
* @return int Returns the length of the written string or FALSE on failure.
*/
public function fputcsv (array $fields, $delimiter = ',' , $enclosure = '"') {}
/**
* (PHP 5 >= 5.2.0)<br/>
* Set the delimiter and enclosure character for CSV
* @link http://php.net/manual/en/splfileobject.setcsvcontrol.php
* @param string $delimiter [optional] <p>
* The field delimiter (one character only).
* </p>
* @param string $enclosure [optional] <p>
* The field enclosure character (one character only).
* </p>
* @param string $escape [optional] <p>
* The field escape character (one character only).
* </p>
* @return void
*/
public function setCsvControl ($delimiter = ",", $enclosure = "\"", $escape = "\\") {}
/**
* (PHP 5 >= 5.2.0)<br/>
* Get the delimiter and enclosure character for CSV
* @link http://php.net/manual/en/splfileobject.getcsvcontrol.php
* @return array an indexed array containing the delimiter and enclosure character.
*/
public function getCsvControl () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Portable file locking
* @link http://php.net/manual/en/splfileobject.flock.php
* @param int $operation <p>
* <i>operation</i> is one of the following:
* <b>LOCK_SH</b> to acquire a shared lock (reader).
* @param int $wouldblock [optional] <p>
* Set to true if the lock would block (EWOULDBLOCK errno condition).
* </p>
* @return bool true on success or false on failure.
*/
public function flock ($operation, &$wouldblock = null) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Flushes the output to the file
* @link http://php.net/manual/en/splfileobject.fflush.php
* @return bool true on success or false on failure.
*/
public function fflush () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Return current file position
* @link http://php.net/manual/en/splfileobject.ftell.php
* @return int the position of the file pointer as an integer, or false on error.
*/
public function ftell () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Seek to a position
* @link http://php.net/manual/en/splfileobject.fseek.php
* @param int $offset <p>
* The offset. A negative value can be used to move backwards through the file which
* is useful when SEEK_END is used as the <i>whence</i> value.
* </p>
* @param int $whence [optional] <p>
* <i>whence</i> values are:
* <b>SEEK_SET</b> - Set position equal to <i>offset</i> bytes.
* <b>SEEK_CUR</b> - Set position to current location plus <i>offset</i>.
* <b>SEEK_END</b> - Set position to end-of-file plus <i>offset</i>.
* </p>
* <p>
* If <i>whence</i> is not specified, it is assumed to be <b>SEEK_SET</b>.
* </p>
* @return int 0 if the seek was successful, -1 otherwise. Note that seeking
* past EOF is not considered an error.
*/
public function fseek ($offset, $whence = SEEK_SET) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets character from file
* @link http://php.net/manual/en/splfileobject.fgetc.php
* @return string a string containing a single character read from the file or false on EOF.
*/
public function fgetc () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Output all remaining data on a file pointer
* @link http://php.net/manual/en/splfileobject.fpassthru.php
* @return int the number of characters read from <i>handle</i>
* and passed through to the output.
*/
public function fpassthru () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets line from file and strip HTML tags
* @link http://php.net/manual/en/splfileobject.fgetss.php
* @param string $allowable_tags [optional] <p>
* You can use the optional third parameter to specify tags which should
* not be stripped.
* </p>
* @return string a string containing the next line of the file with HTML and PHP
* code stripped, or false on error.
*/
public function fgetss ($allowable_tags = null) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Parses input from file according to a format
* @link http://php.net/manual/en/splfileobject.fscanf.php
* @param string $format <p>
* The specified format as described in the <b>sprintf</b> documentation.
* </p>
* @param mixed $_ [optional] <p>
* The optional assigned values.
* </p>
* @return mixed If only one parameter is passed to this method, the values parsed will be
* returned as an array. Otherwise, if optional parameters are passed, the
* function will return the number of assigned values. The optional
* parameters must be passed by reference.
*/
public function fscanf ($format, &$_ = null) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Write to file
* @link http://php.net/manual/en/splfileobject.fwrite.php
* @param string $str <p>
* The string to be written to the file.
* </p>
* @param int $length [optional] <p>
* If the <i>length</i> argument is given, writing will
* stop after <i>length</i> bytes have been written or
* the end of <i>string</i> is reached, whichever comes
* first.
* </p>
* @return int the number of bytes written, or null on error.
*/
public function fwrite ($str, $length = null) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets information about the file
* @link http://php.net/manual/en/splfileobject.fstat.php
* @return array an array with the statistics of the file; the format of the array
* is described in detail on the <b>stat</b> manual page.
*/
public function fstat () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Truncates the file to a given length
* @link http://php.net/manual/en/splfileobject.ftruncate.php
* @param int $size <p>
* The size to truncate to.
* </p>
* <p>
* If <i>size</i> is larger than the file it is extended with null bytes.
* </p>
* <p>
* If <i>size</i> is smaller than the file, the extra data will be lost.
* </p>
* @return bool true on success or false on failure.
*/
public function ftruncate ($size) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Retrieve current line of file
* @link http://php.net/manual/en/splfileobject.current.php
* @return string|array Retrieves the current line of the file. If the <b>SplFileObject::READ_CSV</b> flag is set, this method returns an array containing the current line parsed as CSV data.
*/
public function current () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Get line number
* @link http://php.net/manual/en/splfileobject.key.php
* @return int the current line number.
*/
public function key () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Read next line
* @link http://php.net/manual/en/splfileobject.next.php
* @return void
*/
public function next () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Sets flags for the SplFileObject
* @link http://php.net/manual/en/splfileobject.setflags.php
* @param int $flags <p>
* Bit mask of the flags to set. See
* SplFileObject constants
* for the available flags.
* </p>
* @return void
*/
public function setFlags ($flags) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Gets flags for the SplFileObject
* @link http://php.net/manual/en/splfileobject.getflags.php
* @return int an integer representing the flags.
*/
public function getFlags () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Set maximum line length
* @link http://php.net/manual/en/splfileobject.setmaxlinelen.php
* @param int $max_len <p>
* The maximum length of a line.
* </p>
* @return void
*/
public function setMaxLineLen ($max_len) {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Get maximum line length
* @link http://php.net/manual/en/splfileobject.getmaxlinelen.php
* @return int the maximum line length if one has been set with
* <b>SplFileObject::setMaxLineLen</b>, default is 0.
*/
public function getMaxLineLen () {}
/**
* (PHP 5 >= 5.1.2)<br/>
* SplFileObject does not have children
* @link http://php.net/manual/en/splfileobject.haschildren.php
* @return bool false
*/
public function hasChildren () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* No purpose
* @link http://php.net/manual/en/splfileobject.getchildren.php
* @return null An SplFileObject does not have children so this method returns NULL.
*/
public function getChildren () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Seek to specified line
* @link http://php.net/manual/en/splfileobject.seek.php
* @param int $line_pos <p>
* The zero-based line number to seek to.
* </p>
* @return void
*/
public function seek ($line_pos) {}
/**
* (PHP 5 >= 5.1.2)<br/>
* Alias of <b>SplFileObject::fgets</b>
* @link http://php.net/manual/en/splfileobject.getcurrentline.php
* @return string Returns a string containing the next line from the file, or FALSE on error.
*/
public function getCurrentLine () {}
/**
* (PHP 5 >= 5.1.0)<br/>
* Alias of <b>SplFileObject::current</b>
* @link http://php.net/manual/en/splfileobject.tostring.php
*/
public function __toString () {}
}
/**
* The SplTempFileObject class offers an object oriented interface for a temporary file.
* @link http://php.net/manual/en/class.spltempfileobject.php
*/
class SplTempFileObject extends SplFileObject implements SeekableIterator, Iterator, Traversable, RecursiveIterator {
/**
* (PHP 5 >= 5.1.2)<br/>
* Construct a new temporary file object
* @link http://php.net/manual/en/spltempfileobject.construct.php
* @param $max_memory [optional]
*/
public function __construct ($max_memory) {}
}
/**
* The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
* @link http://php.net/manual/en/class.spldoublylinkedlist.php
*/
class SplDoublyLinkedList implements Iterator, Traversable, Countable, ArrayAccess {
const IT_MODE_LIFO = 2;
const IT_MODE_FIFO = 0;
const IT_MODE_DELETE = 1;
const IT_MODE_KEEP = 0;
/**
* (PHP 5 >= 5.5.0)<br/>
* Add/insert a new value at the specified index
* @param mixed $index The index where the new value is to be inserted.
* @param mixed $newval The new value for the index.
* @link http://php.net/spldoublylinkedlist.add
* @return void
*/
public function add($index, $newval) {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Pops a node from the end of the doubly linked list
* @link http://php.net/manual/en/spldoublylinkedlist.pop.php
* @return mixed The value of the popped node.
*/
public function pop () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Shifts a node from the beginning of the doubly linked list
* @link http://php.net/manual/en/spldoublylinkedlist.shift.php
* @return mixed The value of the shifted node.
*/
public function shift () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Pushes an element at the end of the doubly linked list
* @link http://php.net/manual/en/spldoublylinkedlist.push.php
* @param mixed $value <p>
* The value to push.
* </p>
* @return void
*/
public function push ($value) {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Prepends the doubly linked list with an element
* @link http://php.net/manual/en/spldoublylinkedlist.unshift.php
* @param mixed $value <p>
* The value to unshift.
* </p>
* @return void
*/
public function unshift ($value) {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Peeks at the node from the end of the doubly linked list
* @link http://php.net/manual/en/spldoublylinkedlist.top.php
* @return mixed The value of the last node.
*/
public function top () {}
/**
* (PHP 5 >= 5.3.0)<br/>
* Peeks at the node from the beginning of the doubly linked list