forked from HvyIndustries/crane-php-stubs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
oci8.php
2411 lines (2215 loc) · 74.8 KB
/
oci8.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 oci8 v.2.1.1
/**
* OCI8 LOB functionality for large binary (BLOB) and character (CLOB) objects.
* @link http://php.net/manual/en/class.OCI-Lob.php
*/
class OCI_Lob {
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns large object's contents
* @link http://php.net/manual/en/oci-lob.load.php
* @return string the contents of the object, or <b>FALSE</b> on errors.
*/
public function load(): string {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the current position of internal pointer of large object
* @link http://php.net/manual/en/oci-lob.tell.php
* @return int current position of a LOB's internal pointer or <b>FALSE</b> if an
* error occurred.
*/
public function tell(): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Truncates large object
* @link http://php.net/manual/en/oci-lob.truncate.php
* @param int $length [optional] <p>
* If provided, this method will truncate the LOB to
* <i>length</i> bytes. Otherwise, it will completely
* purge the LOB.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function truncate(int $length = 0): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Erases a specified portion of the internal LOB data
* @link http://php.net/manual/en/oci-lob.erase.php
* @param int $offset [optional]
* @param int $length [optional]
* @return int the actual number of characters/bytes erased or <b>FALSE</b> on failure.
*/
public function erase(int $offset = null, int $length = null): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Flushes/writes buffer of the LOB to the server
* @link http://php.net/manual/en/oci-lob.flush.php
* @param int $flag [optional] <p>
* By default, resources are not freed, but using flag
* <b>OCI_LOB_BUFFER_FREE</b> you can do it explicitly.
* Be sure you know what you're doing - next read/write operation to the
* same part of LOB will involve a round-trip to the server and initialize
* new buffer resources. It is recommended to use
* <b>OCI_LOB_BUFFER_FREE</b> flag only when you are not
* going to work with the LOB anymore.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* </p>
* <p>
* Returns <b>FALSE</b> if buffering was not enabled or an error occurred.
*/
public function flush(int $flag = null): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Changes current state of buffering for the large object
* @link http://php.net/manual/en/oci-lob.setbuffering.php
* @param bool $on_off <p>
* <b>TRUE</b> for on and <b>FALSE</b> for off.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. Repeated calls to this method with the same flag will
* return <b>TRUE</b>.
*/
public function setbuffering(bool $on_off): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns current state of buffering for the large object
* @link http://php.net/manual/en/oci-lob.getbuffering.php
* @return bool <b>FALSE</b> if buffering for the large object is off and <b>TRUE</b> if
* buffering is used.
*/
public function getbuffering(): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Moves the internal pointer to the beginning of the large object
* @link http://php.net/manual/en/oci-lob.rewind.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function rewind(): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Reads part of the large object
* @link http://php.net/manual/en/oci-lob.read.php
* @param int $length <p>
* The length of data to read, in bytes. Large values will be rounded down to 1 MB.
* </p>
* @return string the contents as a string, or <b>FALSE</b> on failure.
*/
public function read(int $length): string {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Tests for end-of-file on a large object's descriptor
* @link http://php.net/manual/en/oci-lob.eof.php
* @return bool <b>TRUE</b> if internal pointer of large object is at the end of LOB.
* Otherwise returns <b>FALSE</b>.
*/
public function eof(): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Sets the internal pointer of the large object
* @link http://php.net/manual/en/oci-lob.seek.php
* @param int $offset <p>
* Indicates the amount of bytes, on which internal pointer should be
* moved from the position, pointed by <i>whence</i>.
* </p>
* @param int $whence [optional] <p>
* May be one of:
* <b>OCI_SEEK_SET</b> - sets the position equal to
* <i>offset</i>
* <b>OCI_SEEK_CUR</b> - adds <i>offset</i>
* bytes to the current position
* <b>OCI_SEEK_END</b> - adds <i>offset</i>
* bytes to the end of large object (use negative value to move to a position
* before the end of large object)
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function seek(int $offset, int $whence = OCI_SEEK_SET): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Writes data to the large object
* @link http://php.net/manual/en/oci-lob.write.php
* @param string $data <p>
* The data to write in the LOB.
* </p>
* @param int $length [optional] <p>
* If this parameter is given, writing will stop after
* <i>length</i> bytes have been written or the end of
* <i>data</i> is reached, whichever comes first.
* </p>
* @return int the number of bytes written or <b>FALSE</b> on failure.
*/
public function write(string $data, int $length = null): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Appends data from the large object to another large object
* @link http://php.net/manual/en/oci-lob.append.php
* @param OCI_Lob $lob_from <p>
* The copied LOB.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function append(OCI_Lob $lob_from): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns size of large object
* @link http://php.net/manual/en/oci-lob.size.php
* @return int length of large object value or <b>FALSE</b> on failure.
* Empty objects have zero length.
*/
public function size(): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Alias of <b>OCI-Lob::export</b>
* @link http://php.net/manual/en/oci-lob.writetofile.php
* @param $filename
* @param $start [optional]
* @param $length [optional]
*/
public function writetofile($filename, $start, $length) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Exports LOB's contents to a file
* @link http://php.net/manual/en/oci-lob.export.php
* @param string $filename <p>
* Path to the file.
* </p>
* @param int $start [optional] <p>
* Indicates from where to start exporting.
* </p>
* @param int $length [optional] <p>
* Indicates the length of data to be exported.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function export(string $filename, int $start = null, int $length = null): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Imports file data to the LOB
* @link http://php.net/manual/en/oci-lob.import.php
* @param string $filename <p>
* Path to the file.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function import(string $filename): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Writes a temporary large object
* @link http://php.net/manual/en/oci-lob.writetemporary.php
* @param string $data <p>
* The data to write.
* </p>
* @param int $lob_type [optional] <p>
* Can be one of the following:
* <b>OCI_TEMP_BLOB</b> is used to create temporary BLOBs
* <b>OCI_TEMP_CLOB</b> is used to create
* temporary CLOBs
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function writetemporary(string $data, int $lob_type = OCI_TEMP_CLOB): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Closes LOB descriptor
* @link http://php.net/manual/en/oci-lob.close.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function close(): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Saves data to the large object
* @link http://php.net/manual/en/oci-lob.save.php
* @param string $data <p>
* The data to be saved.
* </p>
* @param int $offset [optional] <p>
* Can be used to indicate offset from the beginning of the large object.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function save(string $data, int $offset = null): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Alias of <b>OCI-Lob::import</b>
* @link http://php.net/manual/en/oci-lob.savefile.php
* @param $filename
*/
public function savefile($filename) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Frees resources associated with the LOB descriptor
* @link http://php.net/manual/en/oci-lob.free.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function free(): bool {}
}
/**
* OCI8 Collection functionality.
* @link http://php.net/manual/en/class.OCI-Collection.php
*/
class OCI_Collection {
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Appends element to the collection
* @link http://php.net/manual/en/oci-collection.append.php
* @param mixed $value <p>
* The value to be added to the collection. Can be a string or a number.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function append($value): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns value of the element
* @link http://php.net/manual/en/oci-collection.getelem.php
* @param int $index <p>
* The element index. First index is 0.
* </p>
* @return mixed <b>FALSE</b> if such element doesn't exist; <b>NULL</b> if element is <b>NULL</b>;
* string if element is column of a string datatype or number if element is
* numeric field.
*/
public function getelem(int $index) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Assigns a value to the element of the collection
* @link http://php.net/manual/en/oci-collection.assignelem.php
* @param int $index <p>
* The element index. First index is 0.
* </p>
* @param mixed $value <p>
* Can be a string or a number.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function assignelem(int $index, $value): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Assigns a value to the collection from another existing collection
* @link http://php.net/manual/en/oci-collection.assign.php
* @param OCI_Collection $from <p>
* An instance of OCI-Collection.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function assign(OCI_Collection $from): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns size of the collection
* @link http://php.net/manual/en/oci-collection.size.php
* @return int the number of elements in the collection or <b>FALSE</b> on error.
*/
public function size(): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the maximum number of elements in the collection
* @link http://php.net/manual/en/oci-collection.max.php
* @return int the maximum number as an integer, or <b>FALSE</b> on errors.
* </p>
* <p>
* If the returned value is 0, then the number of elements is not limited.
*/
public function max(): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Trims elements from the end of the collection
* @link http://php.net/manual/en/oci-collection.trim.php
* @param int $num <p>
* The number of elements to be trimmed.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function trim(int $num): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Frees the resources associated with the collection object
* @link http://php.net/manual/en/oci-collection.free.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function free(): bool {}
}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Associates a PHP variable with a column for query fetches
* @link http://php.net/manual/en/function.oci-define-by-name.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @param string $column_name <p>
* The column name used in the query.
* </p>
* <p>
* Use uppercase for Oracle's default, non-case sensitive column
* names. Use the exact column name case for case-sensitive
* column names.
* </p>
* @param mixed $variable <p>
* The PHP variable that will contain the returned column value.
* </p>
* @param int $type [optional] <p>
* The data type to be returned. Generally not needed. Note that
* Oracle-style data conversions are not performed. For example,
* SQLT_INT will be ignored and the returned
* data type will still be SQLT_CHR.
* </p>
* <p>
* You can optionally use <b>oci_new_descriptor</b>
* to allocate LOB/ROWID/BFILE descriptors.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_define_by_name($statement, string $column_name, &$variable, int $type = SQLT_CHR): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Binds a PHP variable to an Oracle placeholder
* @link http://php.net/manual/en/function.oci-bind-by-name.php
* @param resource $statement <p>
* A valid OCI8 statement identifer.
* </p>
* @param string $bv_name <p>
* The colon-prefixed bind variable placeholder used in the
* statement. The colon is optional
* in <i>bv_name</i>. Oracle does not use question
* marks for placeholders.
* </p>
* @param mixed $variable <p>
* The PHP variable to be associated with <i>bv_name</i>
* </p>
* @param int $maxlength [optional] <p>
* Sets the maximum length for the data. If you set it to -1, this
* function will use the current length
* of <i>variable</i> to set the maximum
* length. In this case the <i>variable</i> must
* exist and contain data
* when <b>oci_bind_by_name</b> is called.
* </p>
* @param int $type [optional] <p>
* The datatype that Oracle will treat the data as. The
* default <i>type</i> used
* is <b>SQLT_CHR</b>. Oracle will convert the data
* between this type and the database column (or PL/SQL variable
* type), when possible.
* </p>
* <p>
* If you need to bind an abstract datatype (LOB/ROWID/BFILE) you
* need to allocate it first using the
* <b>oci_new_descriptor</b> function. The
* <i>length</i> is not used for abstract datatypes
* and should be set to -1.
* </p>
* <p>
* Possible values for <i>type</i> are:
* <p>
* <b>SQLT_BFILEE</b> or <b>OCI_B_BFILE</b>
* - for BFILEs;
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_bind_by_name($statement, string $bv_name, &$variable, int $maxlength = -1, int $type = SQLT_CHR): bool {}
/**
* (PHP 5 >= 5.1.2, PHP 7, PECL OCI8 >= 1.2.0)<br/>
* Binds a PHP array to an Oracle PL/SQL array parameter
* @link http://php.net/manual/en/function.oci-bind-array-by-name.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param string $name <p>
* The Oracle placeholder.
* </p>
* @param array $var_array <p>
* An array.
* </p>
* @param int $max_table_length <p>
* Sets the maximum length both for incoming and result arrays.
* </p>
* @param int $max_item_length [optional] <p>
* Sets maximum length for array items. If not specified or equals to -1,
* <b>oci_bind_array_by_name</b> will find the longest
* element in the incoming array and will use it as the maximum length.
* </p>
* @param int $type [optional] <p>
* Should be used to set the type of PL/SQL array items. See list of
* available types below:
* </p>
* <p>
* <p>
* <b>SQLT_NUM</b> - for arrays of NUMBER.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_bind_array_by_name($statement, string $name, array &$var_array, int $max_table_length, int $max_item_length = -1, int $type = SQLT_AFC): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Checks if a field in the currently fetched row is <b>NULL</b>
* @link http://php.net/manual/en/function.oci-field-is-null.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return bool <b>TRUE</b> if <i>field</i> is <b>NULL</b>, <b>FALSE</b> otherwise.
*/
function oci_field_is_null($statement, $field): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the name of a field from the statement
* @link http://php.net/manual/en/function.oci-field-name.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return string the name as a string, or <b>FALSE</b> on errors.
*/
function oci_field_name($statement, $field): string {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns field's size
* @link http://php.net/manual/en/function.oci-field-size.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return int the size of a <i>field</i> in bytes, or <b>FALSE</b> on
* errors.
*/
function oci_field_size($statement, $field): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Tell the scale of the field
* @link http://php.net/manual/en/function.oci-field-scale.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return int the scale as an integer, or <b>FALSE</b> on errors.
*/
function oci_field_scale($statement, $field): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Tell the precision of a field
* @link http://php.net/manual/en/function.oci-field-precision.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return int the precision as an integer, or <b>FALSE</b> on errors.
*/
function oci_field_precision($statement, $field): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns a field's data type name
* @link http://php.net/manual/en/function.oci-field-type.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return mixed the field data type as a string, or <b>FALSE</b> on errors.
*/
function oci_field_type($statement, $field) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Tell the raw Oracle data type of the field
* @link http://php.net/manual/en/function.oci-field-type-raw.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param mixed $field <p>
* Can be the field's index (1-based) or name.
* </p>
* @return int Oracle's raw data type as a number, or <b>FALSE</b> on errors.
*/
function oci_field_type_raw($statement, $field): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Executes a statement
* @link http://php.net/manual/en/function.oci-execute.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @param int $mode [optional] <p>
* An optional second parameter can be one of the following constants:
* <table>
* Execution Modes
* <tr valign="top">
* <td>Constant</td>
* <td>Description</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_COMMIT_ON_SUCCESS</b></td>
* <td>Automatically commit all outstanding changes for
* this connection when the statement has succeeded. This
* is the default.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_DESCRIBE_ONLY</b></td>
* <td>Make query meta data available to functions
* like <b>oci_field_name</b> but do not
* create a result set. Any subsequent fetch call such
* as <b>oci_fetch_array</b> will
* fail.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_NO_AUTO_COMMIT</b></td>
* <td>Do not automatically commit changes. Prior to PHP
* 5.3.2 (PECL OCI8 1.4)
* use <b>OCI_DEFAULT</b> which is equivalent
* to <b>OCI_NO_AUTO_COMMIT</b>.</td>
* </tr>
* </table>
* </p>
* <p>
* Using <b>OCI_NO_AUTO_COMMIT</b> mode starts or continues a
* transaction. Transactions are automatically rolled back when
* the connection is closed, or when the script ends. Explicitly
* call <b>oci_commit</b> to commit a transaction,
* or <b>oci_rollback</b> to abort it.
* </p>
* <p>
* When inserting or updating data, using transactions is
* recommended for relational data consistency and for performance
* reasons.
* </p>
* <p>
* If <b>OCI_NO_AUTO_COMMIT</b> mode is used for any
* statement including queries, and
* <b>oci_commit</b>
* or <b>oci_rollback</b> is not subsequently
* called, then OCI8 will perform a rollback at the end of the
* script even if no data was changed. To avoid an unnecessary
* rollback, many scripts do not
* use <b>OCI_NO_AUTO_COMMIT</b> mode for queries or
* PL/SQL. Be careful to ensure the appropriate transactional
* consistency for the application when
* using <b>oci_execute</b> with different modes in
* the same script.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_execute($statement, int $mode = OCI_COMMIT_ON_SUCCESS): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Cancels reading from cursor
* @link http://php.net/manual/en/function.oci-cancel.php
* @param resource $statement <p>
* An OCI statement.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_cancel($statement): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Fetches the next row from a query into internal buffers
* @link http://php.net/manual/en/function.oci-fetch.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> if there are no more rows in the
* <i>statement</i>.
*/
function oci_fetch($statement): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the next row from a query as an object
* @link http://php.net/manual/en/function.oci-fetch-object.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @return object an object. Each attribute of the object corresponds to a
* column of the row. If there are no more rows in
* the <i>statement</i> then <b>FALSE</b> is returned.
* </p>
* <p>
* Any LOB columns are returned as LOB descriptors.
* </p>
* <p>
* DATE columns are returned as strings formatted
* to the current date format. The default format can be changed with
* Oracle environment variables such as NLS_LANG or
* by a previously executed ALTER SESSION SET
* NLS_DATE_FORMAT command.
* </p>
* <p>
* Oracle's default, non-case sensitive column names will have
* uppercase attribute names. Case-sensitive column names will have
* attribute names using the exact column case.
* Use <b>var_dump</b> on the result object to verify
* the appropriate case for attribute access.
* </p>
* <p>
* Attribute values will be <b>NULL</b> for any NULL
* data fields.
*/
function oci_fetch_object($statement) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the next row from a query as a numeric array
* @link http://php.net/manual/en/function.oci-fetch-row.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @return array a numerically indexed array. If there are no more rows in
* the <i>statement</i> then <b>FALSE</b> is returned.
*/
function oci_fetch_row($statement): array {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the next row from a query as an associative array
* @link http://php.net/manual/en/function.oci-fetch-assoc.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @return array an associative array. If there are no more rows in
* the <i>statement</i> then <b>FALSE</b> is returned.
*/
function oci_fetch_assoc($statement): array {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the next row from a query as an associative or numeric array
* @link http://php.net/manual/en/function.oci-fetch-array.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* <p>
* Can also be a statement identifier returned by <b>oci_get_implicit_resultset</b>.
* </p>
* @param int $mode [optional] <p>
* An optional second parameter can be any combination of the following
* constants:
* <table>
* <b>oci_fetch_array</b> Modes
* <tr valign="top">
* <td>Constant</td>
* <td>Description</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_BOTH</b></td>
* <td>Returns an array with both associative and numeric
* indices. This is the same
* as <b>OCI_ASSOC</b>
* + <b>OCI_NUM</b> and is the default
* behavior.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_ASSOC</b></td>
* <td>Returns an associative array.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_NUM</b></td>
* <td>Returns a numeric array.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_RETURN_NULLS</b></td>
* <td>Creates elements for <b>NULL</b> fields. The element
* values will be a PHP <b>NULL</b>.
* </td>
* </tr>
* <tr valign="top">
* <td><b>OCI_RETURN_LOBS</b></td>
* <td>Returns the contents of LOBs instead of the LOB
* descriptors.</td>
* </tr>
* </table>
* </p>
* <p>
* The default <i>mode</i> is <b>OCI_BOTH</b>.
* </p>
* <p>
* Use the addition operator "+" to specify more than
* one mode at a time.
* </p>
* @return array an array with associative and/or numeric indices. If there
* are no more rows in the <i>statement</i> then
* <b>FALSE</b> is returned.
* </p>
* <p>
* By default, LOB columns are returned as LOB descriptors.
* </p>
* <p>
* DATE columns are returned as strings formatted
* to the current date format. The default format can be changed with
* Oracle environment variables such as NLS_LANG or
* by a previously executed ALTER SESSION SET
* NLS_DATE_FORMAT command.
* </p>
* <p>
* Oracle's default, non-case sensitive column names will have
* uppercase associative indices in the result array. Case-sensitive
* column names will have array indices using the exact column case.
* Use <b>var_dump</b> on the result array to verify the
* appropriate case to use for each query.
* </p>
* <p>
* The table name is not included in the array index. If your query
* contains two different columns with the same name,
* use <b>OCI_NUM</b> or add a column alias to the query
* to ensure name uniqueness, see example #7. Otherwise only one
* column will be returned via PHP.
*/
function oci_fetch_array($statement, int $mode = null): array {}
/**
* (PHP 4, PHP 5, PHP 7, PECL OCI8 >= 1.0.0)<br/>
* Obsolete variant of <b>oci_fetch_array</b>, <b>oci_fetch_object</b>,
<b>oci_fetch_assoc</b> and
<b>oci_fetch_row</b>
* @link http://php.net/manual/en/function.ocifetchinto.php
*/
function ocifetchinto($statement_resource, &$result, $mode) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Fetches multiple rows from a query into a two-dimensional array
* @link http://php.net/manual/en/function.oci-fetch-all.php
* @param resource $statement A valid OCI8 statement
* identifier created by <b>oci_parse</b> and executed
* by <b>oci_execute</b>, or a REF
* CURSOR statement identifier.</p>
* @param array $output <p>
* The variable to contain the returned rows.
* </p>
* <p>
* LOB columns are returned as strings, where Oracle supports
* conversion.
* </p>
* <p>
* See <b>oci_fetch_array</b> for more information
* on how data and types are fetched.
* </p>
* @param int $skip [optional] <p>
* The number of initial rows to discard when fetching the
* result. The default value is 0, so the first row onwards is
* returned.
* </p>
* @param int $maxrows [optional] <p>
* The number of rows to return. The default is -1 meaning return
* all the rows from <i>skip</i> + 1 onwards.
* </p>
* @param int $flags [optional] <p>
* Parameter <i>flags</i> indicates the array
* structure and whether associative arrays should be used.
* <table>
* <b>oci_fetch_all</b> Array Structure Modes
* <tr valign="top">
* <td>Constant</td>
* <td>Description</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_FETCHSTATEMENT_BY_ROW</b></td>
* <td>The outer array will contain one sub-array per query
* row.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_FETCHSTATEMENT_BY_COLUMN</b></td>
* <td>The outer array will contain one sub-array per query
* column. This is the default.</td>
* </tr>
* </table>
* </p>
* <p>
* Arrays can be indexed either by column heading or numerically.
* Only one index mode will be returned.
* <table>
* <b>oci_fetch_all</b> Array Index Modes
* <tr valign="top">
* <td>Constant</td>
* <td>Description</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_NUM</b></td>
* <td>Numeric indexes are used for each column's array.</td>
* </tr>
* <tr valign="top">
* <td><b>OCI_ASSOC</b></td>
* <td>Associative indexes are used for each column's
* array. This is the default.</td>
* </tr>
* </table>
* </p>
* <p>
* Use the addition operator "+" to choose a combination
* of array structure and index modes.
* </p>
* <p>
* Oracle's default, non-case sensitive column names will have
* uppercase array keys. Case-sensitive column names will have
* array keys using the exact column case.
* Use <b>var_dump</b>
* on <i>output</i> to verify the appropriate case
* to use for each query.
* </p>
* <p>
* Queries that have more than one column with the same name
* should use column aliases. Otherwise only one of the columns
* will appear in an associative array.
* </p>
* @return int the number of rows in <i>output</i>, which
* may be 0 or more, or <b>FALSE</b> on failure.
*/
function oci_fetch_all($statement, array &$output, int $skip = 0, int $maxrows = -1, int $flags = 'OCI_FETCHSTATEMENT_BY_COLUMN + OCI_ASSOC'): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Frees all resources associated with statement or cursor
* @link http://php.net/manual/en/function.oci-free-statement.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function oci_free_statement($statement): bool {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Enables or disables internal debug output
* @link http://php.net/manual/en/function.oci-internal-debug.php
* @param bool $onoff <p>
* Set this to <b>FALSE</b> to turn debug output off or <b>TRUE</b> to turn it on.
* </p>
* @return void No value is returned.
*/
function oci_internal_debug(bool $onoff) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Returns the number of result columns in a statement
* @link http://php.net/manual/en/function.oci-num-fields.php
* @param resource $statement <p>
* A valid OCI statement identifier.
* </p>
* @return int the number of columns as an integer, or <b>FALSE</b> on errors.
*/
function oci_num_fields($statement): int {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Prepares an Oracle statement for execution
* @link http://php.net/manual/en/function.oci-parse.php
* @param resource $connection <p>
* An Oracle connection identifier, returned by
* <b>oci_connect</b>, <b>oci_pconnect</b>, or <b>oci_new_connect</b>.
* </p>
* @param string $sql_text <p>
* The SQL or PL/SQL statement.
* </p>
* <p>
* SQL statements should not end with a
* semi-colon (";"). PL/SQL
* statements should end with a semi-colon
* (";").
* </p>
* @return resource a statement handle on success, or <b>FALSE</b> on error.
*/
function oci_parse($connection, string $sql_text) {}
/**
* (PECL OCI8 >= 2.0.0)<br/>
* Returns the next child statement resource from a parent statement resource that has Oracle Database 12c Implicit Result Sets
* @link http://php.net/manual/en/function.oci-get-implicit-resultset.php
* @param resource $statement <p>A valid OCI8 statement identifier created
* by <b>oci_parse</b> and executed
* by <b>oci_execute</b>. The statement
* identifier may or may not be associated with a SQL statement
* that returns Implicit Result Sets.
* </p>
* @return resource a statement handle for the next child statement available
* on <i>statement</i>. Returns <b>FALSE</b> when child
* statements do not exist, or all child statements have been returned
* by previous calls
* to <b>oci_get_implicit_resultset</b>.
*/
function oci_get_implicit_resultset($statement) {}
/**
* (PHP 5, PHP 7, PECL OCI8 >= 1.1.0)<br/>
* Allocates and returns a new cursor (statement handle)
* @link http://php.net/manual/en/function.oci-new-cursor.php
* @param resource $connection <p>
* An Oracle connection identifier, returned by
* <b>oci_connect</b> or <b>oci_pconnect</b>.
* </p>
* @return resource a new statement handle, or <b>FALSE</b> on error.