blob: d6e967498606a02e664d46e5b8d7987ec2ffc6e9 [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 {
228 return mysqli_real_escape_string($this->conn_id, $str);
229 }
230
231 // --------------------------------------------------------------------
232
233 /**
234 * Affected Rows
235 *
236 * @access public
237 * @return integer
238 */
239 function affected_rows()
240 {
241 return @mysqli_affected_rows($this->conn_id);
242 }
243
244 // --------------------------------------------------------------------
245
246 /**
247 * Insert ID
248 *
249 * @access public
250 * @return integer
251 */
252 function insert_id()
253 {
254 return @mysqli_insert_id($this->conn_id);
255 }
256
257 // --------------------------------------------------------------------
258
259 /**
260 * "Count All" query
261 *
262 * Generates a platform-specific query string that counts all records in
263 * the specified database
264 *
265 * @access public
266 * @param string
267 * @return string
268 */
269 function count_all($table = '')
270 {
271 if ($table == '')
272 return '0';
273
274 $query = $this->query("SELECT COUNT(*) AS numrows FROM `".$this->dbprefix.$table."`");
275
276 if ($query->num_rows() == 0)
277 return '0';
278
279 $row = $query->row();
280 return $row->numrows;
281 }
282
283 // --------------------------------------------------------------------
284
285 /**
admin9cd4e8e2006-09-25 23:26:25 +0000286 * Show columnn query
287 *
288 * Generates a platform-specific query string so that the column names can be fetched
289 *
290 * @access public
291 * @param string the table name
292 * @return string
293 */
294 function _list_columns($table = '')
295 {
296 return "SHOW COLUMNS FROM ".$this->_escape_table($table);
297 }
298
299 // --------------------------------------------------------------------
300
301 /**
302 * Field data query
303 *
304 * Generates a platform-specific query so that the column data can be retrieved
305 *
306 * @access public
307 * @param string the table name
308 * @return object
309 */
310 function _field_data($table)
311 {
312 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
313 }
314
315 // --------------------------------------------------------------------
316
317 /**
adminff2d2512006-09-24 18:12:18 +0000318 * The error message string
319 *
adminbb1d4392006-09-24 20:14:38 +0000320 * @access private
adminff2d2512006-09-24 18:12:18 +0000321 * @return string
322 */
adminbb1d4392006-09-24 20:14:38 +0000323 function _error_message()
adminff2d2512006-09-24 18:12:18 +0000324 {
325 return mysqli_error($this->conn_id);
326 }
327
328 // --------------------------------------------------------------------
329
330 /**
331 * The error message number
332 *
adminbb1d4392006-09-24 20:14:38 +0000333 * @access private
adminff2d2512006-09-24 18:12:18 +0000334 * @return integer
335 */
adminbb1d4392006-09-24 20:14:38 +0000336 function _error_number()
adminff2d2512006-09-24 18:12:18 +0000337 {
338 return mysqli_errno($this->conn_id);
339 }
340
341 // --------------------------------------------------------------------
342
343 /**
344 * Escape Table Name
345 *
346 * This function adds backticks if the table name has a period
347 * in it. Some DBs will get cranky unless periods are escaped
348 *
adminbb1d4392006-09-24 20:14:38 +0000349 * @access private
adminff2d2512006-09-24 18:12:18 +0000350 * @param string the table name
351 * @return string
352 */
adminbb1d4392006-09-24 20:14:38 +0000353 function _escape_table($table)
adminff2d2512006-09-24 18:12:18 +0000354 {
355 if (stristr($table, '.'))
356 {
357 $table = preg_replace("/\./", "`.`", $table);
358 }
359
360 return $table;
361 }
adminbb1d4392006-09-24 20:14:38 +0000362
adminff2d2512006-09-24 18:12:18 +0000363 // --------------------------------------------------------------------
364
365 /**
366 * Insert statement
367 *
368 * Generates a platform-specific insert string from the supplied data
369 *
370 * @access public
371 * @param string the table name
372 * @param array the insert keys
373 * @param array the insert values
374 * @return string
375 */
376 function _insert($table, $keys, $values)
377 {
adminbb1d4392006-09-24 20:14:38 +0000378 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
adminff2d2512006-09-24 18:12:18 +0000379 }
380
381 // --------------------------------------------------------------------
382
383 /**
384 * Update statement
385 *
386 * Generates a platform-specific update string from the supplied data
387 *
388 * @access public
389 * @param string the table name
390 * @param array the update data
391 * @param array the where clause
392 * @return string
393 */
394 function _update($table, $values, $where)
395 {
396 foreach($values as $key => $val)
397 {
398 $valstr[] = $key." = ".$val;
399 }
400
adminbb1d4392006-09-24 20:14:38 +0000401 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
adminff2d2512006-09-24 18:12:18 +0000402 }
403
404 // --------------------------------------------------------------------
405
406 /**
407 * Delete statement
408 *
409 * Generates a platform-specific delete string from the supplied data
410 *
411 * @access public
412 * @param string the table name
413 * @param array the where clause
414 * @return string
415 */
416 function _delete($table, $where)
417 {
adminbb1d4392006-09-24 20:14:38 +0000418 return "DELETE FROM ".$this->_escape_table($table)." WHERE ".implode(" ", $where);
adminff2d2512006-09-24 18:12:18 +0000419 }
adminbb1d4392006-09-24 20:14:38 +0000420
421 // --------------------------------------------------------------------
422
423 /**
424 * Limit string
425 *
426 * Generates a platform-specific LIMIT clause
427 *
428 * @access public
429 * @param string the sql query string
430 * @param integer the number of rows to limit the query to
431 * @param integer the offset value
432 * @return string
433 */
434 function _limit($sql, $limit, $offset)
435 {
436 $sql .= "LIMIT ".$limit;
adminff2d2512006-09-24 18:12:18 +0000437
adminbb1d4392006-09-24 20:14:38 +0000438 if ($offset > 0)
439 {
440 $sql .= " OFFSET ".$offset;
441 }
442
443 return $sql;
444 }
445
446 // --------------------------------------------------------------------
447
448 /**
449 * Close DB Connection
450 *
451 * @access public
452 * @param resource
453 * @return void
454 */
455 function _close($conn_id)
456 {
457 mysqli_close($conn_id);
458 }
459
adminff2d2512006-09-24 18:12:18 +0000460
461}
462
463?>