Rev 75 | Rev 77 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 75 | Rev 76 | ||
---|---|---|---|
1 | <?php
|
1 | <?php
|
2 | 2 | ||
3 | namespace PointedEars\PHPX\Db; |
3 | namespace PointedEars\PHPX\Db; |
4 | 4 | ||
5 | require_once __DIR__ . '/../global.inc'; |
5 | require_once __DIR__ . '/../global.inc'; |
6 | 6 | ||
7 | /**
|
7 | /**
|
8 | * Generic database model class using PDO (PHP Data Objects)
|
8 | * Generic database model class using PDO (PHP Data Objects)
|
9 | *
|
9 | *
|
10 | * @property-read PDO $connection
|
10 | * @property-read PDO $connection
|
11 | * Database connection. Established on read access to this
|
11 | * Database connection. Established on read access to this
|
12 | * property if not yet established.
|
12 | * property if not yet established.
|
13 | * @property-read array $lastError
|
13 | * @property-read array $lastError
|
14 | * Last error information of the database operation.
|
14 | * Last error information of the database operation.
|
15 | * See {@link PDOStatement::errorInfo()}.
|
15 | * See {@link PDOStatement::errorInfo()}.
|
16 | * @property-read string $lastInsertId
|
16 | * @property-read string $lastInsertId
|
17 | * ID of the last inserted row, or the last value from a sequence object,
|
17 | * ID of the last inserted row, or the last value from a sequence object,
|
18 | * depending on the underlying driver. May not be supported by all databases.
|
18 | * depending on the underlying driver. May not be supported by all databases.
|
19 | * @property-read array $lastResult
|
19 | * @property-read array $lastResult
|
20 | * Last result of the database operation
|
20 | * Last result of the database operation
|
21 | * @property-read boolean $lastSuccess
|
21 | * @property-read boolean $lastSuccess
|
22 | * Last success value of the database operation
|
22 | * Last success value of the database operation
|
23 | * @author Thomas Lahn
|
23 | * @author Thomas Lahn
|
24 | */
|
24 | */
|
25 | class Database extends \PointedEars\PHPX\AbstractModel |
25 | class Database extends \PointedEars\PHPX\AbstractModel |
26 | {
|
26 | {
|
27 | /* Access properties */
|
27 | /* Access properties */
|
28 | 28 | ||
29 | /**
|
29 | /**
|
30 | * DSN of the database
|
30 | * DSN of the database
|
31 | * @var string
|
31 | * @var string
|
32 | */
|
32 | */
|
33 | protected $_dsn = ''; |
33 | protected $_dsn = ''; |
34 | 34 | ||
35 | /**
|
35 | /**
|
36 | * Username to access the database
|
36 | * Username to access the database
|
37 | * @var string
|
37 | * @var string
|
38 | */
|
38 | */
|
39 | protected $_username; |
39 | protected $_username; |
40 | 40 | ||
41 | /**
|
41 | /**
|
42 | * Password to access the database
|
42 | * Password to access the database
|
43 | * @var string
|
43 | * @var string
|
44 | */
|
44 | */
|
45 | protected $_password; |
45 | protected $_password; |
46 | 46 | ||
47 | /**
|
47 | /**
|
48 | * PDO driver-specific options
|
48 | * PDO driver-specific options
|
49 | * @var array
|
49 | * @var array
|
50 | */
|
50 | */
|
51 | protected $_options = array(); |
51 | protected $_options = array(); |
52 | 52 | ||
53 | /**
|
53 | /**
|
54 | * Database-specific string to use for quoting a name or value
|
54 | * Database-specific string to use for quoting a name or value
|
55 | * left-hand side (for security reasons and to prevent a name
|
55 | * left-hand side (for security reasons and to prevent a name
|
56 | * from being parsed as a keyword).
|
56 | * from being parsed as a keyword).
|
57 | * @var string
|
57 | * @var string
|
58 | */
|
58 | */
|
59 | protected $_leftQuote = ''; |
59 | protected $_leftQuote = ''; |
60 | 60 | ||
61 | /**
|
61 | /**
|
62 | * Database-specific string to use for quoting a name or value
|
62 | * Database-specific string to use for quoting a name or value
|
63 | * left-hand side (for security reasons and to prevent a name
|
63 | * left-hand side (for security reasons and to prevent a name
|
64 | * from being parsed as a keyword).
|
64 | * from being parsed as a keyword).
|
65 | * @var string
|
65 | * @var string
|
66 | */
|
66 | */
|
67 | protected $_rightQuote = ''; |
67 | protected $_rightQuote = ''; |
68 | 68 | ||
69 | /* Status properties */
|
69 | /* Status properties */
|
70 | 70 | ||
71 | /**
|
71 | /**
|
72 | * Database connection
|
72 | * Database connection
|
73 | * @var PDO
|
73 | * @var PDO
|
74 | */
|
74 | */
|
75 | protected $_connection; |
75 | protected $_connection; |
76 | 76 | ||
77 | /**
|
77 | /**
|
78 | * Last success value of the database operation
|
78 | * Last success value of the database operation
|
79 | * @var boolean
|
79 | * @var boolean
|
80 | */
|
80 | */
|
81 | protected $_lastSuccess; |
81 | protected $_lastSuccess; |
82 | 82 | ||
83 | /**
|
83 | /**
|
84 | * Last error information of the database operation
|
84 | * Last error information of the database operation
|
85 | * @var array
|
85 | * @var array
|
86 | */
|
86 | */
|
87 | protected $_lastError; |
87 | protected $_lastError; |
88 | 88 | ||
89 | /**
|
89 | /**
|
90 | * Last result of the database operation
|
90 | * Last result of the database operation
|
91 | * @var array
|
91 | * @var array
|
92 | */
|
92 | */
|
93 | protected $_lastResult; |
93 | protected $_lastResult; |
94 | 94 | ||
95 | /**
|
95 | /**
|
96 | * ID of the last inserted row, or the last value from a sequence object,
|
96 | * ID of the last inserted row, or the last value from a sequence object,
|
97 | * depending on the underlying driver. May not be supported by all databases.
|
97 | * depending on the underlying driver. May not be supported by all databases.
|
98 | * @var string
|
98 | * @var string
|
99 | */
|
99 | */
|
100 | protected $_lastInsertId = ''; |
100 | protected $_lastInsertId = ''; |
101 | 101 | ||
102 | /**
|
102 | /**
|
103 | * Creates a new <code>Database</code> instance.
|
103 | * Creates a new <code>Database</code> instance.
|
104 | *
|
104 | *
|
105 | * Each of the parameters is optional and can also be given
|
105 | * Each of the parameters is optional and can also be given
|
106 | * by a protected property where the parameter name is preceded
|
106 | * by a protected property where the parameter name is preceded
|
107 | * by <code>_</code>. Parameter values overwrite the default
|
107 | * by <code>_</code>. Parameter values overwrite the default
|
108 | * property values. It is recommended to use default property
|
108 | * property values. It is recommended to use default property
|
109 | * values of inheriting classes except for small applications
|
109 | * values of inheriting classes except for small applications
|
110 | * and testing purposes.
|
110 | * and testing purposes.
|
111 | *
|
111 | *
|
112 | * @param string $dsn
|
112 | * @param string $dsn
|
113 | * @param string $username
|
113 | * @param string $username
|
114 | * @param string $password
|
114 | * @param string $password
|
115 | * @param array $options
|
115 | * @param array $options
|
116 | * @see PDO::__construct()
|
116 | * @see PDO::__construct()
|
117 | */
|
117 | */
|
118 | public function __construct ($dsn = '', $username = null, |
118 | public function __construct ($dsn = '', $username = null, |
119 | $password = null, array $options = array()) |
119 | $password = null, array $options = array()) |
120 | {
|
120 | {
|
121 | if ($dsn !== '') |
121 | if ($dsn !== '') |
122 | {
|
122 | {
|
123 | $this->_dsn = $dsn; |
123 | $this->_dsn = $dsn; |
124 | }
|
124 | }
|
125 | 125 | ||
126 | if ($username !== null) |
126 | if ($username !== null) |
127 | {
|
127 | {
|
128 | $this->_username = $username; |
128 | $this->_username = $username; |
129 | }
|
129 | }
|
130 | 130 | ||
131 | if ($password !== null) |
131 | if ($password !== null) |
132 | {
|
132 | {
|
133 | $this->_password = $password; |
133 | $this->_password = $password; |
134 | }
|
134 | }
|
135 | 135 | ||
136 | if ($options) |
136 | if ($options) |
137 | {
|
137 | {
|
138 | $this->_options = $options; |
138 | $this->_options = $options; |
139 | }
|
139 | }
|
140 | }
|
140 | }
|
141 | 141 | ||
142 | /**
|
142 | /**
|
143 | * Reads the connection configuration for this database
|
143 | * Reads the connection configuration for this database
|
144 | * from the configuration file, .config
|
144 | * from the configuration file, .config
|
145 | *
|
145 | *
|
146 | * There must be an INI section named "database:" followed
|
146 | * There must be an INI section named "database:" followed
|
147 | * by the value of the <code>$_dbname</code> property
|
147 | * by the value of the <code>$_dbname</code> property
|
148 | * containing keys and values for the properties of the
|
148 | * containing keys and values for the properties of the
|
149 | * <code>Database</code> instance. Except for the key
|
149 | * <code>Database</code> instance. Except for the key
|
150 | * <code>dbname</code>, which allows for aliases, all
|
150 | * <code>dbname</code>, which allows for aliases, all
|
151 | * keys are ignored if the corresponding properties
|
151 | * keys are ignored if the corresponding properties
|
152 | * were set. That is, definitions in the class file
|
152 | * were set. That is, definitions in the class file
|
153 | * override those in the configuration file.
|
153 | * override those in the configuration file.
|
154 | *
|
154 | *
|
155 | * @return array|boolean
|
155 | * @return array|boolean
|
156 | * The configuration array if the configuration
|
156 | * The configuration array if the configuration
|
157 | * file could be read, <code>false</code> otherwise.
|
157 | * file could be read, <code>false</code> otherwise.
|
158 | */
|
158 | */
|
159 | public function readConfig () |
159 | public function readConfig () |
160 | {
|
160 | {
|
161 | /* FIXME: Configuration file path should not be hardcoded */
|
161 | /* FIXME: Configuration file path should not be hardcoded */
|
162 | $config = parse_ini_file('.config', true); |
162 | $config = parse_ini_file('.config', true); |
163 | if ($config !== false) |
163 | if ($config !== false) |
164 | {
|
164 | {
|
165 | $section = 'database:' . $this->_dbname; |
165 | $section = 'database:' . $this->_dbname; |
166 | if (isset($config[$section])) |
166 | if (isset($config[$section])) |
167 | {
|
167 | {
|
168 | $dbconfig = $config[$section]; |
168 | $dbconfig = $config[$section]; |
169 | $options = array( |
169 | $options = array( |
170 | 'host', 'port', 'dbname', 'username', 'password', 'charset' |
170 | 'host', 'port', 'dbname', 'username', 'password', 'charset' |
171 | ); |
171 | ); |
172 | 172 | ||
173 | foreach ($options as $key) |
173 | foreach ($options as $key) |
174 | {
|
174 | {
|
175 | $property = "_$key"; |
175 | $property = "_$key"; |
176 | if (isset($dbconfig[$key]) |
176 | if (isset($dbconfig[$key]) |
177 | && ($key == 'dbname' |
177 | && ($key == 'dbname' |
178 | || (property_exists($this, $property) |
178 | || (property_exists($this, $property) |
179 | && $this->$property === null))) |
179 | && $this->$property === null))) |
180 | {
|
180 | {
|
181 | $this->$property = $dbconfig[$key]; |
181 | $this->$property = $dbconfig[$key]; |
182 | }
|
182 | }
|
183 | }
|
183 | }
|
184 | 184 | ||
185 | return $config[$section]; |
185 | return $config[$section]; |
186 | }
|
186 | }
|
187 | }
|
187 | }
|
188 | 188 | ||
189 | return $config; |
189 | return $config; |
190 | }
|
190 | }
|
191 | 191 | ||
192 | /**
|
192 | /**
|
193 | * @return PDO
|
193 | * @return PDO
|
194 | */
|
194 | */
|
195 | public function getConnection () |
195 | public function getConnection () |
196 | {
|
196 | {
|
197 | if ($this->_connection === null) |
197 | if ($this->_connection === null) |
198 | {
|
198 | {
|
199 | $this->_connection = |
199 | $this->_connection = |
200 | new \PDO($this->_dsn, $this->_username, $this->_password, $this->_options); |
200 | new \PDO($this->_dsn, $this->_username, $this->_password, $this->_options); |
201 | }
|
201 | }
|
202 | 202 | ||
203 | return $this->_connection; |
203 | return $this->_connection; |
204 | }
|
204 | }
|
205 | 205 | ||
206 | /**
|
206 | /**
|
207 | * Creates a database according to the specified parameters
|
207 | * Creates a database according to the specified parameters
|
208 | *
|
208 | *
|
209 | * Should be overwritten and called by inheriting classes.
|
209 | * Should be overwritten and called by inheriting classes.
|
210 | *
|
210 | *
|
211 | * @param string $dsn
|
211 | * @param string $dsn
|
212 | * Connection DSN (required; must not include the database
|
212 | * Connection DSN (required; must not include the database
|
213 | * name).
|
213 | * name).
|
214 | * @param string $username = null
|
214 | * @param string $username = null
|
215 | * Connection username. The default is specified by the
|
215 | * Connection username. The default is specified by the
|
216 | * <code>$_username</code> property. Note that creating
|
216 | * <code>$_username</code> property. Note that creating
|
217 | * the database usually requires a user with more privileges
|
217 | * the database usually requires a user with more privileges
|
218 | * than the one accessing the database or its tables.
|
218 | * than the one accessing the database or its tables.
|
219 | * @param string $password = null
|
219 | * @param string $password = null
|
220 | * Connection password. The default is specified by the
|
220 | * Connection password. The default is specified by the
|
221 | * <code>$_password</code> property.
|
221 | * <code>$_password</code> property.
|
222 | * @param array? $options = null
|
222 | * @param array? $options = null
|
223 | * Connection options. The default is specified by the
|
223 | * Connection options. The default is specified by the
|
224 | * <code>$_options</code> property.
|
224 | * <code>$_options</code> property.
|
225 | * @param string $spec = null
|
225 | * @param string $spec = null
|
226 | * Additional database specifications, like character encoding
|
226 | * Additional database specifications, like character encoding
|
227 | * and collation.
|
227 | * and collation.
|
228 | * @param boolean $force = false
|
228 | * @param boolean $force = false
|
229 | * If a true-value, the database will be attempted to be
|
229 | * If a true-value, the database will be attempted to be
|
230 | * created even if there is a database of the name specified
|
230 | * created even if there is a database of the name specified
|
231 | * by the <code>$_dbname</code> property.
|
231 | * by the <code>$_dbname</code> property.
|
232 | * @return int
|
232 | * @return int
|
233 | * The number of rows affected by the CREATE DATABASE statement.
|
233 | * The number of rows affected by the CREATE DATABASE statement.
|
234 | * @see PDO::__construct()
|
234 | * @see PDO::__construct()
|
235 | * @see PDO::exec()
|
235 | * @see PDO::exec()
|
236 | */
|
236 | */
|
237 | public function create ($dsn, $username = null, $password = null, |
237 | public function create ($dsn, $username = null, $password = null, |
238 | array $options = null, $dbspec = null, $force = false) |
238 | array $options = null, $dbspec = null, $force = false) |
239 | {
|
239 | {
|
240 | $connection = new \PDO($dsn, |
240 | $connection = new \PDO($dsn, |
241 | $username !== null ? $username : $this->_username, |
241 | $username !== null ? $username : $this->_username, |
242 | $password !== null ? $password : $this->_password, |
242 | $password !== null ? $password : $this->_password, |
243 | $options !== null ? $options : $this->_options); |
243 | $options !== null ? $options : $this->_options); |
244 | 244 | ||
245 | $query = 'CREATE DATABASE' |
245 | $query = 'CREATE DATABASE' |
246 | . (!$force ? ' IF NOT EXISTS' : '') |
246 | . (!$force ? ' IF NOT EXISTS' : '') |
247 | . ' ' . $this->escapeName($this->_dbname) |
247 | . ' ' . $this->escapeName($this->_dbname) |
248 | . ($dbspec ? ' ' . $dbspec : ''); |
248 | . ($dbspec ? ' ' . $dbspec : ''); |
249 | 249 | ||
250 | return $connection->exec($query); |
250 | return $connection->exec($query); |
251 | }
|
251 | }
|
252 | 252 | ||
253 | /**
|
253 | /**
|
254 | * Maps column meta-information to a column definition.
|
254 | * Maps column meta-information to a column definition.
|
255 | *
|
255 | *
|
256 | * Should be overwritten and called by inheriting classes.
|
256 | * Should be overwritten and called by inheriting classes.
|
257 | *
|
257 | *
|
258 | * @todo
|
258 | * @todo
|
259 | * @param array $value
|
259 | * @param array $value
|
260 | * @param string $column_name
|
260 | * @param string $column_name
|
261 | * @return string
|
261 | * @return string
|
262 | */
|
262 | */
|
263 | protected function _columnDef (array $data, $column_name) |
263 | protected function _columnDef (array $data, $column_name) |
264 | {
|
264 | {
|
265 | $def = (isset($data['unsigned']) && $data['unsigned'] ? 'UNSIGNED ' : '') |
265 | $def = (isset($data['unsigned']) && $data['unsigned'] ? 'UNSIGNED ' : '') |
266 | . $data['type'] |
266 | . $data['type'] |
267 | . (isset($data['not_null']) && $data['not_null'] ? ' NOT NULL' : ' NULL') |
267 | . (isset($data['not_null']) && $data['not_null'] ? ' NOT NULL' : ' NULL') |
268 | . (isset($data['default']) && $data['default'] ? " DEFAULT {$data['default']}" : '') |
268 | . (isset($data['default']) && $data['default'] ? " DEFAULT {$data['default']}" : '') |
269 | . (isset($data['auto_inc']) && $data['auto_inc'] ? ' AUTO_INCREMENT' : '') |
269 | . (isset($data['auto_inc']) && $data['auto_inc'] ? ' AUTO_INCREMENT' : '') |
270 | . (isset($data['unique']) && $data['unique'] ? ' UNIQUE KEY' : '') |
270 | . (isset($data['unique']) && $data['unique'] ? ' UNIQUE KEY' : '') |
271 | . (isset($data['primary']) && $data['primary'] ? ' PRIMARY KEY' : '') |
271 | . (isset($data['primary']) && $data['primary'] ? ' PRIMARY KEY' : '') |
272 | . (isset($data['comment']) && $data['comment'] ? " COMMENT '{$data['comment']}'" : ''); |
272 | . (isset($data['comment']) && $data['comment'] ? " COMMENT '{$data['comment']}'" : ''); |
273 | 273 | ||
274 | return $this->escapeName($column_name) . ' ' . $def; |
274 | return $this->escapeName($column_name) . ' ' . $def; |
275 | }
|
275 | }
|
276 | 276 | ||
277 | /**
|
277 | /**
|
278 | * Creates a database table according to the specified parameters
|
278 | * Creates a database table according to the specified parameters
|
279 | *
|
279 | *
|
280 | * @todo
|
280 | * @todo
|
281 | * @param string $name
|
281 | * @param string $name
|
282 | * @param array $columns
|
282 | * @param array $columns
|
283 | * @param array $options = null
|
283 | * @param array $options = null
|
284 | * @return bool
|
284 | * @return bool
|
285 | * @see PDOStatement::execute()
|
285 | * @see PDOStatement::execute()
|
286 | */
|
286 | */
|
287 | public function createTable ($name, array $columns, array $options = null) |
287 | public function createTable ($name, array $columns, array $options = null) |
288 | {
|
288 | {
|
289 | $class = \get_class($this); |
289 | $class = \get_class($this); |
290 | $query = 'CREATE TABLE ' |
290 | $query = 'CREATE TABLE ' |
291 | . $this->escapeName($name) |
291 | . $this->escapeName($name) |
292 | . '(' |
292 | . '(' |
293 | . array_map(array($this, '_columnDef'), $columns, array_keys($columns)) . ')'; |
293 | . array_map(array($this, '_columnDef'), $columns, array_keys($columns)) . ')'; |
294 | 294 | ||
295 | $stmt = $this->prepare($query); |
295 | $stmt = $this->prepare($query); |
296 | 296 | ||
297 | /* DEBUG */
|
297 | /* DEBUG */
|
298 | if (defined('DEBUG') && DEBUG > 1) |
298 | if (defined('DEBUG') && DEBUG > 1) |
299 | {
|
299 | {
|
300 | debug(array( |
300 | debug(array( |
301 | 'query' => $query, |
301 | 'query' => $query, |
302 | )); |
302 | )); |
303 | }
|
303 | }
|
304 | 304 | ||
305 | $success =& $this->_lastSuccess; |
305 | $success =& $this->_lastSuccess; |
306 | $success = $stmt->execute(); |
306 | $success = $stmt->execute(); |
307 | 307 | ||
308 | $errorInfo =& $this->_lastError; |
308 | $errorInfo =& $this->_lastError; |
309 | $errorInfo = $stmt->errorInfo(); |
309 | $errorInfo = $stmt->errorInfo(); |
310 | 310 | ||
311 | $this->_resetLastInsertId(); |
311 | $this->_resetLastInsertId(); |
312 | 312 | ||
313 | $result =& $this->_lastResult; |
313 | $result =& $this->_lastResult; |
314 | $result = $stmt->fetchAll(); |
314 | $result = $stmt->fetchAll(); |
315 | 315 | ||
316 | if (defined('DEBUG') && DEBUG > 1) |
316 | if (defined('DEBUG') && DEBUG > 1) |
317 | {
|
317 | {
|
318 | debug(array( |
318 | debug(array( |
319 | '_lastSuccess' => $success, |
319 | '_lastSuccess' => $success, |
320 | '_lastError' => $errorInfo, |
320 | '_lastError' => $errorInfo, |
321 | '_lastResult' => $result |
321 | '_lastResult' => $result |
322 | )); |
322 | )); |
323 | }
|
323 | }
|
324 | 324 | ||
325 | return $success; |
325 | return $success; |
326 | }
|
326 | }
|
327 | 327 | ||
328 | /**
|
328 | /**
|
329 | * Initiates a transaction
|
329 | * Initiates a transaction
|
330 | *
|
330 | *
|
331 | * @return bool
|
331 | * @return bool
|
332 | * @see PDO::beginTransaction()
|
332 | * @see PDO::beginTransaction()
|
333 | */
|
333 | */
|
334 | public function beginTransaction() |
334 | public function beginTransaction() |
335 | {
|
335 | {
|
336 | return $this->connection->beginTransaction(); |
336 | return $this->connection->beginTransaction(); |
337 | }
|
337 | }
|
338 | 338 | ||
339 | /**
|
339 | /**
|
340 | * Rolls back a transaction
|
340 | * Rolls back a transaction
|
341 | *
|
341 | *
|
342 | * @return bool
|
342 | * @return bool
|
343 | * @see PDO::rollBack()
|
343 | * @see PDO::rollBack()
|
344 | */
|
344 | */
|
345 | public function rollBack() |
345 | public function rollBack() |
346 | {
|
346 | {
|
347 | return $this->connection->rollBack(); |
347 | return $this->connection->rollBack(); |
348 | }
|
348 | }
|
349 | 349 | ||
350 | /**
|
350 | /**
|
351 | * Commits a transaction
|
351 | * Commits a transaction
|
352 | *
|
352 | *
|
353 | * @return bool
|
353 | * @return bool
|
354 | * @see PDO::commit()
|
354 | * @see PDO::commit()
|
355 | */
|
355 | */
|
356 | public function commit() |
356 | public function commit() |
357 | {
|
357 | {
|
358 | return $this->connection->commit(); |
358 | return $this->connection->commit(); |
359 | }
|
359 | }
|
360 | 360 | ||
361 | /**
|
361 | /**
|
362 | * Prepares a statement for execution with the database
|
362 | * Prepares a statement for execution with the database
|
363 | * @param string $query
|
363 | * @param string $query
|
364 | */
|
364 | */
|
365 | public function prepare($query, array $driver_options = array()) |
365 | public function prepare($query, array $driver_options = array()) |
366 | {
|
366 | {
|
367 | return $this->connection->prepare($query, $driver_options); |
367 | return $this->connection->prepare($query, $driver_options); |
368 | }
|
368 | }
|
369 | 369 | ||
370 | /**
|
370 | /**
|
371 | * Returns the ID of the last inserted row, or the last value from
|
371 | * Returns the ID of the last inserted row, or the last value from
|
372 | * a sequence object, depending on the underlying driver.
|
372 | * a sequence object, depending on the underlying driver.
|
373 | *
|
373 | *
|
374 | * @return int
|
374 | * @return int
|
375 | */
|
375 | */
|
376 | public function getLastInsertId() |
376 | public function getLastInsertId() |
377 | {
|
377 | {
|
378 | return $this->_lastInsertId; |
378 | return $this->_lastInsertId; |
379 | }
|
379 | }
|
380 | 380 | ||
381 | /**
|
381 | /**
|
382 | * Returns the date of last modification of this database or
|
382 | * Returns the date of last modification of this database or
|
383 | * one of its tables.
|
383 | * one of its tables.
|
384 | *
|
384 | *
|
385 | * To be overridden by inheriting classes.
|
385 | * To be overridden by inheriting classes.
|
386 | *
|
386 | *
|
387 | * @param string $table (optional)
|
387 | * @param string $table (optional)
|
388 | * Table name. If not provided, all tables of this database
|
388 | * Table name. If not provided, all tables of this database
|
389 | * are considered.
|
389 | * are considered.
|
390 | * @return int|null
|
390 | * @return int|null
|
391 | * Timestamp of last modification, or <code>null</code> if
|
391 | * Timestamp of last modification, or <code>null</code> if
|
392 | * unavailable.
|
392 | * unavailable.
|
393 | */
|
393 | */
|
394 | public function getLastModified ($table = null) |
394 | public function getLastModified ($table = null) |
395 | {
|
395 | {
|
396 | return null; |
396 | return null; |
397 | }
|
397 | }
|
398 | 398 | ||
399 | /**
|
399 | /**
|
400 | * Escapes a database name so that it can be used in a query.
|
400 | * Escapes a database name so that it can be used in a query.
|
401 | *
|
401 | *
|
402 | * @param string $name
|
402 | * @param string $name
|
403 | * The name to be escaped
|
403 | * The name to be escaped
|
404 | * @return string
|
404 | * @return string
|
405 | * The escaped name
|
405 | * The escaped name
|
406 | */
|
406 | */
|
407 | public function escapeName($name) |
407 | public function escapeName($name) |
408 | {
|
408 | {
|
409 | return $this->_leftQuote . $name . $this->_rightQuote; |
409 | return $this->_leftQuote . $name . $this->_rightQuote; |
410 | }
|
410 | }
|
411 | 411 | ||
412 | /**
|
412 | /**
|
413 | * Determines if an array is associative (has not all integer keys).
|
413 | * Determines if an array is associative (has not all integer keys).
|
414 | *
|
414 | *
|
415 | * @author
|
415 | * @author
|
416 | * Algorithm courtesy of squirrel, <http://stackoverflow.com/a/5969617/855543>.
|
416 | * Algorithm courtesy of squirrel, <http://stackoverflow.com/a/5969617/855543>.
|
417 | * @param array $a
|
417 | * @param array $a
|
418 | * @return boolean
|
418 | * @return boolean
|
419 | * <code>true</code> if <var>$a</var> is associative,
|
419 | * <code>true</code> if <var>$a</var> is associative,
|
420 | * <code>false</code> otherwise
|
420 | * <code>false</code> otherwise
|
421 | */
|
421 | */
|
422 | protected function _isAssociativeArray(array $a) |
422 | protected function _isAssociativeArray(array $a) |
423 | {
|
423 | {
|
424 | for (reset($a); is_int(key($a)); next($a)); |
424 | for (reset($a); is_int(key($a)); next($a)); |
425 | return !is_null(key($a)); |
425 | return !is_null(key($a)); |
426 | }
|
426 | }
|
427 | 427 | ||
428 | /**
|
428 | /**
|
429 | * Escapes an associative array so that its string representation can be used
|
429 | * Escapes an associative array so that its string representation can be used
|
430 | * as list with table or column aliases in a query.
|
430 | * as list with table or column aliases in a query.
|
431 | *
|
431 | *
|
432 | * This method does not actually escape anything; it only inserts the
|
432 | * This method does not actually escape anything; it only inserts the
|
433 | * 'AS' keyword. It should be overridden by inheriting methods.
|
433 | * 'AS' keyword. It should be overridden by inheriting methods.
|
434 | *
|
434 | *
|
435 | * NOTE: This method intentionally does not check whether the array actually
|
435 | * NOTE: This method intentionally does not check whether the array actually
|
436 | * is associative.
|
436 | * is associative.
|
437 | *
|
437 | *
|
438 | * @param array &$array
|
438 | * @param array &$array
|
439 | * The array to be escaped
|
439 | * The array to be escaped
|
440 | * @return array
|
440 | * @return array
|
441 | * The escaped array
|
441 | * The escaped array
|
442 | */
|
442 | */
|
443 | protected function _escapeAliasArray(array &$array) |
443 | protected function _escapeAliasArray(array &$array) |
444 | {
|
444 | {
|
445 | foreach ($array as $column => &$value) |
445 | foreach ($array as $column => &$value) |
446 | {
|
446 | {
|
447 | $quotedColumn = $column; |
447 | $quotedColumn = $column; |
448 | if (strpos($column, $this->_leftQuote) === false |
448 | if (strpos($column, $this->_leftQuote) === false |
449 | && strpos($column, $this->_rightQuote) === false) |
449 | && strpos($column, $this->_rightQuote) === false) |
450 | {
|
450 | {
|
451 | $quotedColumn = $this->_leftQuote . $column . $this->_rightQuote; |
451 | $quotedColumn = $this->_leftQuote . $column . $this->_rightQuote; |
452 | }
|
452 | }
|
453 | 453 | ||
454 | $value = $value . ' AS ' . $quotedColumn; |
454 | $value = $value . ' AS ' . $quotedColumn; |
455 | }
|
455 | }
|
456 | 456 | ||
457 | return $array; |
457 | return $array; |
458 | }
|
458 | }
|
459 | 459 | ||
460 | /**
|
460 | /**
|
461 | * @param array $a
|
461 | * @param array $a
|
462 | * @param string $prefix
|
462 | * @param string $prefix
|
463 | */
|
463 | */
|
464 | private static function _expand(array $a, $prefix) |
464 | private static function _expand(array $a, $prefix) |
465 | {
|
465 | {
|
466 | $a2 = array(); |
466 | $a2 = array(); |
467 | 467 | ||
468 | foreach ($a as $key => $value) |
468 | foreach ($a as $key => $value) |
469 | {
|
469 | {
|
470 | $a2[] = ':' . $prefix . ($key + 1); |
470 | $a2[] = ':' . $prefix . ($key + 1); |
471 | }
|
471 | }
|
472 | 472 | ||
473 | return $a2; |
473 | return $a2; |
474 | }
|
474 | }
|
475 | 475 | ||
476 | /**
|
476 | /**
|
477 | * Escapes an associative array so that its string representation can be used
|
477 | * Escapes an associative array so that its string representation can be used
|
478 | * as value list in a query.
|
478 | * as value list in a query.
|
479 | *
|
479 | *
|
480 | * This method should be overridden by inheriting classes to escape
|
480 | * This method should be overridden by inheriting classes to escape
|
481 | * column names as fitting for the database schema they support. It is
|
481 | * column names as fitting for the database schema they support. It is
|
482 | * strongly recommended that the overriding methods call this method with
|
482 | * strongly recommended that the overriding methods call this method with
|
483 | * an appropriate <var>$escape</var> parameter, pass all other parameters
|
483 | * an appropriate <var>$escape</var> parameter, pass all other parameters
|
484 | * on unchanged, and return its return value.
|
484 | * on unchanged, and return its return value.
|
485 | *
|
485 | *
|
486 | * NOTE: Intentionally does not check whether the array actually is associative!
|
486 | * NOTE: Intentionally does not check whether the array actually is associative!
|
487 | *
|
487 | *
|
488 | * @param array &$array
|
488 | * @param array &$array
|
489 | * The array to be escaped
|
489 | * The array to be escaped
|
490 | * @param string $suffix
|
490 | * @param string $suffix
|
491 | * The string to be appended to the column name for the value placeholder.
|
491 | * The string to be appended to the column name for the value placeholder.
|
492 | * The default is the empty string.
|
492 | * The default is the empty string.
|
493 | * @param array $escape
|
493 | * @param array $escape
|
494 | * The strings to use left-hand side (index 0) and right-hand side (index 1)
|
494 | * The strings to use left-hand side (index 0) and right-hand side (index 1)
|
495 | * of the column name. The default is the empty string, respectively.
|
495 | * of the column name. The default is the empty string, respectively.
|
496 | * @return array
|
496 | * @return array
|
497 | * The escaped array
|
497 | * The escaped array
|
498 | */
|
498 | */
|
499 | protected function _escapeValueArray(array &$array, $suffix = '') |
499 | protected function _escapeValueArray(array &$array, $suffix = '') |
500 | {
|
500 | {
|
501 | $result = array(); |
501 | $result = array(); |
502 | foreach ($array as $column => $value) |
502 | foreach ($array as $column => $value) |
503 | {
|
503 | {
|
504 | $op = '='; |
504 | $op = '='; |
505 | $placeholder = ":{$column}"; |
505 | $placeholder = ":{$column}"; |
506 | 506 | ||
507 | if (is_array($value) && $this->_isAssociativeArray($value)) |
507 | if (is_array($value) && $this->_isAssociativeArray($value)) |
508 | {
|
508 | {
|
509 | reset($value); |
509 | reset($value); |
510 | $op = ' ' . key($value) . ' '; |
510 | $op = ' ' . key($value) . ' '; |
511 | 511 | ||
512 | $value = $value[key($value)]; |
512 | $value = $value[key($value)]; |
513 | }
|
513 | }
|
514 | 514 | ||
515 | if (is_array($value)) |
515 | if (is_array($value)) |
516 | {
|
516 | {
|
517 | $placeholder = '(' . implode(', ', self::_expand($value, $column)) . ')'; |
517 | $placeholder = '(' . implode(', ', self::_expand($value, $column)) . ')'; |
518 | }
|
518 | }
|
519 | 519 | ||
520 | $result[] = $this->_leftQuote . $column . $this->_rightQuote . "{$op}{$placeholder}{$suffix}"; |
520 | $result[] = $this->_leftQuote . $column . $this->_rightQuote . "{$op}{$placeholder}{$suffix}"; |
521 | }
|
521 | }
|
522 | 522 | ||
523 | return $result; |
523 | return $result; |
524 | }
|
524 | }
|
525 | 525 | ||
526 | /**
|
526 | /**
|
527 | * Constructs the WHERE part of a query
|
527 | * Constructs the WHERE part of a query
|
528 | *
|
528 | *
|
529 | * @param string|array $where
|
529 | * @param string|array $where
|
530 | * Condition
|
530 | * Condition
|
531 | * @param string $suffix
|
531 | * @param string $suffix
|
532 | * The string to be appended to the column name for the value placeholder,
|
532 | * The string to be appended to the column name for the value placeholder,
|
533 | * passed on to {@link Database::_escapeValueArray()}. The default is
|
533 | * passed on to {@link Database::_escapeValueArray()}. The default is
|
534 | * the empty string.
|
534 | * the empty string.
|
535 | * @return string
|
535 | * @return string
|
536 | * @see Database::_escapeValueArray()
|
536 | * @see Database::_escapeValueArray()
|
537 | */
|
537 | */
|
538 | protected function _where($where, $suffix = '') |
538 | protected function _where($where, $suffix = '') |
539 | {
|
539 | {
|
540 | if (!is_null($where)) |
540 | if (!is_null($where)) |
541 | {
|
541 | {
|
542 | if (is_array($where)) |
542 | if (is_array($where)) |
543 | {
|
543 | {
|
544 | if (count($where) < 1) |
544 | if (count($where) < 1) |
545 | {
|
545 | {
|
546 | return ''; |
546 | return ''; |
547 | }
|
547 | }
|
548 | 548 | ||
549 | if ($this->_isAssociativeArray($where)) |
549 | if ($this->_isAssociativeArray($where)) |
550 | {
|
550 | {
|
551 | $where = $this->_escapeValueArray($where, $suffix); |
551 | $where = $this->_escapeValueArray($where, $suffix); |
552 | }
|
552 | }
|
553 | 553 | ||
554 | $where = '(' . implode(') AND (', $where) . ')'; |
554 | $where = '(' . implode(') AND (', $where) . ')'; |
555 | }
|
555 | }
|
556 | 556 | ||
557 | return ' WHERE ' . $where; |
557 | return ' WHERE ' . $where; |
558 | }
|
558 | }
|
559 | 559 | ||
560 | return ''; |
560 | return ''; |
561 | }
|
561 | }
|
562 | 562 | ||
563 | /**
|
563 | /**
|
564 | * Selects data from one or more tables; the resulting records are stored
|
564 | * Selects data from one or more tables; the resulting records are stored
|
565 | * in the <code>result</code> property and returned as an associative array,
|
565 | * in the <code>result</code> property and returned as an associative array,
|
566 | * where the keys are the column (alias) names.
|
566 | * where the keys are the column (alias) names.
|
567 | *
|
567 | *
|
568 | * @param string|array[string] $tables Table(s) to select from
|
568 | * @param string|array[string] $tables Table(s) to select from
|
569 | * @param string|array[string] $columns Column(s) to select from (optional)
|
569 | * @param string|array[string] $columns Column(s) to select from (optional)
|
570 | * @param string|array $where Condition (optional)
|
570 | * @param string|array $where Condition (optional)
|
571 | * @param string $order Sort order (optional)
|
571 | * @param string $order Sort order (optional)
|
572 | * If provided, MUST start with ORDER BY or GROUP BY
|
572 | * If provided, MUST start with ORDER BY or GROUP BY
|
573 | * @param string $limit Limit (optional)
|
573 | * @param string $limit Limit (optional)
|
574 | * @param int $fetch_style
|
574 | * @param int $fetch_style
|
575 | * The mode that should be used for {@link PDOStatement::fetchAll()}.
|
575 | * The mode that should be used for {@link PDOStatement::fetchAll()}.
|
576 | * The default is {@link PDO::FETCH_ASSOC}.
|
576 | * The default is {@link PDO::FETCH_ASSOC}.
|
- | 577 | * @param bool $fetchAll
|
|
- | 578 | * If <code>true</code> (default), fetches all rows at once.
|
|
- | 579 | * You can set this to <code>false</code> in case of memory problems,
|
|
- | 580 | * in which case this function will return the prepared
|
|
- | 581 | * {@link PDOStatement} instead of the result array. You can then use
|
|
- | 582 | * {@link PDOStatement::fetch()} to get the returned rows iteratively.
|
|
- | 583 | * <var>fetch_style</var> will be ignored then, so that you can safely
|
|
- | 584 | * pass <code>null</code>, for example.
|
|
577 | * @return array
|
585 | * @return array|PDOStatement
|
578 | * @see Database::prepare()
|
586 | * @see Database::prepare()
|
579 | * @see PDOStatement::fetchAll()
|
587 | * @see PDOStatement::fetchAll()
|
580 | */
|
588 | */
|
581 | public function select($tables, $columns = null, $where = null, |
589 | public function select($tables, $columns = null, $where = null, |
582 | $order = null, $limit = null, $fetch_style = \PDO::FETCH_ASSOC) |
590 | $order = null, $limit = null, $fetch_style = \PDO::FETCH_ASSOC, |
- | 591 | $fetchAll = true) |
|
583 | {
|
592 | {
|
584 | if (is_null($columns)) |
593 | if (is_null($columns)) |
585 | {
|
594 | {
|
586 | $columns = array('*'); |
595 | $columns = array('*'); |
587 | }
|
596 | }
|
588 | 597 | ||
589 | if (is_array($columns)) |
598 | if (is_array($columns)) |
590 | {
|
599 | {
|
591 | if ($this->_isAssociativeArray($columns)) |
600 | if ($this->_isAssociativeArray($columns)) |
592 | {
|
601 | {
|
593 | $columns = $this->_escapeAliasArray($columns); |
602 | $columns = $this->_escapeAliasArray($columns); |
594 | }
|
603 | }
|
595 | 604 | ||
596 | $columns = implode(', ', $columns); |
605 | $columns = implode(', ', $columns); |
597 | }
|
606 | }
|
598 | 607 | ||
599 | if (is_array($tables)) |
608 | if (is_array($tables)) |
600 | {
|
609 | {
|
601 | if ($this->_isAssociativeArray($columns)) |
610 | if ($this->_isAssociativeArray($columns)) |
602 | {
|
611 | {
|
603 | $columns = $this->_escapeAliasArray($columns); |
612 | $columns = $this->_escapeAliasArray($columns); |
604 | }
|
613 | }
|
605 | 614 | ||
606 | $tables = implode(', ', $tables); |
615 | $tables = implode(', ', $tables); |
607 | }
|
616 | }
|
608 | 617 | ||
609 | $query = "SELECT {$columns} FROM {$tables}" . $this->_where($where); |
618 | $query = "SELECT {$columns} FROM {$tables}" . $this->_where($where); |
610 | 619 | ||
611 | if (!is_null($order)) |
620 | if (!is_null($order)) |
612 | {
|
621 | {
|
613 | if (is_array($order)) |
622 | if (is_array($order)) |
614 | {
|
623 | {
|
615 | $order = 'ORDER BY ' . implode(', ', $order); |
624 | $order = 'ORDER BY ' . implode(', ', $order); |
616 | }
|
625 | }
|
617 | 626 | ||
618 | $query .= " $order"; |
627 | $query .= " $order"; |
619 | }
|
628 | }
|
620 | 629 | ||
621 | if (!is_null($limit)) |
630 | if (!is_null($limit)) |
622 | {
|
631 | {
|
623 | $query .= " LIMIT $limit"; |
632 | $query .= " LIMIT $limit"; |
624 | }
|
633 | }
|
625 | 634 | ||
- | 635 | $stmt = ($fetchAll |
|
626 | $stmt = $this->prepare($query); |
636 | ? $this->prepare($query) |
- | 637 | : $this->prepare($query, array(\PDO::ATTR_CURSOR => \PDO::CURSOR_SCROLL))); |
|
627 | 638 | ||
628 | $params = array(); |
639 | $params = array(); |
629 | 640 | ||
630 | if (is_array($where) && $this->_isAssociativeArray($where)) |
641 | if (is_array($where) && $this->_isAssociativeArray($where)) |
631 | {
|
642 | {
|
632 | /* FIXME: Export and reuse this */
|
643 | /* FIXME: Export and reuse this */
|
633 | foreach ($where as $column => $condition) |
644 | foreach ($where as $column => $condition) |
634 | {
|
645 | {
|
635 | /* TODO: Also handle function calls as keys */
|
646 | /* TODO: Also handle function calls as keys */
|
636 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
647 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
637 | {
|
648 | {
|
638 | reset($condition); |
649 | reset($condition); |
639 | $condition = $condition[key($condition)]; |
650 | $condition = $condition[key($condition)]; |
640 | 651 | ||
641 | if (is_array($condition)) |
652 | if (is_array($condition)) |
642 | {
|
653 | {
|
643 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
654 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
644 | {
|
655 | {
|
645 | $params[$param_name] = $condition[$param_index]; |
656 | $params[$param_name] = $condition[$param_index]; |
646 | }
|
657 | }
|
647 | }
|
658 | }
|
648 | }
|
659 | }
|
649 | else
|
660 | else
|
650 | {
|
661 | {
|
651 | $params[":{$column}"] = $condition; |
662 | $params[":{$column}"] = $condition; |
652 | }
|
663 | }
|
653 | }
|
664 | }
|
654 | }
|
665 | }
|
655 | 666 | ||
656 | /* DEBUG */
|
667 | /* DEBUG */
|
657 | if (defined('DEBUG') && DEBUG > 1) |
668 | if (defined('DEBUG') && DEBUG > 1) |
658 | {
|
669 | {
|
659 | debug(array( |
670 | debug(array( |
660 | 'query' => $query, |
671 | 'query' => $query, |
661 | 'params' => $params |
672 | 'params' => $params |
662 | )); |
673 | )); |
663 | }
|
674 | }
|
664 | 675 | ||
665 | $success =& $this->_lastSuccess; |
676 | $success =& $this->_lastSuccess; |
666 | $success = $stmt->execute($params); |
677 | $success = $stmt->execute($params); |
667 | 678 | ||
668 | $errorInfo =& $this->_lastError; |
679 | $errorInfo =& $this->_lastError; |
669 | $errorInfo = $stmt->errorInfo(); |
680 | $errorInfo = $stmt->errorInfo(); |
670 | 681 | ||
671 | $result =& $this->_lastResult; |
682 | $result =& $this->_lastResult; |
- | 683 | ||
- | 684 | if ($fetchAll) |
|
- | 685 | {
|
|
672 | $result = $stmt->fetchAll($fetch_style); |
686 | $result = $stmt->fetchAll($fetch_style); |
- | 687 | }
|
|
- | 688 | else
|
|
- | 689 | {
|
|
- | 690 | $result = $stmt; |
|
- | 691 | }
|
|
673 | 692 | ||
674 | if (defined('DEBUG') && DEBUG > 1) |
693 | if (defined('DEBUG') && DEBUG > 1) |
675 | {
|
694 | {
|
676 | debug(array( |
695 | debug(array( |
677 | '_lastSuccess' => $success, |
696 | '_lastSuccess' => $success, |
678 | '_lastError' => $errorInfo, |
697 | '_lastError' => $errorInfo, |
679 | '_lastResult' => $result |
698 | '_lastResult' => $result |
680 | )); |
699 | )); |
681 | }
|
700 | }
|
682 | 701 | ||
683 | return $result; |
702 | return $result; |
684 | }
|
703 | }
|
685 | 704 | ||
686 | /**
|
705 | /**
|
687 | * Sets and returns the ID of the last inserted row, or the last value from
|
706 | * Sets and returns the ID of the last inserted row, or the last value from
|
688 | * a sequence object, depending on the underlying driver.
|
707 | * a sequence object, depending on the underlying driver.
|
689 | *
|
708 | *
|
690 | * @param string $name
|
709 | * @param string $name
|
691 | * Name of the sequence object from which the ID should be returned.
|
710 | * Name of the sequence object from which the ID should be returned.
|
692 | * @return string
|
711 | * @return string
|
693 | */
|
712 | */
|
694 | protected function _setLastInsertId($name = null) |
713 | protected function _setLastInsertId($name = null) |
695 | {
|
714 | {
|
696 | return ($this->_lastInsertId = $this->connection->lastInsertId($name)); |
715 | return ($this->_lastInsertId = $this->connection->lastInsertId($name)); |
697 | }
|
716 | }
|
698 | 717 | ||
699 | /**
|
718 | /**
|
700 | * Resets the the ID of the last inserted row, or the last value from
|
719 | * Resets the the ID of the last inserted row, or the last value from
|
701 | * a sequence object, depending on the underlying driver.
|
720 | * a sequence object, depending on the underlying driver.
|
702 | *
|
721 | *
|
703 | * @return string
|
722 | * @return string
|
704 | * The default value
|
723 | * The default value
|
705 | */
|
724 | */
|
706 | protected function _resetLastInsertId() |
725 | protected function _resetLastInsertId() |
707 | {
|
726 | {
|
708 | return ($this->_lastInsertId = ''); |
727 | return ($this->_lastInsertId = ''); |
709 | }
|
728 | }
|
710 | 729 | ||
711 | /**
|
730 | /**
|
712 | * Updates one or more records
|
731 | * Updates one or more records
|
713 | *
|
732 | *
|
714 | * @param string|array $tables
|
733 | * @param string|array $tables
|
715 | * Table name
|
734 | * Table name
|
716 | * @param array $updates
|
735 | * @param array $updates
|
717 | * Associative array of column-value pairs
|
736 | * Associative array of column-value pairs
|
718 | * @param array|string $where
|
737 | * @param array|string $where
|
719 | * Only the records matching this condition are updated
|
738 | * Only the records matching this condition are updated
|
720 | * @return bool
|
739 | * @return bool
|
721 | * @see PDOStatement::execute()
|
740 | * @see PDOStatement::execute()
|
722 | */
|
741 | */
|
723 | public function update ($tables, array $updates, $where = null) |
742 | public function update ($tables, array $updates, $where = null) |
724 | {
|
743 | {
|
725 | if (!$tables) |
744 | if (!$tables) |
726 | {
|
745 | {
|
727 | throw new InvalidArgumentException('No table specified'); |
746 | throw new InvalidArgumentException('No table specified'); |
728 | }
|
747 | }
|
729 | 748 | ||
730 | if (is_array($tables)) |
749 | if (is_array($tables)) |
731 | {
|
750 | {
|
732 | $tables = implode(', ', $tables); |
751 | $tables = implode(', ', $tables); |
733 | }
|
752 | }
|
734 | 753 | ||
735 | if (!$updates) |
754 | if (!$updates) |
736 | {
|
755 | {
|
737 | throw new InvalidArgumentException('No values specified'); |
756 | throw new InvalidArgumentException('No values specified'); |
738 | }
|
757 | }
|
739 | 758 | ||
740 | $params = array(); |
759 | $params = array(); |
741 | 760 | ||
742 | if ($this->_isAssociativeArray($updates)) |
761 | if ($this->_isAssociativeArray($updates)) |
743 | {
|
762 | {
|
744 | foreach ($updates as $key => $condition) |
763 | foreach ($updates as $key => $condition) |
745 | {
|
764 | {
|
746 | $params[":{$key}"] = $condition; |
765 | $params[":{$key}"] = $condition; |
747 | }
|
766 | }
|
748 | }
|
767 | }
|
749 | 768 | ||
750 | $updates = implode(', ', $this->_escapeValueArray($updates)); |
769 | $updates = implode(', ', $this->_escapeValueArray($updates)); |
751 | 770 | ||
752 | /* TODO: Should escape table names with escapeName(), but what about aliases? */
|
771 | /* TODO: Should escape table names with escapeName(), but what about aliases? */
|
753 | $query = "UPDATE {$tables} SET {$updates}" . $this->_where($where, '2'); |
772 | $query = "UPDATE {$tables} SET {$updates}" . $this->_where($where, '2'); |
754 | 773 | ||
755 | $stmt = $this->prepare($query); |
774 | $stmt = $this->prepare($query); |
756 | 775 | ||
757 | if (is_array($where) && $this->_isAssociativeArray($where)) |
776 | if (is_array($where) && $this->_isAssociativeArray($where)) |
758 | {
|
777 | {
|
759 | foreach ($where as $column => $condition) |
778 | foreach ($where as $column => $condition) |
760 | {
|
779 | {
|
761 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
780 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
762 | {
|
781 | {
|
763 | reset($condition); |
782 | reset($condition); |
764 | $condition = $condition[key($condition)]; |
783 | $condition = $condition[key($condition)]; |
765 | 784 | ||
766 | if (is_array($condition)) |
785 | if (is_array($condition)) |
767 | {
|
786 | {
|
768 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
787 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
769 | {
|
788 | {
|
770 | $params[$param_name] = $condition[$param_index]; |
789 | $params[$param_name] = $condition[$param_index]; |
771 | }
|
790 | }
|
772 | }
|
791 | }
|
773 | }
|
792 | }
|
774 | else
|
793 | else
|
775 | {
|
794 | {
|
776 | $params[":{$column}2"] = $condition; |
795 | $params[":{$column}2"] = $condition; |
777 | }
|
796 | }
|
778 | }
|
797 | }
|
779 | }
|
798 | }
|
780 | 799 | ||
781 | /* DEBUG */
|
800 | /* DEBUG */
|
782 | if (defined('DEBUG') && DEBUG > 1) |
801 | if (defined('DEBUG') && DEBUG > 1) |
783 | {
|
802 | {
|
784 | debug(array( |
803 | debug(array( |
785 | 'query' => $query, |
804 | 'query' => $query, |
786 | 'params' => $params |
805 | 'params' => $params |
787 | )); |
806 | )); |
788 | }
|
807 | }
|
789 | 808 | ||
790 | $success =& $this->_lastSuccess; |
809 | $success =& $this->_lastSuccess; |
791 | $success = $stmt->execute($params); |
810 | $success = $stmt->execute($params); |
792 | 811 | ||
793 | $errorInfo =& $this->_lastError; |
812 | $errorInfo =& $this->_lastError; |
794 | $errorInfo = $stmt->errorInfo(); |
813 | $errorInfo = $stmt->errorInfo(); |
795 | 814 | ||
796 | $this->_resetLastInsertId(); |
815 | $this->_resetLastInsertId(); |
797 | 816 | ||
798 | $result =& $this->_lastResult; |
817 | $result =& $this->_lastResult; |
799 | $result = $stmt->fetchAll(); |
818 | $result = $stmt->fetchAll(); |
800 | 819 | ||
801 | if (defined('DEBUG') && DEBUG > 1) |
820 | if (defined('DEBUG') && DEBUG > 1) |
802 | {
|
821 | {
|
803 | debug(array( |
822 | debug(array( |
804 | '_lastSuccess' => $success, |
823 | '_lastSuccess' => $success, |
805 | '_lastError' => $errorInfo, |
824 | '_lastError' => $errorInfo, |
806 | '_lastResult' => $result |
825 | '_lastResult' => $result |
807 | )); |
826 | )); |
808 | }
|
827 | }
|
809 | 828 | ||
810 | return $success; |
829 | return $success; |
811 | }
|
830 | }
|
812 | 831 | ||
813 | /**
|
832 | /**
|
814 | * Inserts a record into a table.<p>The AUTO_INCREMENT value of the inserted
|
833 | * Inserts a record into a table.<p>The AUTO_INCREMENT value of the inserted
|
815 | * row, if any (> 0), is stored in the {@link $lastInsertId} property of
|
834 | * row, if any (> 0), is stored in the {@link $lastInsertId} property of
|
816 | * the <code>Database</code> instance.</p>
|
835 | * the <code>Database</code> instance.</p>
|
817 | *
|
836 | *
|
818 | * @param string $table
|
837 | * @param string $table
|
819 | * Table name
|
838 | * Table name
|
820 | * @param array|string $values
|
839 | * @param array|string $values
|
821 | * Associative array of column-value pairs, indexed array,
|
840 | * Associative array of column-value pairs, indexed array,
|
822 | * or comma-separated list of values. If <var>$values</var> is not
|
841 | * or comma-separated list of values. If <var>$values</var> is not
|
823 | * an associative array, <var>$cols</var> must be passed if the
|
842 | * an associative array, <var>$cols</var> must be passed if the
|
824 | * values are not in column order (see below).
|
843 | * values are not in column order (see below).
|
825 | * @param array|string $cols
|
844 | * @param array|string $cols
|
826 | * Indexed array, or comma-separated list of column names.
|
845 | * Indexed array, or comma-separated list of column names.
|
827 | * Needs only be passed if <var>$values</var> is not an associative array
|
846 | * Needs only be passed if <var>$values</var> is not an associative array
|
828 | * and the values are not in column order (default: <code>null</code>);
|
847 | * and the values are not in column order (default: <code>null</code>);
|
829 | * is ignored otherwise. <strong>You SHOULD NOT rely on column order.</strong>
|
848 | * is ignored otherwise. <strong>You SHOULD NOT rely on column order.</strong>
|
830 | * @return bool
|
849 | * @return bool
|
831 | * @see PDOStatement::execute()
|
850 | * @see PDOStatement::execute()
|
832 | */
|
851 | */
|
833 | public function insert ($table, $values, $cols = null) |
852 | public function insert ($table, $values, $cols = null) |
834 | {
|
853 | {
|
835 | if ($cols != null) |
854 | if ($cols != null) |
836 | {
|
855 | {
|
837 | $cols = ' (' |
856 | $cols = ' (' |
838 | . (is_array($cols) |
857 | . (is_array($cols) |
839 | ? implode(', ', array_map(array($this, 'escapeName'), $cols)) |
858 | ? implode(', ', array_map(array($this, 'escapeName'), $cols)) |
840 | : $cols) . ')'; |
859 | : $cols) . ')'; |
841 | }
|
860 | }
|
842 | else
|
861 | else
|
843 | {
|
862 | {
|
844 | $cols = ''; |
863 | $cols = ''; |
845 | }
|
864 | }
|
846 | 865 | ||
847 | /* DEBUG */
|
866 | /* DEBUG */
|
848 | if (defined('DEBUG') && DEBUG > 2) |
867 | if (defined('DEBUG') && DEBUG > 2) |
849 | {
|
868 | {
|
850 | debug(array('values' => $values)); |
869 | debug(array('values' => $values)); |
851 | }
|
870 | }
|
852 | 871 | ||
853 | $params = array(); |
872 | $params = array(); |
854 | 873 | ||
855 | if (is_array($values)) |
874 | if (is_array($values)) |
856 | {
|
875 | {
|
857 | if ($this->_isAssociativeArray($values)) |
876 | if ($this->_isAssociativeArray($values)) |
858 | {
|
877 | {
|
859 | foreach ($values as $key => $condition) |
878 | foreach ($values as $key => $condition) |
860 | {
|
879 | {
|
861 | $params[":{$key}"] = $condition; |
880 | $params[":{$key}"] = $condition; |
862 | }
|
881 | }
|
863 | 882 | ||
864 | $values = $this->_escapeValueArray($values); |
883 | $values = $this->_escapeValueArray($values); |
865 | 884 | ||
866 | $cols = ''; |
885 | $cols = ''; |
867 | $values = 'SET ' . implode(', ', $values); |
886 | $values = 'SET ' . implode(', ', $values); |
868 | }
|
887 | }
|
869 | else
|
888 | else
|
870 | {
|
889 | {
|
871 | foreach ($values as &$value) |
890 | foreach ($values as &$value) |
872 | {
|
891 | {
|
873 | if (is_string($value)) |
892 | if (is_string($value)) |
874 | {
|
893 | {
|
875 | $value = "'" . $value . "'"; |
894 | $value = "'" . $value . "'"; |
876 | }
|
895 | }
|
877 | }
|
896 | }
|
878 | 897 | ||
879 | $values = 'VALUES (' . implode(', ', $values) . ')'; |
898 | $values = 'VALUES (' . implode(', ', $values) . ')'; |
880 | }
|
899 | }
|
881 | }
|
900 | }
|
882 | 901 | ||
883 | /* TODO: Should escape table names with escapeName(), but what about aliases? */
|
902 | /* TODO: Should escape table names with escapeName(), but what about aliases? */
|
884 | $query = "INSERT INTO {$table} {$cols} {$values}"; |
903 | $query = "INSERT INTO {$table} {$cols} {$values}"; |
885 | 904 | ||
886 | $stmt = $this->prepare($query); |
905 | $stmt = $this->prepare($query); |
887 | 906 | ||
888 | /* DEBUG */
|
907 | /* DEBUG */
|
889 | if (defined('DEBUG') && DEBUG > 1) |
908 | if (defined('DEBUG') && DEBUG > 1) |
890 | {
|
909 | {
|
891 | debug(array( |
910 | debug(array( |
892 | 'query' => $query, |
911 | 'query' => $query, |
893 | 'params' => $params |
912 | 'params' => $params |
894 | )); |
913 | )); |
895 | }
|
914 | }
|
896 | 915 | ||
897 | $success =& $this->_lastSuccess; |
916 | $success =& $this->_lastSuccess; |
898 | $success = $stmt->execute($params); |
917 | $success = $stmt->execute($params); |
899 | 918 | ||
900 | $errorInfo =& $this->_lastError; |
919 | $errorInfo =& $this->_lastError; |
901 | $errorInfo = $stmt->errorInfo(); |
920 | $errorInfo = $stmt->errorInfo(); |
902 | 921 | ||
903 | $this->_setLastInsertId(); |
922 | $this->_setLastInsertId(); |
904 | 923 | ||
905 | $result =& $this->_lastResult; |
924 | $result =& $this->_lastResult; |
906 | $result = $stmt->fetchAll(); |
925 | $result = $stmt->fetchAll(); |
907 | 926 | ||
908 | if (defined('DEBUG') && DEBUG > 1) |
927 | if (defined('DEBUG') && DEBUG > 1) |
909 | {
|
928 | {
|
910 | debug(array( |
929 | debug(array( |
911 | '_lastSuccess' => $success, |
930 | '_lastSuccess' => $success, |
912 | '_lastError' => $errorInfo, |
931 | '_lastError' => $errorInfo, |
913 | '_lastInsertId' => $this->_lastInsertId, |
932 | '_lastInsertId' => $this->_lastInsertId, |
914 | '_lastResult' => $result |
933 | '_lastResult' => $result |
915 | )); |
934 | )); |
916 | }
|
935 | }
|
917 | 936 | ||
918 | return $success; |
937 | return $success; |
919 | }
|
938 | }
|
920 | 939 | ||
921 | /**
|
940 | /**
|
922 | * Retrieves all rows from a table
|
941 | * Retrieves all rows from a table
|
923 | *
|
942 | *
|
924 | * @param int[optional] $fetch_style
|
943 | * @param int[optional] $fetch_style
|
925 | * @param int[optional] $column_index
|
944 | * @param int[optional] $column_index
|
926 | * @param array[optional] $ctor_args
|
945 | * @param array[optional] $ctor_args
|
927 | * @return array
|
946 | * @return array
|
928 | * @see PDOStatement::fetchAll()
|
947 | * @see PDOStatement::fetchAll()
|
929 | */
|
948 | */
|
930 | public function fetchAll($table, $fetch_style = null, $column_index = null, array $ctor_args = null) |
949 | public function fetchAll($table, $fetch_style = null, $column_index = null, array $ctor_args = null) |
931 | {
|
950 | {
|
932 | /* NOTE: Cannot use table name as statement parameter */
|
951 | /* NOTE: Cannot use table name as statement parameter */
|
933 | $stmt = $this->prepare("SELECT * FROM $table"); |
952 | $stmt = $this->prepare("SELECT * FROM $table"); |
934 | $this->_lastSuccess = $stmt->execute(); |
953 | $this->_lastSuccess = $stmt->execute(); |
935 | 954 | ||
936 | $this->_lastError = $stmt->errorInfo(); |
955 | $this->_lastError = $stmt->errorInfo(); |
937 | 956 | ||
938 | $result =& $this->_lastResult; |
957 | $result =& $this->_lastResult; |
939 | 958 | ||
940 | if (is_null($fetch_style)) |
959 | if (is_null($fetch_style)) |
941 | {
|
960 | {
|
942 | $fetch_style = \PDO::FETCH_ASSOC; |
961 | $fetch_style = \PDO::FETCH_ASSOC; |
943 | }
|
962 | }
|
944 | 963 | ||
945 | if (!is_null($ctor_args)) |
964 | if (!is_null($ctor_args)) |
946 | {
|
965 | {
|
947 | $result = $stmt->fetchAll($fetch_style, $column_index, $ctor_args); |
966 | $result = $stmt->fetchAll($fetch_style, $column_index, $ctor_args); |
948 | }
|
967 | }
|
949 | else if (!is_null($column_index)) |
968 | else if (!is_null($column_index)) |
950 | {
|
969 | {
|
951 | $result = $stmt->fetchAll($fetch_style, $column_index); |
970 | $result = $stmt->fetchAll($fetch_style, $column_index); |
952 | }
|
971 | }
|
953 | else if (!is_null($fetch_style)) |
972 | else if (!is_null($fetch_style)) |
954 | {
|
973 | {
|
955 | $result = $stmt->fetchAll($fetch_style); |
974 | $result = $stmt->fetchAll($fetch_style); |
956 | }
|
975 | }
|
957 | else
|
976 | else
|
958 | {
|
977 | {
|
959 | $result = $stmt->fetchAll(); |
978 | $result = $stmt->fetchAll(); |
960 | }
|
979 | }
|
961 | 980 | ||
962 | return $result; |
981 | return $result; |
963 | }
|
982 | }
|
964 | 983 | ||
965 | /**
|
984 | /**
|
966 | * Deletes one or more records
|
985 | * Deletes one or more records
|
967 | *
|
986 | *
|
968 | * @param string|array $tables
|
987 | * @param string|array $tables
|
969 | * Table name(s)
|
988 | * Table name(s)
|
970 | * @param array|string $where
|
989 | * @param array|string $where
|
971 | * Only the records matching this condition are deleted
|
990 | * Only the records matching this condition are deleted
|
972 | * @return bool
|
991 | * @return bool
|
973 | * @see PDOStatement::execute()
|
992 | * @see PDOStatement::execute()
|
974 | */
|
993 | */
|
975 | public function delete($tables, $where = null) |
994 | public function delete($tables, $where = null) |
976 | {
|
995 | {
|
977 | if (!$tables) |
996 | if (!$tables) |
978 | {
|
997 | {
|
979 | throw new InvalidArgumentException('No table specified'); |
998 | throw new InvalidArgumentException('No table specified'); |
980 | }
|
999 | }
|
981 | 1000 | ||
982 | if (is_array($tables)) |
1001 | if (is_array($tables)) |
983 | {
|
1002 | {
|
984 | $tables = implode(', ', $tables); |
1003 | $tables = implode(', ', $tables); |
985 | }
|
1004 | }
|
986 | 1005 | ||
987 | $params = array(); |
1006 | $params = array(); |
988 | 1007 | ||
989 | $query = "DELETE FROM {$tables}" . $this->_where($where); |
1008 | $query = "DELETE FROM {$tables}" . $this->_where($where); |
990 | 1009 | ||
991 | $stmt = $this->prepare($query); |
1010 | $stmt = $this->prepare($query); |
992 | 1011 | ||
993 | if ($this->_isAssociativeArray($where)) |
1012 | if ($this->_isAssociativeArray($where)) |
994 | {
|
1013 | {
|
995 | foreach ($where as $column => $condition) |
1014 | foreach ($where as $column => $condition) |
996 | {
|
1015 | {
|
997 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
1016 | if (is_array($condition) && $this->_isAssociativeArray($condition)) |
998 | {
|
1017 | {
|
999 | reset($condition); |
1018 | reset($condition); |
1000 | $condition = $condition[key($condition)]; |
1019 | $condition = $condition[key($condition)]; |
1001 | 1020 | ||
1002 | if (is_array($condition)) |
1021 | if (is_array($condition)) |
1003 | {
|
1022 | {
|
1004 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
1023 | foreach (self::_expand($condition, $column) as $param_index => $param_name) |
1005 | {
|
1024 | {
|
1006 | $params[$param_name] = $condition[$param_index]; |
1025 | $params[$param_name] = $condition[$param_index]; |
1007 | }
|
1026 | }
|
1008 | }
|
1027 | }
|
1009 | }
|
1028 | }
|
1010 | else
|
1029 | else
|
1011 | {
|
1030 | {
|
1012 | $params[":{$column}"] = $condition; |
1031 | $params[":{$column}"] = $condition; |
1013 | }
|
1032 | }
|
1014 | }
|
1033 | }
|
1015 | }
|
1034 | }
|
1016 | 1035 | ||
1017 | /* DEBUG */
|
1036 | /* DEBUG */
|
1018 | if (defined('DEBUG') && DEBUG > 1) |
1037 | if (defined('DEBUG') && DEBUG > 1) |
1019 | {
|
1038 | {
|
1020 | debug(array( |
1039 | debug(array( |
1021 | 'query' => $query, |
1040 | 'query' => $query, |
1022 | 'params' => $params |
1041 | 'params' => $params |
1023 | )); |
1042 | )); |
1024 | }
|
1043 | }
|
1025 | 1044 | ||
1026 | $success =& $this->_lastSuccess; |
1045 | $success =& $this->_lastSuccess; |
1027 | $success = $stmt->execute($params); |
1046 | $success = $stmt->execute($params); |
1028 | 1047 | ||
1029 | $result =& $this->_lastResult; |
1048 | $result =& $this->_lastResult; |
1030 | $result = $stmt->fetchAll(); |
1049 | $result = $stmt->fetchAll(); |
1031 | 1050 | ||
1032 | $errorInfo =& $this->_lastError; |
1051 | $errorInfo =& $this->_lastError; |
1033 | $errorInfo = $stmt->errorInfo(); |
1052 | $errorInfo = $stmt->errorInfo(); |
1034 | 1053 | ||
1035 | if (defined('DEBUG') && DEBUG > 1) |
1054 | if (defined('DEBUG') && DEBUG > 1) |
1036 | {
|
1055 | {
|
1037 | debug(array( |
1056 | debug(array( |
1038 | '_lastSuccess' => $success, |
1057 | '_lastSuccess' => $success, |
1039 | '_lastError' => $errorInfo, |
1058 | '_lastError' => $errorInfo, |
1040 | '_lastResult' => $result |
1059 | '_lastResult' => $result |
1041 | )); |
1060 | )); |
1042 | }
|
1061 | }
|
1043 | 1062 | ||
1044 | return $success; |
1063 | return $success; |
1045 | }
|
1064 | }
|
1046 | }
|
- | |
1047 | 1065 | }
|
|
- | 1066 |