blob: 10a60cd5ff4e1a3ebfb500ed2754b1cbefd434c8 (
plain)
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
|
<?php
declare(strict_types=1);
/**
* @copyright 2021 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\DB;
use PDO;
/**
* This interface represents the result of a database query.
*
* Usage:
*
* ```php
* $qb = $this->db->getQueryBuilder();
* $qb->select(...);
* $result = $query->executeQuery();
* ```
*
* This interface must not be implemented in your application.
*
* @since 21.0.0
*/
interface IResult {
/**
* @return true
*
* @since 21.0.0
*/
public function closeCursor(): bool;
/**
* @param int $fetchMode
*
* @return mixed
*
* @since 21.0.0
*/
public function fetch(int $fetchMode = PDO::FETCH_ASSOC);
/**
* @param int $fetchMode (one of PDO::FETCH_ASSOC, PDO::FETCH_NUM or PDO::FETCH_COLUMN (2, 3 or 7)
*
* @return mixed[]
*
* @since 21.0.0
*/
public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC): array;
/**
* @return mixed
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne
*/
public function fetchColumn();
/**
* Returns the first value of the next row of the result or FALSE if there are no more rows.
*
* @return false|mixed
*
* @since 21.0.0
*/
public function fetchOne();
/**
* @return int
*
* @since 21.0.0
*/
public function rowCount(): int;
}
|
