|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Doctrine\DBAL\Driver; |
|
6
|
|
|
|
|
7
|
|
|
use Doctrine\DBAL\Exception\InvalidColumnIndex; |
|
8
|
|
|
use Doctrine\DBAL\FetchMode; |
|
9
|
|
|
use Doctrine\DBAL\ParameterType; |
|
10
|
|
|
use IteratorAggregate; |
|
11
|
|
|
use PDO; |
|
12
|
|
|
use const E_USER_DEPRECATED; |
|
13
|
|
|
use function array_slice; |
|
14
|
|
|
use function assert; |
|
15
|
|
|
use function count; |
|
16
|
|
|
use function func_get_args; |
|
17
|
|
|
use function is_array; |
|
18
|
|
|
use function sprintf; |
|
19
|
|
|
use function trigger_error; |
|
20
|
|
|
|
|
21
|
|
|
/** |
|
22
|
|
|
* The PDO implementation of the Statement interface. |
|
23
|
|
|
* Used by all PDO-based drivers. |
|
24
|
|
|
*/ |
|
25
|
|
|
class PDOStatement implements IteratorAggregate, Statement |
|
26
|
|
|
{ |
|
27
|
|
|
private const PARAM_TYPE_MAP = [ |
|
28
|
|
|
ParameterType::NULL => PDO::PARAM_NULL, |
|
29
|
|
|
ParameterType::INTEGER => PDO::PARAM_INT, |
|
30
|
|
|
ParameterType::STRING => PDO::PARAM_STR, |
|
31
|
|
|
ParameterType::BINARY => PDO::PARAM_LOB, |
|
32
|
|
|
ParameterType::LARGE_OBJECT => PDO::PARAM_LOB, |
|
33
|
|
|
ParameterType::BOOLEAN => PDO::PARAM_BOOL, |
|
34
|
|
|
]; |
|
35
|
|
|
|
|
36
|
|
|
private const FETCH_MODE_MAP = [ |
|
37
|
|
|
FetchMode::ASSOCIATIVE => PDO::FETCH_ASSOC, |
|
38
|
|
|
FetchMode::NUMERIC => PDO::FETCH_NUM, |
|
39
|
|
|
FetchMode::MIXED => PDO::FETCH_BOTH, |
|
40
|
|
|
FetchMode::STANDARD_OBJECT => PDO::FETCH_OBJ, |
|
41
|
|
|
FetchMode::COLUMN => PDO::FETCH_COLUMN, |
|
42
|
|
|
FetchMode::CUSTOM_OBJECT => PDO::FETCH_CLASS, |
|
43
|
4569 |
|
]; |
|
44
|
|
|
|
|
45
|
4569 |
|
/** @var \PDOStatement */ |
|
46
|
|
|
private $stmt; |
|
47
|
|
|
|
|
48
|
|
|
public function __construct(\PDOStatement $stmt) |
|
49
|
|
|
{ |
|
50
|
4538 |
|
$this->stmt = $stmt; |
|
51
|
|
|
} |
|
52
|
4538 |
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* {@inheritdoc} |
|
55
|
|
|
*/ |
|
56
|
|
|
public function setFetchMode(int $fetchMode, ...$args) : void |
|
57
|
|
|
{ |
|
58
|
|
|
$fetchMode = $this->convertFetchMode($fetchMode); |
|
59
|
4538 |
|
|
|
60
|
4538 |
|
try { |
|
61
|
|
|
$this->stmt->setFetchMode($fetchMode, ...$args); |
|
62
|
|
|
} catch (\PDOException $exception) { |
|
63
|
3314 |
|
throw new PDOException($exception); |
|
64
|
3314 |
|
} |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* {@inheritdoc} |
|
69
|
|
|
*/ |
|
70
|
|
|
public function bindValue($param, $value, int $type = ParameterType::STRING) : void |
|
71
|
|
|
{ |
|
72
|
|
|
$type = $this->convertParamType($type); |
|
73
|
|
|
|
|
74
|
|
|
try { |
|
75
|
|
|
$this->stmt->bindValue($param, $value, $type); |
|
76
|
4050 |
|
} catch (\PDOException $exception) { |
|
77
|
|
|
throw new PDOException($exception); |
|
78
|
4050 |
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
4050 |
|
/** |
|
82
|
|
|
* {@inheritdoc} |
|
83
|
|
|
*/ |
|
84
|
|
|
public function bindParam($param, &$variable, int $type = ParameterType::STRING, ?int $length = null, $driverOptions = null) : void |
|
85
|
|
|
{ |
|
86
|
|
|
$type = $this->convertParamType($type); |
|
87
|
|
|
$extraParameters = array_slice(func_get_args(), 3); |
|
88
|
|
|
|
|
89
|
|
|
if (count($extraParameters) !== 0) { |
|
90
|
4185 |
|
$extraParameters[0] = $extraParameters[0] ?? 0; |
|
91
|
|
|
} |
|
92
|
4185 |
|
|
|
93
|
|
|
try { |
|
94
|
|
|
$this->stmt->bindParam($param, $variable, $type, ...$extraParameters); |
|
|
|
|
|
|
95
|
4185 |
|
} catch (\PDOException $exception) { |
|
96
|
|
|
throw new PDOException($exception); |
|
97
|
|
|
} |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
/** |
|
101
|
|
|
* {@inheritdoc} |
|
102
|
|
|
*/ |
|
103
|
|
|
public function closeCursor() : void |
|
104
|
2536 |
|
{ |
|
105
|
|
|
$this->stmt->closeCursor(); |
|
106
|
|
|
} |
|
107
|
2536 |
|
|
|
108
|
|
|
/** |
|
109
|
|
|
* {@inheritdoc} |
|
110
|
|
|
*/ |
|
111
|
|
|
public function columnCount() : int |
|
112
|
|
|
{ |
|
113
|
|
|
return $this->stmt->columnCount(); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
/** |
|
117
|
|
|
* {@inheritdoc} |
|
118
|
4406 |
|
*/ |
|
119
|
|
|
public function execute(?array $params = null) : void |
|
120
|
|
|
{ |
|
121
|
4406 |
|
try { |
|
122
|
3960 |
|
$this->stmt->execute($params); |
|
123
|
3205 |
|
} catch (\PDOException $exception) { |
|
124
|
|
|
throw new PDOException($exception); |
|
125
|
|
|
} |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
/** |
|
129
|
|
|
* {@inheritdoc} |
|
130
|
4206 |
|
*/ |
|
131
|
|
|
public function rowCount() : int |
|
132
|
4206 |
|
{ |
|
133
|
|
|
return $this->stmt->rowCount(); |
|
134
|
4206 |
|
} |
|
135
|
4197 |
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* {@inheritdoc} |
|
138
|
|
|
*/ |
|
139
|
4206 |
|
public function fetch(?int $fetchMode = null, ...$args) |
|
140
|
|
|
{ |
|
141
|
|
|
try { |
|
142
|
|
|
if ($fetchMode === null) { |
|
143
|
|
|
return $this->stmt->fetch(); |
|
144
|
|
|
} |
|
145
|
|
|
|
|
146
|
|
|
$fetchMode = $this->convertFetchMode($fetchMode); |
|
147
|
|
|
|
|
148
|
4396 |
|
return $this->stmt->fetch($fetchMode, ...$args); |
|
|
|
|
|
|
149
|
|
|
} catch (\PDOException $exception) { |
|
150
|
4396 |
|
throw new PDOException($exception); |
|
151
|
|
|
} |
|
152
|
4396 |
|
} |
|
153
|
4290 |
|
|
|
154
|
|
|
/** |
|
155
|
|
|
* {@inheritdoc} |
|
156
|
4396 |
|
*/ |
|
157
|
4126 |
|
public function fetchAll(?int $fetchMode = null, ...$args) : array |
|
158
|
4290 |
|
{ |
|
159
|
4289 |
|
try { |
|
160
|
3345 |
|
if ($fetchMode === null) { |
|
161
|
3345 |
|
$data = $this->stmt->fetchAll(); |
|
162
|
|
|
} else { |
|
163
|
|
|
$data = $this->stmt->fetchAll( |
|
164
|
|
|
$this->convertFetchMode($fetchMode), |
|
165
|
|
|
...$args |
|
|
|
|
|
|
166
|
|
|
); |
|
167
|
4396 |
|
} |
|
168
|
4396 |
|
} catch (\PDOException $exception) { |
|
169
|
|
|
throw new PDOException($exception); |
|
170
|
4396 |
|
} |
|
171
|
|
|
|
|
172
|
|
|
assert(is_array($data)); |
|
173
|
|
|
|
|
174
|
|
|
return $data; |
|
175
|
|
|
} |
|
176
|
|
|
|
|
177
|
|
|
/** |
|
178
|
|
|
* {@inheritdoc} |
|
179
|
4251 |
|
*/ |
|
180
|
|
|
public function fetchColumn(int $columnIndex = 0) |
|
181
|
|
|
{ |
|
182
|
4251 |
|
try { |
|
183
|
|
|
$value = $this->stmt->fetchColumn($columnIndex); |
|
184
|
|
|
|
|
185
|
|
|
if ($value === null) { |
|
186
|
|
|
$columnCount = $this->columnCount(); |
|
187
|
|
|
|
|
188
|
|
|
if ($columnIndex < 0 || $columnIndex >= $columnCount) { |
|
189
|
|
|
throw InvalidColumnIndex::new($columnIndex, $columnCount); |
|
190
|
|
|
} |
|
191
|
|
|
} |
|
192
|
|
|
|
|
193
|
4289 |
|
return $value; |
|
194
|
|
|
} catch (\PDOException $exception) { |
|
195
|
4289 |
|
throw new PDOException($exception); |
|
196
|
|
|
} |
|
197
|
|
|
} |
|
198
|
|
|
|
|
199
|
|
|
/** |
|
200
|
|
|
* Converts DBAL parameter type to PDO parameter type |
|
201
|
|
|
* |
|
202
|
|
|
* @param int $type Parameter type |
|
203
|
|
|
*/ |
|
204
|
|
|
private function convertParamType(int $type) : int |
|
205
|
4289 |
|
{ |
|
206
|
|
|
if (! isset(self::PARAM_TYPE_MAP[$type])) { |
|
207
|
|
|
// TODO: next major: throw an exception |
|
208
|
|
|
@trigger_error(sprintf( |
|
209
|
|
|
'Using a PDO parameter type (%d given) is deprecated and will cause an error in Doctrine 3.0.', |
|
210
|
|
|
$type |
|
211
|
|
|
), E_USER_DEPRECATED); |
|
212
|
|
|
|
|
213
|
4538 |
|
return $type; |
|
214
|
|
|
} |
|
215
|
4538 |
|
|
|
216
|
|
|
return self::PARAM_TYPE_MAP[$type]; |
|
217
|
2700 |
|
} |
|
218
|
|
|
|
|
219
|
1 |
|
/** |
|
220
|
2700 |
|
* Converts DBAL fetch mode to PDO fetch mode |
|
221
|
2700 |
|
* |
|
222
|
|
|
* @param int $fetchMode Fetch mode |
|
223
|
2700 |
|
*/ |
|
224
|
|
|
private function convertFetchMode(int $fetchMode) : int |
|
225
|
|
|
{ |
|
226
|
4538 |
|
if (! isset(self::FETCH_MODE_MAP[$fetchMode])) { |
|
227
|
|
|
// TODO: next major: throw an exception |
|
228
|
|
|
@trigger_error(sprintf( |
|
229
|
|
|
'Using a PDO fetch mode or their combination (%d given)' . |
|
230
|
|
|
' is deprecated and will cause an error in Doctrine 3.0.', |
|
231
|
|
|
$fetchMode |
|
232
|
|
|
), E_USER_DEPRECATED); |
|
233
|
|
|
|
|
234
|
|
|
return $fetchMode; |
|
235
|
|
|
} |
|
236
|
|
|
|
|
237
|
|
|
return self::FETCH_MODE_MAP[$fetchMode]; |
|
238
|
|
|
} |
|
239
|
|
|
|
|
240
|
|
|
/** |
|
241
|
|
|
* {@inheritdoc} |
|
242
|
|
|
*/ |
|
243
|
|
|
public function getIterator() |
|
244
|
|
|
{ |
|
245
|
|
|
yield from $this->stmt; |
|
246
|
|
|
} |
|
247
|
|
|
} |
|
248
|
|
|
|