xref: /PHP-8.3/ext/odbc/odbc.stub.php (revision 038b2ae2)
1<?php
2
3/** @generate-class-entries */
4
5/**
6 * @var string
7 * @cvalue PHP_ODBC_TYPE
8 */
9const ODBC_TYPE = UNKNOWN;
10/**
11 * @var int
12 * @cvalue PHP_ODBC_BINMODE_PASSTHRU
13 */
14const ODBC_BINMODE_PASSTHRU = UNKNOWN;
15/**
16 * @var int
17 * @cvalue PHP_ODBC_BINMODE_RETURN
18 */
19const ODBC_BINMODE_RETURN = UNKNOWN;
20/**
21 * @var int
22 * @cvalue PHP_ODBC_BINMODE_CONVERT
23 */
24const ODBC_BINMODE_CONVERT = UNKNOWN;
25
26/* Define Constants for options. These Constants are defined in <sqlext.h> */
27
28/**
29 * @var int
30 * @cvalue SQL_ODBC_CURSORS
31 */
32const SQL_ODBC_CURSORS = UNKNOWN;
33/**
34 * @var int
35 * @cvalue SQL_CUR_USE_DRIVER
36 */
37const SQL_CUR_USE_DRIVER = UNKNOWN;
38/**
39 * @var int
40 * @cvalue SQL_CUR_USE_IF_NEEDED
41 */
42const SQL_CUR_USE_IF_NEEDED = UNKNOWN;
43/**
44 * @var int
45 * @cvalue SQL_CUR_USE_ODBC
46 */
47const SQL_CUR_USE_ODBC = UNKNOWN;
48
49/**
50 * @var int
51 * @cvalue SQL_CONCURRENCY
52 */
53const SQL_CONCURRENCY = UNKNOWN;
54/**
55 * @var int
56 * @cvalue SQL_CONCUR_READ_ONLY
57 */
58const SQL_CONCUR_READ_ONLY = UNKNOWN;
59/**
60 * @var int
61 * @cvalue SQL_CONCUR_LOCK
62 */
63const SQL_CONCUR_LOCK = UNKNOWN;
64/**
65 * @var int
66 * @cvalue SQL_CONCUR_ROWVER
67 */
68const SQL_CONCUR_ROWVER = UNKNOWN;
69/**
70 * @var int
71 * @cvalue SQL_CONCUR_VALUES
72 */
73const SQL_CONCUR_VALUES = UNKNOWN;
74
75/**
76 * @var int
77 * @cvalue SQL_CURSOR_TYPE
78 */
79const SQL_CURSOR_TYPE = UNKNOWN;
80/**
81 * @var int
82 * @cvalue SQL_CURSOR_FORWARD_ONLY
83 */
84const SQL_CURSOR_FORWARD_ONLY = UNKNOWN;
85/**
86 * @var int
87 * @cvalue SQL_CURSOR_KEYSET_DRIVEN
88 */
89const SQL_CURSOR_KEYSET_DRIVEN = UNKNOWN;
90/**
91 * @var int
92 * @cvalue SQL_CURSOR_DYNAMIC
93 */
94const SQL_CURSOR_DYNAMIC = UNKNOWN;
95/**
96 * @var int
97 * @cvalue SQL_CURSOR_STATIC
98 */
99const SQL_CURSOR_STATIC = UNKNOWN;
100
101/**
102 * @var int
103 * @cvalue SQL_KEYSET_SIZE
104 */
105const SQL_KEYSET_SIZE = UNKNOWN;
106
107/* these are for the Data Source type */
108
109/**
110 * @var int
111 * @cvalue SQL_FETCH_FIRST
112 */
113const SQL_FETCH_FIRST = UNKNOWN;
114/**
115 * @var int
116 * @cvalue SQL_FETCH_NEXT
117 */
118const SQL_FETCH_NEXT = UNKNOWN;
119
120/* register the standard data types */
121
122/**
123 * @var int
124 * @cvalue SQL_CHAR
125 */
126const SQL_CHAR = UNKNOWN;
127/**
128 * @var int
129 * @cvalue SQL_VARCHAR
130 */
131const SQL_VARCHAR = UNKNOWN;
132/**
133 * @var int
134 * @cvalue SQL_LONGVARCHAR
135 */
136const SQL_LONGVARCHAR = UNKNOWN;
137/**
138 * @var int
139 * @cvalue SQL_DECIMAL
140 */
141const SQL_DECIMAL = UNKNOWN;
142/**
143 * @var int
144 * @cvalue SQL_NUMERIC
145 */
146const SQL_NUMERIC = UNKNOWN;
147/**
148 * @var int
149 * @cvalue SQL_BIT
150 */
151const SQL_BIT = UNKNOWN;
152/**
153 * @var int
154 * @cvalue SQL_TINYINT
155 */
156const SQL_TINYINT = UNKNOWN;
157/**
158 * @var int
159 * @cvalue SQL_SMALLINT
160 */
161const SQL_SMALLINT = UNKNOWN;
162/**
163 * @var int
164 * @cvalue SQL_INTEGER
165 */
166const SQL_INTEGER = UNKNOWN;
167/**
168 * @var int
169 * @cvalue SQL_BIGINT
170 */
171const SQL_BIGINT = UNKNOWN;
172/**
173 * @var int
174 * @cvalue SQL_REAL
175 */
176const SQL_REAL = UNKNOWN;
177/**
178 * @var int
179 * @cvalue SQL_FLOAT
180 */
181const SQL_FLOAT = UNKNOWN;
182/**
183 * @var int
184 * @cvalue SQL_DOUBLE
185 */
186const SQL_DOUBLE = UNKNOWN;
187/**
188 * @var int
189 * @cvalue SQL_BINARY
190 */
191const SQL_BINARY = UNKNOWN;
192/**
193 * @var int
194 * @cvalue SQL_VARBINARY
195 */
196const SQL_VARBINARY = UNKNOWN;
197/**
198 * @var int
199 * @cvalue SQL_LONGVARBINARY
200 */
201const SQL_LONGVARBINARY = UNKNOWN;
202/**
203 * @var int
204 * @cvalue SQL_DATE
205 */
206const SQL_DATE = UNKNOWN;
207/**
208 * @var int
209 * @cvalue SQL_TIME
210 */
211const SQL_TIME = UNKNOWN;
212/**
213 * @var int
214 * @cvalue SQL_TIMESTAMP
215 */
216const SQL_TIMESTAMP = UNKNOWN;
217
218#if (defined(ODBCVER) && (ODBCVER >= 0x0300))
219/**
220 * @var int
221 * @cvalue SQL_TYPE_DATE
222 */
223const SQL_TYPE_DATE = UNKNOWN;
224/**
225 * @var int
226 * @cvalue SQL_TYPE_TIME
227 */
228const SQL_TYPE_TIME = UNKNOWN;
229/**
230 * @var int
231 * @cvalue SQL_TYPE_TIMESTAMP
232 */
233const SQL_TYPE_TIMESTAMP = UNKNOWN;
234/**
235 * @var int
236 * @cvalue SQL_WCHAR
237 */
238const SQL_WCHAR = UNKNOWN;
239/**
240 * @var int
241 * @cvalue SQL_WVARCHAR
242 */
243const SQL_WVARCHAR = UNKNOWN;
244/**
245 * @var int
246 * @cvalue SQL_WLONGVARCHAR
247 */
248const SQL_WLONGVARCHAR = UNKNOWN;
249
250/* SQLSpecialColumns values */
251
252/**
253 * @var int
254 * @cvalue SQL_BEST_ROWID
255 */
256const SQL_BEST_ROWID = UNKNOWN;
257/**
258 * @var int
259 * @cvalue SQL_ROWVER
260 */
261const SQL_ROWVER = UNKNOWN;
262/**
263 * @var int
264 * @cvalue SQL_SCOPE_CURROW
265 */
266const SQL_SCOPE_CURROW = UNKNOWN;
267/**
268 * @var int
269 * @cvalue SQL_SCOPE_TRANSACTION
270 */
271const SQL_SCOPE_TRANSACTION = UNKNOWN;
272/**
273 * @var int
274 * @cvalue SQL_SCOPE_SESSION
275 */
276const SQL_SCOPE_SESSION = UNKNOWN;
277/**
278 * @var int
279 * @cvalue SQL_NO_NULLS
280 */
281const SQL_NO_NULLS = UNKNOWN;
282/**
283 * @var int
284 * @cvalue SQL_NULLABLE
285 */
286const SQL_NULLABLE = UNKNOWN;
287
288/* SQLStatistics values */
289
290/**
291 * @var int
292 * @cvalue SQL_INDEX_UNIQUE
293 */
294const SQL_INDEX_UNIQUE = UNKNOWN;
295/**
296 * @var int
297 * @cvalue SQL_INDEX_ALL
298 */
299const SQL_INDEX_ALL = UNKNOWN;
300/**
301 * @var int
302 * @cvalue SQL_ENSURE
303 */
304const SQL_ENSURE = UNKNOWN;
305/**
306 * @var int
307 * @cvalue SQL_QUICK
308 */
309const SQL_QUICK = UNKNOWN;
310
311#endif
312
313
314
315function odbc_close_all(): void {}
316
317/** @param resource $statement */
318function odbc_binmode($statement, int $mode): bool {}
319
320/** @param resource $statement */
321function odbc_longreadlen($statement, int $length): bool {}
322
323/**
324 * @param resource $odbc
325 * @return resource|false
326 */
327function odbc_prepare($odbc, string $query) {}
328
329/** @param resource $statement */
330function odbc_execute($statement, array $params = []): bool {}
331
332/** @param resource $statement */
333function odbc_cursor($statement): string|false {}
334
335#ifdef HAVE_SQLDATASOURCES
336/** @param resource $odbc */
337function odbc_data_source($odbc, int $fetch_type): array|null|false {}
338#endif
339
340/**
341 * @param resource $odbc
342 * @return resource|false
343 */
344function odbc_exec($odbc, string $query) {}
345
346/**
347 * @param resource $odbc
348 * @return resource|false
349 * @alias odbc_exec
350 */
351function odbc_do($odbc, string $query) {}
352
353#ifdef PHP_ODBC_HAVE_FETCH_HASH
354/** @param resource $statement */
355function odbc_fetch_object($statement, int $row = -1): stdClass|false {}
356
357/** @param resource $statement */
358function odbc_fetch_array($statement, int $row = -1): array|false {}
359#endif
360
361/**
362 * @param resource $statement
363 * @param array $array
364 */
365function odbc_fetch_into($statement, &$array, int $row = 0): int|false {}
366
367/** @param resource $statement */
368function odbc_fetch_row($statement, ?int $row = null): bool {}
369
370/** @param resource $statement */
371function odbc_result($statement, string|int $field): string|bool|null {}
372
373/**
374 * @param resource $statement
375 * @deprecated
376 */
377function odbc_result_all($statement, string $format = ""): int|false {}
378
379/** @param resource $statement */
380function odbc_free_result($statement): bool {}
381
382/**
383 * @return resource|false
384 */
385function odbc_connect(string $dsn, string $user, #[\SensitiveParameter] string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
386
387/**
388 * @return resource|false
389 */
390function odbc_pconnect(string $dsn, string $user, #[\SensitiveParameter] string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
391
392/** @param resource $odbc */
393function odbc_close($odbc): void {}
394
395/** @param resource $statement */
396function odbc_num_rows($statement): int {}
397
398#if !defined(HAVE_SOLID) && !defined(HAVE_SOLID_30)
399/** @param resource $statement */
400function odbc_next_result($statement): bool {}
401#endif
402
403/** @param resource $statement */
404function odbc_num_fields($statement): int {}
405
406/** @param resource $statement */
407function odbc_field_name($statement, int $field): string|false {}
408
409/** @param resource $statement */
410function odbc_field_type($statement, int $field): string|false {}
411
412/** @param resource $statement */
413function odbc_field_len($statement, int $field): int|false {}
414
415/**
416 * @param resource $statement
417 * @alias odbc_field_len
418 */
419function odbc_field_precision($statement, int $field): int|false {}
420
421/** @param resource $statement */
422function odbc_field_scale($statement, int $field): int|false {}
423
424/** @param resource $statement */
425function odbc_field_num($statement, string $field): int|false {}
426
427/** @param resource $odbc */
428function odbc_autocommit($odbc, ?bool $enable = null): int|bool {}
429
430/** @param resource $odbc */
431function odbc_commit($odbc): bool {}
432
433/** @param resource $odbc */
434function odbc_rollback($odbc): bool {}
435
436/** @param resource|null $odbc */
437function odbc_error($odbc = null): string {}
438
439/** @param resource|null $odbc */
440function odbc_errormsg($odbc = null): string {}
441
442/** @param resource $odbc */
443function odbc_setoption($odbc, int $which, int $option, int $value): bool {}
444
445/**
446 * @param resource $odbc
447 * @return resource|false
448 */
449function odbc_tables($odbc, ?string $catalog = null, ?string $schema = null, ?string $table = null, ?string $types = null) {}
450
451/**
452 * @param resource $odbc
453 * @return resource|false
454 */
455function odbc_columns($odbc, ?string $catalog = null, ?string $schema = null, ?string $table = null, ?string $column = null) {}
456
457/**
458 * @param resource $odbc
459 * @return resource|false
460 */
461function odbc_gettypeinfo($odbc, int $data_type = 0) {}
462
463/**
464 * @param resource $odbc
465 * @return resource|false
466 */
467function odbc_primarykeys($odbc, ?string $catalog, string $schema, string $table) {}
468
469#if !defined(HAVE_SOLID) && !defined(HAVE_SOLID_30) && !defined(HAVE_SOLID_35)
470/**
471 * @param resource $odbc
472 * @return resource|false
473 */
474function odbc_procedurecolumns($odbc, ?string $catalog = null, ?string $schema = null, ?string $procedure = null, ?string $column = null) {}
475
476/**
477 * @param resource $odbc
478 * @return resource|false
479 */
480function odbc_procedures($odbc, ?string $catalog = null, ?string $schema = null, ?string $procedure = null) {}
481
482/**
483 * @param resource $odbc
484 * @return resource|false
485 */
486function odbc_foreignkeys($odbc, ?string $pk_catalog, string $pk_schema, string $pk_table, string $fk_catalog, string $fk_schema, string $fk_table) {}
487#endif
488
489/**
490 * @param resource $odbc
491 * @return resource|false
492 */
493function odbc_specialcolumns($odbc, int $type, ?string $catalog, string $schema, string $table, int $scope, int $nullable) {}
494
495/**
496 * @param resource $odbc
497 * @return resource|false
498 */
499function odbc_statistics($odbc, ?string $catalog, string $schema, string $table, int $unique, int $accuracy) {}
500
501#if !defined(HAVE_DBMAKER) && !defined(HAVE_SOLID) && !defined(HAVE_SOLID_30) &&!defined(HAVE_SOLID_35)
502/**
503 * @param resource $odbc
504 * @return resource|false
505 */
506function odbc_tableprivileges($odbc, ?string $catalog, string $schema, string $table) {}
507
508/**
509 * @param resource $odbc
510 * @return resource|false
511 */
512function odbc_columnprivileges($odbc, ?string $catalog, string $schema, string $table, string $column) {}
513#endif
514
515/* odbc_utils.c */
516
517function odbc_connection_string_is_quoted(string $str): bool {}
518
519function odbc_connection_string_should_quote(string $str): bool {}
520
521function odbc_connection_string_quote(string $str): string {}
522