|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Yiisoft\Db\Driver\PDO; |
|
6
|
|
|
|
|
7
|
|
|
use PDO; |
|
8
|
|
|
use PDOException; |
|
9
|
|
|
use Psr\Log\LogLevel; |
|
10
|
|
|
use Yiisoft\Db\Cache\QueryCache; |
|
11
|
|
|
use Yiisoft\Db\Cache\SchemaCache; |
|
12
|
|
|
use Yiisoft\Db\Connection\Connection; |
|
13
|
|
|
use Yiisoft\Db\Exception\Exception; |
|
14
|
|
|
use Yiisoft\Db\Exception\InvalidCallException; |
|
15
|
|
|
use Yiisoft\Db\Exception\InvalidConfigException; |
|
16
|
|
|
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface; |
|
17
|
|
|
use Yiisoft\Db\Schema\QuoterInterface; |
|
18
|
|
|
use Yiisoft\Db\Schema\SchemaInterface; |
|
19
|
|
|
|
|
20
|
|
|
use function array_keys; |
|
21
|
|
|
use function is_string; |
|
22
|
|
|
|
|
23
|
|
|
abstract class ConnectionPDO extends Connection implements ConnectionPDOInterface |
|
24
|
|
|
{ |
|
25
|
|
|
protected ?PDO $pdo = null; |
|
26
|
|
|
protected string $serverVersion = ''; |
|
27
|
|
|
|
|
28
|
|
|
protected ?bool $emulatePrepare = null; |
|
29
|
|
|
|
|
30
|
|
|
protected ?QueryBuilderInterface $queryBuilder = null; |
|
31
|
|
|
protected ?QuoterInterface $quoter = null; |
|
32
|
|
|
protected ?SchemaInterface $schema = null; |
|
33
|
|
|
|
|
34
|
|
|
public function __construct( |
|
35
|
|
|
protected PDODriverInterface $driver, |
|
36
|
|
|
protected QueryCache $queryCache, |
|
37
|
|
|
protected SchemaCache $schemaCache |
|
38
|
|
|
) { |
|
39
|
|
|
parent::__construct($queryCache); |
|
40
|
|
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* Reset the connection after cloning. |
|
44
|
|
|
*/ |
|
45
|
|
|
public function __clone() |
|
46
|
|
|
{ |
|
47
|
|
|
$this->transaction = null; |
|
48
|
|
|
$this->pdo = null; |
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* Close the connection before serializing. |
|
53
|
|
|
* |
|
54
|
|
|
* @return array |
|
55
|
|
|
*/ |
|
56
|
|
|
public function __sleep(): array |
|
57
|
|
|
{ |
|
58
|
|
|
$fields = (array) $this; |
|
59
|
|
|
|
|
60
|
|
|
unset( |
|
61
|
|
|
$fields["\000*\000" . 'pdo'], |
|
62
|
|
|
$fields["\000*\000" . 'transaction'], |
|
63
|
|
|
$fields["\000*\000" . 'schema'] |
|
64
|
|
|
); |
|
65
|
|
|
|
|
66
|
|
|
return array_keys($fields); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
public function open(): void |
|
70
|
|
|
{ |
|
71
|
|
|
if (!empty($this->pdo)) { |
|
72
|
|
|
return; |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
if (empty($this->driver->getDsn())) { |
|
76
|
|
|
throw new InvalidConfigException('Connection::dsn cannot be empty.'); |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
$token = 'Opening DB connection: ' . $this->driver->getDsn(); |
|
80
|
|
|
|
|
81
|
|
|
try { |
|
82
|
|
|
$this->logger?->log(LogLevel::INFO, $token); |
|
83
|
|
|
$this->profiler?->begin($token, [__METHOD__]); |
|
84
|
|
|
$this->initConnection(); |
|
85
|
|
|
$this->profiler?->end($token, [__METHOD__]); |
|
86
|
|
|
} catch (PDOException $e) { |
|
87
|
|
|
$this->profiler?->end($token, [__METHOD__]); |
|
88
|
|
|
$this->logger?->log(LogLevel::ERROR, $token); |
|
89
|
|
|
|
|
90
|
|
|
throw new Exception($e->getMessage(), (array) $e->errorInfo, $e); |
|
91
|
|
|
} |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
public function close(): void |
|
95
|
|
|
{ |
|
96
|
|
|
if ($this->pdo !== null) { |
|
97
|
|
|
$this->logger?->log( |
|
98
|
|
|
LogLevel::DEBUG, |
|
99
|
|
|
'Closing DB connection: ' . $this->driver->getDsn() . ' ' . __METHOD__, |
|
100
|
|
|
); |
|
101
|
|
|
|
|
102
|
|
|
$this->pdo = null; |
|
103
|
|
|
$this->transaction = null; |
|
104
|
|
|
} |
|
105
|
|
|
} |
|
106
|
|
|
|
|
107
|
|
|
public function getCacheKey(): array |
|
108
|
|
|
{ |
|
109
|
|
|
return [$this->driver->getDsn(), $this->driver->getUsername()]; |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
public function getDriver(): PDODriverInterface |
|
113
|
|
|
{ |
|
114
|
|
|
return $this->driver; |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
public function getEmulatePrepare(): ?bool |
|
118
|
|
|
{ |
|
119
|
|
|
return $this->emulatePrepare; |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
public function getPdo(): ?PDO |
|
123
|
|
|
{ |
|
124
|
|
|
return $this->pdo; |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
|
|
/** |
|
128
|
|
|
* Input variables $sql and $forRead needs for future implementation of Connection + Pool |
|
129
|
|
|
* |
|
130
|
|
|
* @param string|null $sql |
|
131
|
|
|
* @param bool|null $forRead |
|
132
|
|
|
* |
|
133
|
|
|
* @throws Exception |
|
134
|
|
|
* @throws InvalidConfigException |
|
135
|
|
|
* |
|
136
|
|
|
* @return PDO |
|
137
|
|
|
*/ |
|
138
|
|
|
public function getActivePDO(?string $sql = '', ?bool $forRead = null): PDO |
|
139
|
|
|
{ |
|
140
|
|
|
$this->open(); |
|
141
|
|
|
$pdo = $this->getPDO(); |
|
142
|
|
|
|
|
143
|
|
|
if ($pdo === null) { |
|
144
|
|
|
throw new Exception('PDO cannot be initialized.'); |
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
|
|
return $pdo; |
|
148
|
|
|
} |
|
149
|
|
|
|
|
150
|
|
|
public function getLastInsertID(?string $sequenceName = null): string |
|
151
|
|
|
{ |
|
152
|
|
|
if ($this->isActive() && $this->pdo) { |
|
153
|
|
|
return $this->pdo->lastInsertID($sequenceName === null ? null : $this->getQuoter()->quoteTableName($sequenceName)); |
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
|
|
throw new InvalidCallException('DB Connection is not active.'); |
|
157
|
|
|
} |
|
158
|
|
|
|
|
159
|
|
|
/** |
|
160
|
|
|
* @throws Exception |
|
161
|
|
|
*/ |
|
162
|
|
|
public function getServerVersion(): string |
|
163
|
|
|
{ |
|
164
|
|
|
if ($this->serverVersion === '') { |
|
165
|
|
|
/** @var mixed */ |
|
166
|
|
|
$version = $this->getActivePDO()->getAttribute(PDO::ATTR_SERVER_VERSION); |
|
167
|
|
|
$this->serverVersion = is_string($version) ? $version : 'Version could not be determined.'; |
|
168
|
|
|
} |
|
169
|
|
|
|
|
170
|
|
|
return $this->serverVersion; |
|
171
|
|
|
} |
|
172
|
|
|
|
|
173
|
|
|
public function isActive(): bool |
|
174
|
|
|
{ |
|
175
|
|
|
return $this->pdo !== null; |
|
176
|
|
|
} |
|
177
|
|
|
|
|
178
|
|
|
public function setEmulatePrepare(bool $value): void |
|
179
|
|
|
{ |
|
180
|
|
|
$this->emulatePrepare = $value; |
|
181
|
|
|
} |
|
182
|
|
|
|
|
183
|
|
|
abstract protected function initConnection(): void; |
|
184
|
|
|
} |
|
185
|
|
|
|
yiisoft /
db
