-
Notifications
You must be signed in to change notification settings - Fork 0
/
pdb.php
267 lines (248 loc) · 7.28 KB
/
pdb.php
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
266
267
<?php
/**
* PDB
*
* Thin wrapper around PDO with convenience methods
*
* PHP Version 5
*
* @category Library
* @package PDB
* @author Stéphane Lavergne <lis@imars.com>
* @copyright 2016 Stéphane Lavergne
* @license https://opensource.org/licenses/MIT MIT License
* @link https://github.com/vphantom/php-library
*/
/**
* PDB class
*
* @category Library
* @package PDB
* @author Stéphane Lavergne <lis@imars.com>
* @copyright 2016 Stéphane Lavergne
* @license https://opensource.org/licenses/MIT MIT License
* @link https://github.com/vphantom/php-library
*/
class PDB
{
private $_dbh;
private $_sth;
private $_err;
/**
* Constructor
*
* @param string $dsn Database specification to pass to PDO
* @param string $user (Optional) Username for database
* @param string $pass (Optional) Password for database
*
* @return object PDB instance
*/
public function __construct($dsn, $user = null, $pass = null)
{
$this->_err = null;
$this->_sth = null;
$this->_dbh = new PDO($dsn, $user, $pass); // Letting PDOException bubble up
}
/**
* Begin transaction
*
* @return object PDB instance (for chaining)
*/
public function begin()
{
$this->_dbh->beginTransaction();
return $this;
}
/**
* Commit pending transaction
*
* @return object PDB instance (for chaining)
*/
public function commit()
{
$this->_dbh->commit();
return $this;
}
/**
* Rollback pending transaction
*
* @return object PDB instance (for chaining)
*/
public function rollback()
{
$this->_dbh->rollBack();
return $this;
}
/**
* Prepare a statement
*
* @param string $q SQL query with '?' value placeholders
*
* @return object PDB instance (for chaining)
*/
private function _prepare($q)
{
if ($this->_err) {
return $this;
};
if (!$this->_sth = $this->_dbh->prepare($q)) {
$this->_err = implode(' ', $this->_dbh->errorInfo());
};
return $this;
}
/**
* Execute stored prepared statement
*
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return object PDB instance (for chaining)
*/
private function _execute($args = array())
{
if ($this->_err) {
return $this;
};
if ($this->_sth) {
if (!$this->_sth->execute($args)) {
$this->_err = implode(' ', $this->_sth->errorInfo());
};
} else {
$this->_err = "No statement to execute.";
};
return $this;
}
/**
* Execute a result-less statement
*
* Typically INSERT, UPDATE, DELETE.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return int Number of affected rows, false on error
*/
public function exec($q, $args = array())
{
$this->_prepare($q)->_execute($args);
return $this->_sth ? $this->_sth->rowCount() : false;
}
/**
* Fetch last INSERT/UPDATE auto_increment ID
*
* This is a shortcut to the API value, to avoid performing a SELECT
* LAST_INSERT_ID() round-trip manually.
*
* @return string Last ID if supported/available
*/
public function lastInsertId()
{
return $this->dbh->lastInsertId();
}
/**
* Fetch a single value
*
* The result is the value returned in row 0, column 0. Useful for
* COUNT(*) and such. Extra columns/rows are safely ignored.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return mixed Single result cell, false if no results
*/
public function selectAtom($q, $args = array())
{
$this->exec($q, $args);
// FIXME: Test if it is indeed NULL
return $this->_sth ? $this->_sth->fetchColumn() : false;
}
/**
* Fetch a simple list of result values
*
* The result is a list of the values found in the first column of each
* row.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return array
*/
public function selectList($q, $args = array())
{
$this->exec($q, $args);
return $this->_sth ? $this->_sth->fetchAll(PDO::FETCH_COLUMN, 0) : false;
}
/**
* Fetch a single row as associative array
*
* Fetches the first row of results, so from the caller's side it's
* equivalent to selectArray()[0] however only the first row is ever
* fetched from the server.
*
* Note that if you're not selecting by a unique ID, a LIMIT of 1 should
* still be specified in SQL for optimal performance.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return array Single associative row
*/
public function selectSingleArray($q, $args = array())
{
$this->exec($q, $args);
return $this->_sth ? $this->_sth->fetch(PDO::FETCH_ASSOC) : false;
}
/**
* Fetch all results in an associative array
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return array All associative rows
*/
public function selectArray($q, $args = array())
{
$this->exec($q, $args);
return $this->_sth ? $this->_sth->fetchAll(PDO::FETCH_ASSOC) : false;
}
/**
* Fetch all results in an associative array, index by first column
*
* Whereas selectArray() returns a list of associative rows, this returns
* an associative array keyed on the first column of each row.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return array All associative rows, keyed on first column
*/
public function selectArrayIndexed($q, $args = array())
{
$this->exec($q, $args);
if ($this->_sth) {
$result = array();
while ($row = $this->_sth->fetch(PDO::FETCH_ASSOC)) {
$result[$row[key($row)]] = $row;
};
return $result;
} else {
return false;
};
}
/**
* Fetch 2-column result into associative array
*
* Create one key per row, indexed on the first column, containing the
* second column. Handy for retreiving key/value pairs.
*
* @param string $q SQL query with '?' value placeholders
* @param array $args (Optional) List of values corresponding to placeholders
*
* @return array Associative pairs
*/
public function selectArrayPairs($q, $args = array())
{
$this->exec($q, $args);
return $this->_sth ? $this->_sth->fetchAll(PDO::FETCH_COLUMN | PDO::FETCH_GROUP) : false;
}
}
?>