-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathBasePreparedQuery.php
More file actions
265 lines (219 loc) · 6.9 KB
/
BasePreparedQuery.php
File metadata and controls
265 lines (219 loc) · 6.9 KB
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\Database;
use ArgumentCountError;
use CodeIgniter\Database\Exceptions\DatabaseException;
use CodeIgniter\Events\Events;
use CodeIgniter\Exceptions\BadMethodCallException;
use ErrorException;
/**
* @template TConnection
* @template TStatement
* @template TResult
*
* @implements PreparedQueryInterface<TConnection, TStatement, TResult>
*/
abstract class BasePreparedQuery implements PreparedQueryInterface
{
/**
* The prepared statement itself.
*
* @var TStatement|null
*/
protected $statement;
/**
* The error code, if any.
*
* @var int
*/
protected $errorCode;
/**
* The error message, if any.
*
* @var string
*/
protected $errorString;
/**
* Holds the prepared query object
* that is cloned during execute.
*
* @var Query
*/
protected $query;
/**
* A reference to the db connection to use.
*
* @var BaseConnection<TConnection, TResult>
*/
protected $db;
public function __construct(BaseConnection $db)
{
$this->db = $db;
}
/**
* Prepares the query against the database, and saves the connection
* info necessary to execute the query later.
*
* NOTE: This version is based on SQL code. Child classes should
* override this method.
*
* @return $this
*/
public function prepare(string $sql, array $options = [], string $queryClass = Query::class)
{
// We only support positional placeholders (?), so convert
// named placeholders (:name or :name:) while leaving dialect
// syntax like PostgreSQL casts (::type) untouched.
$sql = preg_replace('/(?<!:):([a-zA-Z_]\w*):?(?!:)/', '?', $sql);
/** @var Query $query */
$query = new $queryClass($this->db);
$query->setQuery($sql);
if (! empty($this->db->swapPre) && ! empty($this->db->DBPrefix)) {
$query->swapPrefix($this->db->DBPrefix, $this->db->swapPre);
}
$this->query = $query;
return $this->_prepare($query->getOriginalQuery(), $options);
}
/**
* The database-dependent portion of the prepare statement.
*
* @return $this
*/
abstract public function _prepare(string $sql, array $options = []);
/**
* Takes a new set of data and runs it against the currently
* prepared query. Upon success, will return a Results object.
*
* @return bool|ResultInterface<TConnection, TResult>
*
* @throws DatabaseException
*/
public function execute(...$data)
{
// Execute the Query.
$startTime = microtime(true);
try {
$exception = null;
$result = $this->_execute($data);
} catch (ArgumentCountError|ErrorException $exception) {
$result = false;
}
// Update our query object
$query = clone $this->query;
$query->setBinds($data);
if ($result === false) {
$query->setDuration($startTime, $startTime);
// This will trigger a rollback if transactions are being used
$this->db->handleTransStatus();
if ($this->db->DBDebug) {
// We call this function in order to roll-back queries
// if transactions are enabled. If we don't call this here
// the error message will trigger an exit, causing the
// transactions to remain in limbo.
while ($this->db->transDepth !== 0) {
$transDepth = $this->db->transDepth;
$this->db->transComplete();
if ($transDepth === $this->db->transDepth) {
log_message('error', 'Database: Failure during an automated transaction commit/rollback!');
break;
}
}
// Let others do something with this query.
Events::trigger('DBQuery', $query);
if ($exception !== null) {
throw new DatabaseException($exception->getMessage(), $exception->getCode(), $exception);
}
return false;
}
// Let others do something with this query.
Events::trigger('DBQuery', $query);
return false;
}
$query->setDuration($startTime);
// Let others do something with this query
Events::trigger('DBQuery', $query);
if ($this->db->isWriteType((string) $query)) {
return true;
}
// Return a result object
$resultClass = str_replace('PreparedQuery', 'Result', static::class);
$resultID = $this->_getResult();
return new $resultClass($this->db->connID, $resultID);
}
/**
* The database dependant version of the execute method.
*/
abstract public function _execute(array $data): bool;
/**
* Returns the result object for the prepared query.
*
* @return object|resource|null
*/
abstract public function _getResult();
/**
* Explicitly closes the prepared statement.
*
* @throws BadMethodCallException
*/
public function close(): bool
{
if (! isset($this->statement)) {
throw new BadMethodCallException('Cannot call close on a non-existing prepared statement.');
}
try {
return $this->_close();
} finally {
$this->statement = null;
}
}
/**
* The database-dependent version of the close method.
*/
abstract protected function _close(): bool;
/**
* Returns the SQL that has been prepared.
*/
public function getQueryString(): string
{
if (! $this->query instanceof QueryInterface) {
throw new BadMethodCallException('Cannot call getQueryString on a prepared query until after the query has been prepared.');
}
return $this->query->getQuery();
}
/**
* A helper to determine if any error exists.
*/
public function hasError(): bool
{
return ! empty($this->errorString);
}
/**
* Returns the error code created while executing this statement.
*/
public function getErrorCode(): int
{
return $this->errorCode;
}
/**
* Returns the error message created while executing this statement.
*/
public function getErrorMessage(): string
{
return $this->errorString;
}
/**
* Whether the input contain binary data.
*/
protected function isBinary(string $input): bool
{
return mb_detect_encoding($input, 'UTF-8', true) === false;
}
}