xref: /PHP-8.0/ext/oci8/oci8.stub.php (revision 26aa54e0)
1<?php
2
3/** @generate-function-entries */
4
5/** @param resource $statement */
6function oci_define_by_name($statement, string $column, mixed &$var, int $type = 0): bool {}
7
8/**
9 * @param resource $statement
10 * @alias oci_define_by_name
11 * @deprecated
12 */
13function ocidefinebyname($statement, string $column, mixed &$var, int $type = 0): bool {}
14
15/** @param resource $statement */
16function oci_bind_by_name($statement, string $param, mixed &$var, int $max_length = -1, int $type = 0): bool {}
17
18/**
19 * @param resource $statement
20 * @alias oci_bind_by_name
21 * @deprecated
22 */
23function ocibindbyname($statement, string $param, mixed &$var, int $max_length = -1, int $type = 0): bool {}
24
25/**
26 * @param resource $statement
27 * @param array $var
28 */
29function oci_bind_array_by_name($statement, string $param, &$var, int $max_array_length, int $max_item_length = -1, int $type = SQLT_AFC): bool {}
30
31function oci_free_descriptor(OCILob $lob): bool {}
32
33/**
34 * @alias oci_free_descriptor
35 * @deprecated
36 */
37function ocifreedesc(OCILob $lob): bool {}
38
39function oci_lob_save(OCILob $lob, string $data, int $offset = 0): bool {}
40
41/**
42 * @alias oci_lob_save
43 * @deprecated
44 */
45function ocisavelob(OCILob $lob, string $data, int $offset = 0): bool {}
46
47function oci_lob_import(OCILob $lob, string $filename): bool {}
48
49/**
50 * @alias oci_lob_import
51 * @deprecated
52 */
53function ocisavelobfile(OCILob $lob, string $filename): bool {}
54
55function oci_lob_load(OCILob $lob): string|false {}
56
57/**
58 * @alias oci_lob_load
59 * @deprecated
60 */
61function ociloadlob(OCILob $lob): string|false {}
62
63function oci_lob_read(OCILob $lob, int $length): string|false {}
64
65function oci_lob_eof(OCILob $lob): bool {}
66
67function oci_lob_tell(OCILob $lob): int|false {}
68
69function oci_lob_rewind(OCILob $lob): bool {}
70
71function oci_lob_seek(OCILob $lob, int $offset, int $whence = OCI_SEEK_SET): bool {}
72
73function oci_lob_size(OCILob $lob): int|false {}
74
75function oci_lob_write(OCILob $lob, string $data, ?int $length = null): int|false {}
76
77function oci_lob_append(OCILob $to, OCILob $from): bool {}
78
79function oci_lob_truncate(OCILob $lob, int $length = 0): bool {}
80
81function oci_lob_erase(OCILob $lob, ?int $offset = null, ?int $length = null): int|false {}
82
83function oci_lob_flush(OCILob $lob, int $flag = 0): bool {}
84
85function ocisetbufferinglob(OCILob $lob, bool $mode): bool {}
86
87function ocigetbufferinglob(OCILob $lob): bool {}
88
89function oci_lob_copy(OCILob $to, OCILob $from, ?int $length = null): bool {}
90
91function oci_lob_is_equal(OCILob $lob1, OCILob $lob2): bool {}
92
93function oci_lob_export(OCILob $lob, string $filename, ?int $offset = null, ?int $length = null): bool {}
94
95/**
96 * @alias oci_lob_export
97 * @deprecated
98 */
99function ociwritelobtofile(OCILob $lob, string $filename, ?int $offset = null, ?int $length = null): bool {}
100
101/** @param resource $connection */
102function oci_new_descriptor($connection, int $type = OCI_DTYPE_LOB): ?OCILob {}
103
104/**
105 * @param resource $connection
106 * @alias oci_new_descriptor
107 * @deprecated
108 */
109function ocinewdescriptor($connection, int $type = OCI_DTYPE_LOB): ?OCILob {}
110
111/** @param resource $connection */
112function oci_rollback($connection): bool {}
113
114/**
115 * @param resource $connection
116 * @alias oci_rollback
117 * @deprecated
118 */
119function ocirollback($connection): bool {}
120
121/** @param resource $connection */
122function oci_commit($connection): bool {}
123
124/**
125 * @param resource $connection
126 * @alias oci_commit
127 * @deprecated
128 */
129function ocicommit($connection): bool {}
130
131/** @param resource $statement */
132function oci_field_name($statement, string|int $column): string|false {}
133
134/**
135 * @param resource $statement
136 * @alias oci_field_name
137 * @deprecated
138 */
139function ocicolumnname($statement, string|int $column): string|false {}
140
141/** @param resource $statement */
142function oci_field_size($statement, string|int $column): int|false {}
143
144/**
145 * @param resource $statement
146 * @alias oci_field_size
147 * @deprecated
148 */
149function ocicolumnsize($statement, string|int $column): int|false {}
150
151/** @param resource $statement */
152function oci_field_scale($statement, string|int $column): int|false {}
153
154/**
155 * @param resource $statement
156 * @alias oci_field_scale
157 * @deprecated
158 */
159function ocicolumnscale($statement, string|int $column): int|false {}
160
161/** @param resource $statement */
162function oci_field_precision($statement, string|int $column): int|false {}
163
164/**
165 * @param resource $statement
166 * @alias oci_field_precision
167 * @deprecated
168 */
169function ocicolumnprecision($statement, string|int $column): int|false {}
170
171/** @param resource $statement */
172function oci_field_type($statement, string|int $column): string|int|false {}
173
174/**
175 * @param resource $statement
176 * @alias oci_field_type
177 * @deprecated
178 */
179function ocicolumntype($statement, string|int $column): string|int|false {}
180
181/** @param resource $statement */
182function oci_field_type_raw($statement, string|int $column): int|false {}
183
184/**
185 * @param resource $statement
186 * @alias oci_field_type_raw
187 * @deprecated
188 */
189function ocicolumntyperaw($statement, string|int $column): int|false {}
190
191/** @param resource $statement */
192function oci_field_is_null($statement, string|int $column): bool {}
193
194/**
195 * @param resource $statement
196 * @alias oci_field_is_null
197 * @deprecated
198 */
199function ocicolumnisnull($statement, string|int $column): bool {}
200
201/** @param resource $statement */
202function oci_execute($statement, int $mode = OCI_COMMIT_ON_SUCCESS): bool {}
203
204/**
205 * @param resource $statement
206 * @alias oci_execute
207 * @deprecated
208 */
209function ociexecute($statement, int $mode = OCI_COMMIT_ON_SUCCESS): bool {}
210
211/** @param resource $statement */
212function oci_cancel($statement): bool {}
213
214/**
215 * @param resource $statement
216 * @alias oci_cancel
217 * @deprecated
218 */
219function ocicancel($statement): bool {}
220
221/** @param resource $statement */
222function oci_fetch($statement): bool {}
223
224/**
225 * @param resource $statement
226 * @alias oci_fetch
227 * @deprecated
228 */
229function ocifetch($statement): bool {}
230
231/**
232 * @param resource $statement
233 * @param array $result
234 * @deprecated
235 */
236function ocifetchinto($statement, &$result, int $mode = OCI_NUM): int|false {}
237
238/**
239 * @param resource $statement
240 * @param array $output
241 */
242function oci_fetch_all($statement, &$output, int $offset = 0, int $limit = -1, int $flags = OCI_FETCHSTATEMENT_BY_COLUMN | OCI_ASSOC): int {}
243
244/**
245 * @param resource $statement
246 * @param array $output
247 * @alias oci_fetch_all
248 * @deprecated
249 */
250function ocifetchstatement($statement, &$output, int $offset = 0, int $limit = -1, int $flags = OCI_FETCHSTATEMENT_BY_COLUMN | OCI_ASSOC): int {}
251
252/** @param resource $statement */
253function oci_fetch_object($statement, int $mode = OCI_ASSOC | OCI_RETURN_NULLS): stdClass|false {}
254
255/** @param resource $statement */
256function oci_fetch_row($statement): array|false {}
257
258/** @param resource $statement */
259function oci_fetch_assoc($statement): array|false {}
260
261/** @param resource $statement */
262function oci_fetch_array($statement, int $mode = OCI_BOTH | OCI_RETURN_NULLS): array|false {}
263
264/** @param resource $statement */
265function oci_free_statement($statement): bool {}
266
267/**
268 * @param resource $statement
269 * @alias oci_free_statement
270 * @deprecated
271 */
272function ocifreestatement($statement): bool {}
273
274/**
275 * @param resource $statement
276 * @alias oci_free_statement
277 */
278function oci_free_cursor($statement): bool {}
279
280/**
281 * @param resource $statement
282 * @alias oci_free_statement
283 * @deprecated
284 */
285function ocifreecursor($statement): bool {}
286
287/** @param resource $connection */
288function oci_close($connection): ?bool {}
289
290/**
291 * @param resource $connection
292 * @alias oci_close
293 * @deprecated
294 */
295function ocilogoff($connection): ?bool {}
296
297/** @return resource|false */
298function oci_new_connect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
299
300/**
301 * @return resource|false
302 * @alias oci_new_connect
303 * @deprecated
304 */
305function ocinlogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
306
307/**
308 * @return resource|false
309 */
310function oci_connect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
311
312/**
313 * @return resource|false
314 * @alias oci_connect
315 * @deprecated
316 */
317function ocilogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
318
319/** @return resource|false */
320function oci_pconnect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
321
322/**
323 * @return resource|false
324 * @alias oci_pconnect
325 * @deprecated
326 */
327function ociplogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
328
329/** @param resource|null $connection_or_statement */
330function oci_error($connection_or_statement = null): array|false {}
331
332/**
333 * @param resource|null $connection_or_statement
334 * @alias oci_error
335 * @deprecated
336 */
337function ocierror($connection_or_statement = null): array|false {}
338
339/** @param resource $statement */
340function oci_num_fields($statement): int {}
341
342/**
343 * @param resource $statement
344 * @alias oci_num_fields
345 * @deprecated
346 */
347function ocinumcols($statement): int {}
348
349/**
350 * @param resource $connection
351 * @return resource|false
352 */
353function oci_parse($connection, string $sql) {}
354
355/**
356 * @param resource $connection
357 * @return resource|false
358 * @alias oci_parse
359 * @deprecated
360 */
361function ociparse($connection, string $sql) {}
362
363/**
364 * @param resource $statement
365 * @return resource|false
366 */
367function oci_get_implicit_resultset($statement) {}
368
369/** @param resource $statement */
370function oci_set_prefetch($statement, int $rows): bool {}
371
372/**
373 * @param resource $statement
374 * @alias oci_set_prefetch
375 * @deprecated
376 */
377function ocisetprefetch($statement, int $rows): bool {}
378
379/** @param resource $connection */
380function oci_set_client_identifier($connection, string $client_id): bool {}
381
382function oci_set_edition(string $edition): bool {}
383
384/** @param resource $connection */
385function oci_set_module_name($connection, string $name): bool {}
386
387/** @param resource $connection */
388function oci_set_action($connection, string $action): bool {}
389
390/**
391 * @param resource $connection
392 */
393function oci_set_client_info($connection, string $client_info): bool {}
394
395/** @param resource $connection */
396function oci_set_db_operation($connection, string $action): bool {}
397
398/** @param resource $connection */
399function oci_set_call_timeout($connection, int $timeout): bool {}
400
401/**
402 * @param resource|string $connection
403 * @return resource|bool
404 */
405function oci_password_change($connection, string $username, string $old_password, string $new_password) {}
406
407/**
408 * @param resource|string $connection
409 * @return resource|bool
410 * @alias oci_password_change
411 * @deprecated
412 */
413function ocipasswordchange($connection, string $username, string $old_password, string $new_password) {}
414
415/**
416 * @param resource $connection
417 * @return resource|false
418 */
419function oci_new_cursor($connection) {}
420
421/**
422 * @param resource $connection
423 * @return resource|false
424 * @alias oci_new_cursor
425 * @deprecated
426 */
427function ocinewcursor($connection) {}
428
429/** @param resource $statement */
430function oci_result($statement, string|int $column): mixed {}
431
432/**
433 * @param resource $statement
434 * @alias oci_result
435 * @deprecated
436 */
437function ociresult($statement, string|int $column): mixed {}
438
439function oci_client_version(): string {}
440
441/** @param resource $connection */
442function oci_server_version($connection): string|false {}
443
444/**
445 * @param resource $connection
446 * @alias oci_server_version
447 * @deprecated
448 */
449function ociserverversion($connection): string|false {}
450
451/** @param resource $statement */
452function oci_statement_type($statement): string|false {}
453
454/**
455 * @param resource $statement
456 * @alias oci_statement_type
457 * @deprecated
458 */
459function ocistatementtype($statement): string|false {}
460
461/** @param resource $statement */
462function oci_num_rows($statement): int|false {}
463
464/**
465 * @param resource $statement
466 * @alias oci_num_rows
467 * @deprecated
468 */
469function ocirowcount($statement): int|false {}
470
471function oci_free_collection(OCICollection $collection): bool {}
472
473/**
474 * @alias oci_free_collection
475 * @deprecated
476 */
477function ocifreecollection(OCICollection $collection): bool {}
478
479function oci_collection_append(OCICollection $collection, string $value): bool {}
480
481/**
482 * @alias oci_collection_append
483 * @deprecated
484 */
485function ocicollappend(OCICollection $collection, string $value): bool {}
486
487function oci_collection_element_get(OCICollection $collection, int $index): string|float|null|false {}
488
489/**
490 * @alias oci_collection_element_get
491 * @deprecated
492 */
493function ocicollgetelem(OCICollection $collection, int $index): string|float|null|false {}
494
495function oci_collection_assign(OCICollection $to, OCICollection $from): bool {}
496
497function oci_collection_element_assign(OCICollection $collection, int $index, string $value): bool {}
498
499/**
500 * @alias oci_collection_element_assign
501 * @deprecated
502 */
503function ocicollassignelem(OCICollection $collection, int $index, string $value): bool {}
504
505function oci_collection_size(OCICollection $collection): int|false {}
506
507/**
508 * @alias oci_collection_size
509 * @deprecated
510 */
511function ocicollsize(OCICollection $collection): int|false {}
512
513function oci_collection_max(OCICollection $collection): int|false {}
514
515/**
516 * @alias oci_collection_max
517 * @deprecated
518 */
519function ocicollmax(OCICollection $collection): int|false {}
520
521function oci_collection_trim(OCICollection $collection, int $num): bool {}
522
523/**
524 * @alias oci_collection_trim
525 * @deprecated
526 */
527function ocicolltrim(OCICollection $collection, int $num): bool {}
528
529/** @param resource $connection */
530function oci_new_collection($connection, string $type_name, ?string $schema = null): OCICollection|false {}
531
532/**
533 * @param resource $connection
534 * @alias oci_new_collection
535 * @deprecated
536 */
537function ocinewcollection($connection, string $type_name, ?string $schema = null): OCICollection|false {}
538
539/** @param resource $connection */
540function oci_register_taf_callback($connection, ?callable $callback): bool {}
541
542/** @param resource $connection */
543function oci_unregister_taf_callback($connection): bool {}
544
545class OCILob {
546    /**
547     * @alias oci_lob_save
548     * @return bool
549     */
550    public function save(string $data, int $offset = 0) {}
551
552    /**
553     * @alias oci_lob_import
554     * @return bool
555     */
556    public function import(string $filename) {}
557
558    /**
559     * @alias oci_lob_import
560     * @return bool
561     */
562    public function saveFile(string $filename) {}
563
564    /**
565     * @alias oci_lob_load
566     * @return string|false
567     */
568    public function load() {}
569
570    /**
571     * @alias oci_lob_read
572     * @return string|false
573     */
574    public function read(int $length) {}
575
576    /**
577     * @alias oci_lob_eof
578     * @return bool
579     */
580    public function eof() {}
581
582    /**
583     * @alias oci_lob_tell
584     * @return int|false
585     */
586    public function tell() {}
587
588    /**
589     * @alias oci_lob_rewind
590     * @return bool
591     */
592    public function rewind() {}
593
594    /**
595     * @alias oci_lob_seek
596     * @return bool
597     */
598    public function seek(int $offset, int $whence = OCI_SEEK_SET) {}
599
600    /**
601     * @alias oci_lob_size
602     * @return int|false
603     */
604    public function size() {}
605
606    /**
607     * @alias oci_lob_write
608     * @return int|false
609     */
610    public function write(string $data, ?int $length = null) {}
611
612    /**
613     * @alias oci_lob_append
614     * @return bool
615     */
616    public function append(OCILob $from) {}
617
618    /**
619     * @alias oci_lob_truncate
620     * @return bool
621     */
622    public function truncate(int $length = 0) {}
623
624    /**
625     * @alias oci_lob_erase
626     * @return int|false
627     */
628    public function erase(?int $offset = null, ?int $length = null) {}
629
630    /**
631     * @alias oci_lob_flush
632     * @return bool
633     */
634    public function flush(int $flag = 0): bool {}
635
636    /**
637     * @alias ocisetbufferinglob
638     * @return bool
639     */
640    public function setBuffering(bool $mode) {}
641
642    /**
643     * @alias ocigetbufferinglob
644     * @return bool
645     */
646    public function getBuffering() {}
647
648    /**
649     * @alias oci_lob_export
650     * @return bool
651     */
652    public function writeToFile(string $filename, ?int $offset = null, ?int $length = null) {}
653
654    /**
655     * @alias oci_lob_export
656     * @return bool
657     */
658    public function export(string $filename, ?int $offset = null, ?int $length = null) {}
659
660    /** @return bool */
661    public function writeTemporary(string $data, int $type = OCI_TEMP_CLOB) {}
662
663    /** @return bool */
664    public function close() {}
665
666    /**
667     * @alias oci_free_descriptor
668     * @return bool
669     */
670    public function free() {}
671}
672
673class OCICollection {
674    /**
675     * @alias oci_free_collection
676     * @return bool
677     */
678    public function free() {}
679
680    /**
681     * @alias oci_collection_append
682     * @return bool
683     */
684    public function append(string $value) {}
685
686    /**
687     * @alias oci_collection_element_get
688     * @return string|float|null|false
689     */
690    public function getElem(int $index) {}
691
692    /**
693     * @alias oci_collection_assign
694     * @return bool
695     */
696    public function assign(OCICollection $from) {}
697
698    /**
699     * @alias oci_collection_element_assign
700     * @return bool
701     */
702    public function assignElem(int $index, string $value) {}
703
704    /**
705     * @alias oci_collection_size
706     * @return int|false
707     */
708    public function size() {}
709
710    /**
711     * @alias oci_collection_max
712     * @return int|false
713     */
714    public function max() {}
715
716    /**
717     * @alias oci_collection_trim
718     * @return bool
719     */
720    public function trim(int $num) {}
721}
722