blob: b158cfefedf01519a58b2f84d5c2f69aafc0bdca [file] [log] [blame]
adminff2d2512006-09-24 18:12:18 +00001<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
2/**
3 * Code Igniter
4 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
8 * @author Rick Ellis
9 * @copyright Copyright (c) 2006, pMachine, Inc.
10 * @license http://www.codeignitor.com/user_guide/license.html
11 * @link http://www.codeigniter.com
12 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * MySQLi Database Adapter Class - MySQLi only works with PHP 5
20 *
21 * Note: _DB is an extender class that the app controller
22 * creates dynamically based on whether the active record
23 * class is being used or not.
24 *
25 * @package CodeIgniter
26 * @subpackage Drivers
27 * @category Database
28 * @author Rick Ellis
29 * @link http://www.codeigniter.com/user_guide/database/
30 */
31class CI_DB_mysqli_driver extends CI_DB {
32
33 /**
34 * Whether to use the MySQL "delete hack" which allows the number
35 * of affected rows to be shown. Uses a preg_replace when enabled,
36 * adding a bit more processing to all queries.
37 */
38 var $delete_hack = TRUE;
39
40 // --------------------------------------------------------------------
41
42 /**
43 * Non-persistent database connection
44 *
45 * @access private called by the base class
46 * @return resource
47 */
48 function db_connect()
49 {
50 return mysqli_connect($this->hostname, $this->username, $this->password);
51 }
52
53 // --------------------------------------------------------------------
54
55 /**
56 * Persistent database connection
57 *
58 * @access private called by the base class
59 * @return resource
60 */
61 function db_pconnect()
62 {
63 return $this->db_connect();
64 }
65
66 // --------------------------------------------------------------------
67
68 /**
69 * Select the database
70 *
71 * @access private called by the base class
72 * @return resource
73 */
74 function db_select()
75 {
76 return @mysqli_select_db($this->conn_id, $this->database);
77 }
admin9cd4e8e2006-09-25 23:26:25 +000078
79 // --------------------------------------------------------------------
80
81 /**
82 * Version number query string
83 *
84 * @access public
85 * @return string
86 */
87 function _version()
88 {
89 return "SELECT version() AS ver";
90 }
91
adminff2d2512006-09-24 18:12:18 +000092 // --------------------------------------------------------------------
93
94 /**
95 * Execute the query
96 *
97 * @access private called by the base class
98 * @param string an SQL query
99 * @return resource
100 */
101 function _execute($sql)
102 {
103 $sql = $this->_prep_query($sql);
104 $result = @mysqli_query($this->conn_id, $sql);
105 return $result;
106 }
107
108 // --------------------------------------------------------------------
109
110 /**
111 * Prep the query
112 *
113 * If needed, each database adapter can prep the query string
114 *
115 * @access private called by execute()
116 * @param string an SQL query
117 * @return string
118 */
119 function _prep_query($sql)
120 {
121 // "DELETE FROM TABLE" returns 0 affected rows This hack modifies
122 // the query so that it returns the number of affected rows
123 if ($this->delete_hack === TRUE)
124 {
125 if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $sql))
126 {
127 $sql = preg_replace("/^\s*DELETE\s+FROM\s+(\S+)\s*$/", "DELETE FROM \\1 WHERE 1=1", $sql);
128 }
129 }
130
131 return $sql;
132 }
133
134 // --------------------------------------------------------------------
135
136 /**
137 * Begin Transaction
138 *
139 * @access public
140 * @return bool
141 */
142 function trans_begin($test_mode = FALSE)
143 {
144 if ( ! $this->trans_enabled)
145 {
146 return TRUE;
147 }
148
149 // When transactions are nested we only begin/commit/rollback the outermost ones
150 if ($this->_trans_depth > 0)
151 {
152 return TRUE;
153 }
154
155 // Reset the transaction failure flag.
156 // If the $test_mode flag is set to TRUE transactions will be rolled back
157 // even if the queries produce a successful result.
158 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
159
160 $this->simple_query('SET AUTOCOMMIT=0');
161 $this->simple_query('START TRANSACTION'); // can also be BEGIN or BEGIN WORK
162 return TRUE;
163 }
164
165 // --------------------------------------------------------------------
166
167 /**
168 * Commit Transaction
169 *
170 * @access public
171 * @return bool
172 */
173 function trans_commit()
174 {
175 if ( ! $this->trans_enabled)
176 {
177 return TRUE;
178 }
179
180 // When transactions are nested we only begin/commit/rollback the outermost ones
181 if ($this->_trans_depth > 0)
182 {
183 return TRUE;
184 }
185
186 $this->simple_query('COMMIT');
187 $this->simple_query('SET AUTOCOMMIT=1');
188 return TRUE;
189 }
190
191 // --------------------------------------------------------------------
192
193 /**
194 * Rollback Transaction
195 *
196 * @access public
197 * @return bool
198 */
199 function trans_rollback()
200 {
201 if ( ! $this->trans_enabled)
202 {
203 return TRUE;
204 }
205
206 // When transactions are nested we only begin/commit/rollback the outermost ones
207 if ($this->_trans_depth > 0)
208 {
209 return TRUE;
210 }
211
212 $this->simple_query('ROLLBACK');
213 $this->simple_query('SET AUTOCOMMIT=1');
214 return TRUE;
215 }
216
217 // --------------------------------------------------------------------
218
219 /**
220 * Escape String
221 *
222 * @access public
223 * @param string
224 * @return string
225 */
226 function escape_str($str)
227 {
admin17a890d2006-09-27 20:42:42 +0000228 if (get_magic_quotes_gpc())
229 {
230 return $str;
231 }
232
admin33de9a12006-09-28 06:50:16 +0000233 return mysqli_real_escape_string($this->conn_id, $str);
adminff2d2512006-09-24 18:12:18 +0000234 }
235
236 // --------------------------------------------------------------------
237
238 /**
239 * Affected Rows
240 *
241 * @access public
242 * @return integer
243 */
244 function affected_rows()
245 {
246 return @mysqli_affected_rows($this->conn_id);
247 }
248
249 // --------------------------------------------------------------------
250
251 /**
252 * Insert ID
253 *
254 * @access public
255 * @return integer
256 */
257 function insert_id()
258 {
259 return @mysqli_insert_id($this->conn_id);
260 }
261
262 // --------------------------------------------------------------------
263
264 /**
265 * "Count All" query
266 *
267 * Generates a platform-specific query string that counts all records in
268 * the specified database
269 *
270 * @access public
271 * @param string
272 * @return string
273 */
274 function count_all($table = '')
275 {
276 if ($table == '')
277 return '0';
278
279 $query = $this->query("SELECT COUNT(*) AS numrows FROM `".$this->dbprefix.$table."`");
280
281 if ($query->num_rows() == 0)
282 return '0';
283
284 $row = $query->row();
285 return $row->numrows;
286 }
287
288 // --------------------------------------------------------------------
289
290 /**
admin9cd4e8e2006-09-25 23:26:25 +0000291 * Show columnn query
292 *
293 * Generates a platform-specific query string so that the column names can be fetched
294 *
295 * @access public
296 * @param string the table name
297 * @return string
298 */
299 function _list_columns($table = '')
300 {
301 return "SHOW COLUMNS FROM ".$this->_escape_table($table);
302 }
303
304 // --------------------------------------------------------------------
305
306 /**
307 * Field data query
308 *
309 * Generates a platform-specific query so that the column data can be retrieved
310 *
311 * @access public
312 * @param string the table name
313 * @return object
314 */
315 function _field_data($table)
316 {
317 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
318 }
319
320 // --------------------------------------------------------------------
321
322 /**
adminff2d2512006-09-24 18:12:18 +0000323 * The error message string
324 *
adminbb1d4392006-09-24 20:14:38 +0000325 * @access private
adminff2d2512006-09-24 18:12:18 +0000326 * @return string
327 */
adminbb1d4392006-09-24 20:14:38 +0000328 function _error_message()
adminff2d2512006-09-24 18:12:18 +0000329 {
330 return mysqli_error($this->conn_id);
331 }
332
333 // --------------------------------------------------------------------
334
335 /**
336 * The error message number
337 *
adminbb1d4392006-09-24 20:14:38 +0000338 * @access private
adminff2d2512006-09-24 18:12:18 +0000339 * @return integer
340 */
adminbb1d4392006-09-24 20:14:38 +0000341 function _error_number()
adminff2d2512006-09-24 18:12:18 +0000342 {
343 return mysqli_errno($this->conn_id);
344 }
345
346 // --------------------------------------------------------------------
347
348 /**
349 * Escape Table Name
350 *
351 * This function adds backticks if the table name has a period
352 * in it. Some DBs will get cranky unless periods are escaped
353 *
adminbb1d4392006-09-24 20:14:38 +0000354 * @access private
adminff2d2512006-09-24 18:12:18 +0000355 * @param string the table name
356 * @return string
357 */
adminbb1d4392006-09-24 20:14:38 +0000358 function _escape_table($table)
adminff2d2512006-09-24 18:12:18 +0000359 {
360 if (stristr($table, '.'))
361 {
362 $table = preg_replace("/\./", "`.`", $table);
363 }
364
365 return $table;
366 }
adminbb1d4392006-09-24 20:14:38 +0000367
adminff2d2512006-09-24 18:12:18 +0000368 // --------------------------------------------------------------------
369
370 /**
371 * Insert statement
372 *
373 * Generates a platform-specific insert string from the supplied data
374 *
375 * @access public
376 * @param string the table name
377 * @param array the insert keys
378 * @param array the insert values
379 * @return string
380 */
381 function _insert($table, $keys, $values)
382 {
adminbb1d4392006-09-24 20:14:38 +0000383 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
adminff2d2512006-09-24 18:12:18 +0000384 }
385
386 // --------------------------------------------------------------------
387
388 /**
389 * Update statement
390 *
391 * Generates a platform-specific update string from the supplied data
392 *
393 * @access public
394 * @param string the table name
395 * @param array the update data
396 * @param array the where clause
397 * @return string
398 */
399 function _update($table, $values, $where)
400 {
401 foreach($values as $key => $val)
402 {
403 $valstr[] = $key." = ".$val;
404 }
405
adminbb1d4392006-09-24 20:14:38 +0000406 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
adminff2d2512006-09-24 18:12:18 +0000407 }
408
409 // --------------------------------------------------------------------
410
411 /**
412 * Delete statement
413 *
414 * Generates a platform-specific delete string from the supplied data
415 *
416 * @access public
417 * @param string the table name
418 * @param array the where clause
419 * @return string
420 */
421 function _delete($table, $where)
422 {
adminbb1d4392006-09-24 20:14:38 +0000423 return "DELETE FROM ".$this->_escape_table($table)." WHERE ".implode(" ", $where);
adminff2d2512006-09-24 18:12:18 +0000424 }
adminbb1d4392006-09-24 20:14:38 +0000425
426 // --------------------------------------------------------------------
427
428 /**
429 * Limit string
430 *
431 * Generates a platform-specific LIMIT clause
432 *
433 * @access public
434 * @param string the sql query string
435 * @param integer the number of rows to limit the query to
436 * @param integer the offset value
437 * @return string
438 */
439 function _limit($sql, $limit, $offset)
440 {
441 $sql .= "LIMIT ".$limit;
adminff2d2512006-09-24 18:12:18 +0000442
adminbb1d4392006-09-24 20:14:38 +0000443 if ($offset > 0)
444 {
445 $sql .= " OFFSET ".$offset;
446 }
447
448 return $sql;
449 }
450
451 // --------------------------------------------------------------------
452
453 /**
454 * Close DB Connection
455 *
456 * @access public
457 * @param resource
458 * @return void
459 */
460 function _close($conn_id)
461 {
462 mysqli_close($conn_id);
463 }
464
adminff2d2512006-09-24 18:12:18 +0000465
466}
467
468?>