xref: /PHP-8.1/ext/oci8/oci8.stub.php (revision d9e5e630) 
1<?php
2
3/** @generate-class-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/**
330 * @param resource|null $connection_or_statement
331 * @return array<string, int|string>|false
332 * @refcount 1
333 */
334function oci_error($connection_or_statement = null): array|false {}
335
336/**
337 * @param resource|null $connection_or_statement
338 * @return array<string, int|string>|false
339 * @alias oci_error
340 * @deprecated
341 */
342function ocierror($connection_or_statement = null): array|false {}
343
344/** @param resource $statement */
345function oci_num_fields($statement): int {}
346
347/**
348 * @param resource $statement
349 * @alias oci_num_fields
350 * @deprecated
351 */
352function ocinumcols($statement): int {}
353
354/**
355 * @param resource $connection
356 * @return resource|false
357 */
358function oci_parse($connection, string $sql) {}
359
360/**
361 * @param resource $connection
362 * @return resource|false
363 * @alias oci_parse
364 * @deprecated
365 */
366function ociparse($connection, string $sql) {}
367
368/**
369 * @param resource $statement
370 * @return resource|false
371 */
372function oci_get_implicit_resultset($statement) {}
373
374/** @param resource $statement */
375function oci_set_prefetch($statement, int $rows): bool {}
376
377/**
378 * @param resource $statement
379 * @alias oci_set_prefetch
380 * @deprecated
381 */
382function ocisetprefetch($statement, int $rows): bool {}
383
384/** @param resource $connection */
385function oci_set_client_identifier($connection, string $client_id): bool {}
386
387function oci_set_edition(string $edition): bool {}
388
389/** @param resource $connection */
390function oci_set_module_name($connection, string $name): bool {}
391
392/** @param resource $connection */
393function oci_set_action($connection, string $action): bool {}
394
395/**
396 * @param resource $connection
397 */
398function oci_set_client_info($connection, string $client_info): bool {}
399
400/** @param resource $connection */
401function oci_set_db_operation($connection, string $action): bool {}
402
403/** @param resource $connection */
404function oci_set_call_timeout($connection, int $timeout): bool {}
405
406/**
407 * @param resource|string $connection
408 * @return resource|bool
409 */
410function oci_password_change($connection, string $username, string $old_password, string $new_password) {}
411
412/**
413 * @param resource|string $connection
414 * @return resource|bool
415 * @alias oci_password_change
416 * @deprecated
417 */
418function ocipasswordchange($connection, string $username, string $old_password, string $new_password) {}
419
420/**
421 * @param resource $connection
422 * @return resource|false
423 */
424function oci_new_cursor($connection) {}
425
426/**
427 * @param resource $connection
428 * @return resource|false
429 * @alias oci_new_cursor
430 * @deprecated
431 */
432function ocinewcursor($connection) {}
433
434/** @param resource $statement */
435function oci_result($statement, string|int $column): mixed {}
436
437/**
438 * @param resource $statement
439 * @alias oci_result
440 * @deprecated
441 */
442function ociresult($statement, string|int $column): mixed {}
443
444function oci_client_version(): string {}
445
446/** @param resource $connection */
447function oci_server_version($connection): string|false {}
448
449/**
450 * @param resource $connection
451 * @alias oci_server_version
452 * @deprecated
453 */
454function ociserverversion($connection): string|false {}
455
456/** @param resource $statement */
457function oci_statement_type($statement): string|false {}
458
459/**
460 * @param resource $statement
461 * @alias oci_statement_type
462 * @deprecated
463 */
464function ocistatementtype($statement): string|false {}
465
466/** @param resource $statement */
467function oci_num_rows($statement): int|false {}
468
469/**
470 * @param resource $statement
471 * @alias oci_num_rows
472 * @deprecated
473 */
474function ocirowcount($statement): int|false {}
475
476function oci_free_collection(OCICollection $collection): bool {}
477
478/**
479 * @alias oci_free_collection
480 * @deprecated
481 */
482function ocifreecollection(OCICollection $collection): bool {}
483
484function oci_collection_append(OCICollection $collection, string $value): bool {}
485
486/**
487 * @alias oci_collection_append
488 * @deprecated
489 */
490function ocicollappend(OCICollection $collection, string $value): bool {}
491
492function oci_collection_element_get(OCICollection $collection, int $index): string|float|null|false {}
493
494/**
495 * @alias oci_collection_element_get
496 * @deprecated
497 */
498function ocicollgetelem(OCICollection $collection, int $index): string|float|null|false {}
499
500function oci_collection_assign(OCICollection $to, OCICollection $from): bool {}
501
502function oci_collection_element_assign(OCICollection $collection, int $index, string $value): bool {}
503
504/**
505 * @alias oci_collection_element_assign
506 * @deprecated
507 */
508function ocicollassignelem(OCICollection $collection, int $index, string $value): bool {}
509
510function oci_collection_size(OCICollection $collection): int|false {}
511
512/**
513 * @alias oci_collection_size
514 * @deprecated
515 */
516function ocicollsize(OCICollection $collection): int|false {}
517
518function oci_collection_max(OCICollection $collection): int|false {}
519
520/**
521 * @alias oci_collection_max
522 * @deprecated
523 */
524function ocicollmax(OCICollection $collection): int|false {}
525
526function oci_collection_trim(OCICollection $collection, int $num): bool {}
527
528/**
529 * @alias oci_collection_trim
530 * @deprecated
531 */
532function ocicolltrim(OCICollection $collection, int $num): bool {}
533
534/** @param resource $connection */
535function oci_new_collection($connection, string $type_name, ?string $schema = null): OCICollection|false {}
536
537/**
538 * @param resource $connection
539 * @alias oci_new_collection
540 * @deprecated
541 */
542function ocinewcollection($connection, string $type_name, ?string $schema = null): OCICollection|false {}
543
544/** @param resource $connection */
545function oci_register_taf_callback($connection, ?callable $callback): bool {}
546
547/** @param resource $connection */
548function oci_unregister_taf_callback($connection): bool {}
549
550class OCILob {
551    /**
552     * @alias oci_lob_save
553     * @tentative-return-type
554     */
555    public function save(string $data, int $offset = 0): bool {}
556
557    /**
558     * @alias oci_lob_import
559     * @tentative-return-type
560     */
561    public function import(string $filename): bool {}
562
563    /**
564     * @alias oci_lob_import
565     * @tentative-return-type
566     */
567    public function saveFile(string $filename): bool {}
568
569    /**
570     * @alias oci_lob_load
571     * @tentative-return-type
572     */
573    public function load(): string|false {}
574
575    /**
576     * @alias oci_lob_read
577     * @tentative-return-type
578     */
579    public function read(int $length): string|false {}
580
581    /**
582     * @alias oci_lob_eof
583     * @tentative-return-type
584     */
585    public function eof(): bool {}
586
587    /**
588     * @alias oci_lob_tell
589     * @tentative-return-type
590     */
591    public function tell(): int|false {}
592
593    /**
594     * @alias oci_lob_rewind
595     * @tentative-return-type
596     */
597    public function rewind(): bool {}
598
599    /**
600     * @alias oci_lob_seek
601     * @tentative-return-type
602     */
603    public function seek(int $offset, int $whence = OCI_SEEK_SET): bool {}
604
605    /**
606     * @alias oci_lob_size
607     * @tentative-return-type
608     */
609    public function size(): int|false {}
610
611    /**
612     * @alias oci_lob_write
613     * @tentative-return-type
614     */
615    public function write(string $data, ?int $length = null): int|false {}
616
617    /**
618     * @alias oci_lob_append
619     * @tentative-return-type
620     */
621    public function append(OCILob $from): bool {}
622
623    /**
624     * @alias oci_lob_truncate
625     * @tentative-return-type
626     */
627    public function truncate(int $length = 0): bool {}
628
629    /**
630     * @alias oci_lob_erase
631     * @tentative-return-type
632     */
633    public function erase(?int $offset = null, ?int $length = null): int|false {}
634
635    /**
636     * @alias oci_lob_flush
637     * @tentative-return-type
638     */
639    public function flush(int $flag = 0): bool {}
640
641    /**
642     * @alias ocisetbufferinglob
643     * @tentative-return-type
644     */
645    public function setBuffering(bool $mode): bool {}
646
647    /**
648     * @alias ocigetbufferinglob
649     * @tentative-return-type
650     */
651    public function getBuffering(): bool {}
652
653    /**
654     * @alias oci_lob_export
655     * @tentative-return-type
656     */
657    public function writeToFile(string $filename, ?int $offset = null, ?int $length = null): bool {}
658
659    /**
660     * @alias oci_lob_export
661     * @tentative-return-type
662     */
663    public function export(string $filename, ?int $offset = null, ?int $length = null): bool {}
664
665    /** @tentative-return-type */
666    public function writeTemporary(string $data, int $type = OCI_TEMP_CLOB): bool {}
667
668    /** @tentative-return-type */
669    public function close(): bool {}
670
671    /**
672     * @alias oci_free_descriptor
673     * @tentative-return-type
674     */
675    public function free(): bool {}
676}
677
678class OCICollection {
679    /**
680     * @alias oci_free_collection
681     * @tentative-return-type
682     */
683    public function free(): bool {}
684
685    /**
686     * @alias oci_collection_append
687     * @tentative-return-type
688     */
689    public function append(string $value): bool {}
690
691    /**
692     * @alias oci_collection_element_get
693     * @tentative-return-type
694     */
695    public function getElem(int $index): string|float|null|false {}
696
697    /**
698     * @alias oci_collection_assign
699     * @tentative-return-type
700     */
701    public function assign(OCICollection $from): bool {}
702
703    /**
704     * @alias oci_collection_element_assign
705     * @tentative-return-type
706     */
707    public function assignElem(int $index, string $value): bool {}
708
709    /**
710     * @alias oci_collection_size
711     * @tentative-return-type
712     */
713    public function size(): int|false {}
714
715    /**
716     * @alias oci_collection_max
717     * @tentative-return-type
718     */
719    public function max(): int|false {}
720
721    /**
722     * @alias oci_collection_trim
723     * @tentative-return-type
724     */
725    public function trim(int $num): bool {}
726}
727