blob: 391f987d20a2e7654c6b13446a7247f7a8c67654 (
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?php
declare(strict_types=1);
/**
* @copyright 2021 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @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 Doctrine\DBAL\Exception;
use Doctrine\DBAL\ParameterType;
use PDO;
/**
* This interface allows you to prepare a database query.
*
* This interface must not be implemented in your application but
* instead obtained from IDBConnection::prepare.
*
* ```php
* $prepare = $this->db->prepare($query->getSql());
* ```
*
* @since 21.0.0
*/
interface IPreparedStatement {
/**
* @return true
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::closeCursor on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function closeCursor(): bool;
/**
* @param int $fetchMode
*
* @return mixed
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetch on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function fetch(int $fetchMode = PDO::FETCH_ASSOC);
/**
* @param int $fetchMode
*
* @return mixed[]
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetchAll on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC);
/**
* @return mixed
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetchColumn on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function fetchColumn();
/**
* @return mixed
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function fetchOne();
/**
* @param int|string $param
* @param mixed $value
* @param int $type
*
* @return bool
*
* @throws Exception
*
* @since 21.0.0
*/
public function bindValue($param, $value, $type = ParameterType::STRING): bool;
/**
* @param int|string $param
* @param mixed $variable
* @param int $type
* @param int|null $length
*
* @return bool
*
* @throws Exception
*
* @since 21.0.0
*/
public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null): bool;
/**
* @param mixed[]|null $params
*
* @return IResult
*
* @since 21.0.0
* @throws Exception
*/
public function execute($params = null): IResult;
/**
* @return int
*
* @since 21.0.0
*
* @throws Exception
* @deprecated 21.0.0 use \OCP\DB\IResult::rowCount on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare
*/
public function rowCount(): int;
}
|
