summaryrefslogtreecommitdiff
path: root/vendor/doctrine/dbal/src/Driver/Result.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/doctrine/dbal/src/Driver/Result.php')
-rw-r--r--vendor/doctrine/dbal/src/Driver/Result.php93
1 files changed, 93 insertions, 0 deletions
diff --git a/vendor/doctrine/dbal/src/Driver/Result.php b/vendor/doctrine/dbal/src/Driver/Result.php
new file mode 100644
index 0000000..500cb88
--- /dev/null
+++ b/vendor/doctrine/dbal/src/Driver/Result.php
@@ -0,0 +1,93 @@
1<?php
2
3declare(strict_types=1);
4
5namespace Doctrine\DBAL\Driver;
6
7/**
8 * Driver-level statement execution result.
9 */
10interface Result
11{
12 /**
13 * Returns the next row of the result as a numeric array or FALSE if there are no more rows.
14 *
15 * @return list<mixed>|false
16 *
17 * @throws Exception
18 */
19 public function fetchNumeric(): array|false;
20
21 /**
22 * Returns the next row of the result as an associative array or FALSE if there are no more rows.
23 *
24 * @return array<string,mixed>|false
25 *
26 * @throws Exception
27 */
28 public function fetchAssociative(): array|false;
29
30 /**
31 * Returns the first value of the next row of the result or FALSE if there are no more rows.
32 *
33 * @throws Exception
34 */
35 public function fetchOne(): mixed;
36
37 /**
38 * Returns an array containing all of the result rows represented as numeric arrays.
39 *
40 * @return list<list<mixed>>
41 *
42 * @throws Exception
43 */
44 public function fetchAllNumeric(): array;
45
46 /**
47 * Returns an array containing all of the result rows represented as associative arrays.
48 *
49 * @return list<array<string,mixed>>
50 *
51 * @throws Exception
52 */
53 public function fetchAllAssociative(): array;
54
55 /**
56 * Returns an array containing the values of the first column of the result.
57 *
58 * @return list<mixed>
59 *
60 * @throws Exception
61 */
62 public function fetchFirstColumn(): array;
63
64 /**
65 * Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result.
66 *
67 * If the statement executed a SELECT query or a similar platform-specific SQL (e.g. DESCRIBE, SHOW, etc.),
68 * some database drivers may return the number of rows returned by that query. However, this behaviour
69 * is not guaranteed for all drivers and should not be relied on in portable applications.
70 *
71 * If the number of rows exceeds {@see PHP_INT_MAX}, it might be returned as string if the driver supports it.
72 *
73 * @return int|numeric-string
74 *
75 * @throws Exception
76 */
77 public function rowCount(): int|string;
78
79 /**
80 * Returns the number of columns in the result
81 *
82 * @return int The number of columns in the result. If the columns cannot be counted,
83 * this method must return 0.
84 *
85 * @throws Exception
86 */
87 public function columnCount(): int;
88
89 /**
90 * Discards the non-fetched portion of the result, enabling the originating statement to be executed again.
91 */
92 public function free(): void;
93}