blob: 293419e2329bb169d8c7066377811b282e284d44 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
WanWizard7219c072011-12-28 14:09:05 +01008 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02009 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
WanWizard7219c072011-12-28 14:09:05 +010010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
darwinel871754a2014-02-11 17:34:57 +010031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
Andrey Andreevfe9309d2015-01-09 17:48:58 +020032 * @copyright Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
34 * @link http://codeigniter.com
35 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
Jamie Rumbelow7efad202012-02-19 12:37:00 +000041 * Query Builder Class
Derek Allard2067d1a2008-11-13 22:59:24 +000042 *
Jamie Rumbelow7efad202012-02-19 12:37:00 +000043 * This is the platform-independent base Query Builder implementation class.
Derek Allard2067d1a2008-11-13 22:59:24 +000044 *
45 * @package CodeIgniter
46 * @subpackage Drivers
47 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050048 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000049 * @link http://codeigniter.com/user_guide/database/
50 */
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +010051
52abstract class CI_DB_query_builder extends CI_DB_driver {
Derek Allard2067d1a2008-11-13 22:59:24 +000053
Andrey Andreevae85eb42012-11-02 01:42:31 +020054 /**
55 * Return DELETE SQL flag
56 *
57 * @var bool
58 */
WanWizard7219c072011-12-28 14:09:05 +010059 protected $return_delete_sql = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +020060
61 /**
62 * Reset DELETE data flag
63 *
64 * @var bool
65 */
WanWizard7219c072011-12-28 14:09:05 +010066 protected $reset_delete_data = FALSE;
67
Andrey Andreevae85eb42012-11-02 01:42:31 +020068 /**
69 * QB SELECT data
70 *
71 * @var array
72 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000073 protected $qb_select = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +020074
75 /**
76 * QB DISTINCT flag
77 *
78 * @var bool
79 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000080 protected $qb_distinct = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +020081
82 /**
83 * QB FROM data
84 *
85 * @var array
86 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000087 protected $qb_from = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +020088
89 /**
90 * QB JOIN data
91 *
92 * @var array
93 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000094 protected $qb_join = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +020095
96 /**
97 * QB WHERE data
98 *
99 * @var array
100 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000101 protected $qb_where = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200102
103 /**
104 * QB GROUP BY data
105 *
106 * @var array
107 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000108 protected $qb_groupby = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200109
110 /**
111 * QB HAVING data
112 *
113 * @var array
114 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000115 protected $qb_having = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200116
117 /**
118 * QB keys
119 *
120 * @var array
121 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000122 protected $qb_keys = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200123
124 /**
125 * QB LIMIT data
126 *
127 * @var int
128 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000129 protected $qb_limit = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +0200130
131 /**
132 * QB OFFSET data
133 *
134 * @var int
135 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000136 protected $qb_offset = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +0200137
138 /**
139 * QB ORDER BY data
140 *
141 * @var array
142 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000143 protected $qb_orderby = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200144
145 /**
146 * QB data sets
147 *
148 * @var array
149 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000150 protected $qb_set = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200151
152 /**
153 * QB aliased tables list
154 *
155 * @var array
156 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000157 protected $qb_aliased_tables = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200158
159 /**
160 * QB WHERE group started flag
161 *
162 * @var bool
163 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000164 protected $qb_where_group_started = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +0200165
166 /**
167 * QB WHERE group count
168 *
169 * @var int
170 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000171 protected $qb_where_group_count = 0;
Barry Mienydd671972010-10-04 16:33:58 +0200172
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000173 // Query Builder Caching variables
Andrey Andreevae85eb42012-11-02 01:42:31 +0200174
175 /**
176 * QB Caching flag
177 *
178 * @var bool
179 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000180 protected $qb_caching = FALSE;
Andrey Andreevae85eb42012-11-02 01:42:31 +0200181
182 /**
183 * QB Cache exists list
184 *
185 * @var array
186 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000187 protected $qb_cache_exists = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200188
189 /**
190 * QB Cache SELECT data
191 *
192 * @var array
193 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000194 protected $qb_cache_select = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200195
196 /**
197 * QB Cache FROM data
198 *
199 * @var array
200 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000201 protected $qb_cache_from = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200202
203 /**
204 * QB Cache JOIN data
205 *
206 * @var array
207 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000208 protected $qb_cache_join = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200209
210 /**
211 * QB Cache WHERE data
212 *
213 * @var array
214 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000215 protected $qb_cache_where = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200216
217 /**
218 * QB Cache GROUP BY data
219 *
220 * @var array
221 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000222 protected $qb_cache_groupby = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200223
224 /**
225 * QB Cache HAVING data
226 *
227 * @var array
228 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000229 protected $qb_cache_having = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200230
231 /**
232 * QB Cache ORDER BY data
233 *
234 * @var array
235 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000236 protected $qb_cache_orderby = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200237
238 /**
239 * QB Cache data sets
240 *
241 * @var array
242 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000243 protected $qb_cache_set = array();
WanWizard7219c072011-12-28 14:09:05 +0100244
Andrey Andreevae85eb42012-11-02 01:42:31 +0200245 /**
246 * QB No Escape data
247 *
248 * @var array
249 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000250 protected $qb_no_escape = array();
Andrey Andreevae85eb42012-11-02 01:42:31 +0200251
252 /**
253 * QB Cache No Escape data
254 *
255 * @var array
256 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000257 protected $qb_cache_no_escape = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000258
Andrey Andreevae85eb42012-11-02 01:42:31 +0200259 // --------------------------------------------------------------------
260
Derek Allard2067d1a2008-11-13 22:59:24 +0000261 /**
262 * Select
263 *
264 * Generates the SELECT portion of the query
265 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000266 * @param string
Andrey Andreev42870232012-06-12 01:30:20 +0300267 * @param mixed
Andrew Podner4296a652012-12-17 07:51:15 -0500268 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000269 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600270 public function select($select = '*', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000271 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000272 if (is_string($select))
273 {
274 $select = explode(',', $select);
275 }
276
Vivek Dinesh33578d22014-02-06 09:46:07 +0530277 // If the escape value was not set, we will base it on the global setting
Andrey Andreev42870232012-06-12 01:30:20 +0300278 is_bool($escape) OR $escape = $this->_protect_identifiers;
279
Derek Allard2067d1a2008-11-13 22:59:24 +0000280 foreach ($select as $val)
281 {
282 $val = trim($val);
283
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100284 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000285 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000286 $this->qb_select[] = $val;
287 $this->qb_no_escape[] = $escape;
Derek Allard2067d1a2008-11-13 22:59:24 +0000288
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000289 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000290 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000291 $this->qb_cache_select[] = $val;
292 $this->qb_cache_exists[] = 'select';
293 $this->qb_cache_no_escape[] = $escape;
Derek Allard2067d1a2008-11-13 22:59:24 +0000294 }
295 }
296 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200297
Derek Allard2067d1a2008-11-13 22:59:24 +0000298 return $this;
299 }
300
301 // --------------------------------------------------------------------
302
303 /**
304 * Select Max
305 *
306 * Generates a SELECT MAX(field) portion of a query
307 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000308 * @param string the field
309 * @param string an alias
Andrew Podner4296a652012-12-17 07:51:15 -0500310 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000311 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600312 public function select_max($select = '', $alias = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000313 {
314 return $this->_max_min_avg_sum($select, $alias, 'MAX');
315 }
Barry Mienydd671972010-10-04 16:33:58 +0200316
Derek Allard2067d1a2008-11-13 22:59:24 +0000317 // --------------------------------------------------------------------
318
319 /**
320 * Select Min
321 *
322 * Generates a SELECT MIN(field) portion of a query
323 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000324 * @param string the field
325 * @param string an alias
Andrew Podner4296a652012-12-17 07:51:15 -0500326 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000327 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600328 public function select_min($select = '', $alias = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000329 {
330 return $this->_max_min_avg_sum($select, $alias, 'MIN');
331 }
332
333 // --------------------------------------------------------------------
334
335 /**
336 * Select Average
337 *
338 * Generates a SELECT AVG(field) portion of a query
339 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000340 * @param string the field
341 * @param string an alias
Andrew Podner4296a652012-12-17 07:51:15 -0500342 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000343 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600344 public function select_avg($select = '', $alias = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000345 {
346 return $this->_max_min_avg_sum($select, $alias, 'AVG');
347 }
348
349 // --------------------------------------------------------------------
350
351 /**
352 * Select Sum
353 *
354 * Generates a SELECT SUM(field) portion of a query
355 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000356 * @param string the field
357 * @param string an alias
Andrew Podner4296a652012-12-17 07:51:15 -0500358 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000359 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600360 public function select_sum($select = '', $alias = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000361 {
362 return $this->_max_min_avg_sum($select, $alias, 'SUM');
363 }
364
365 // --------------------------------------------------------------------
366
367 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200368 * SELECT [MAX|MIN|AVG|SUM]()
Derek Allard2067d1a2008-11-13 22:59:24 +0000369 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200370 * @used-by select_max()
371 * @used-by select_min()
372 * @used-by select_avg()
373 * @used-by select_sum()
Barry Mienydd671972010-10-04 16:33:58 +0200374 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200375 * @param string $select Field name
376 * @param string $alias
377 * @param string $type
Andrew Podner4296a652012-12-17 07:51:15 -0500378 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000379 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600380 protected function _max_min_avg_sum($select = '', $alias = '', $type = 'MAX')
Derek Allard2067d1a2008-11-13 22:59:24 +0000381 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100382 if ( ! is_string($select) OR $select === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000383 {
384 $this->display_error('db_invalid_query');
385 }
Barry Mienydd671972010-10-04 16:33:58 +0200386
Derek Allard2067d1a2008-11-13 22:59:24 +0000387 $type = strtoupper($type);
Barry Mienydd671972010-10-04 16:33:58 +0200388
Derek Allard2067d1a2008-11-13 22:59:24 +0000389 if ( ! in_array($type, array('MAX', 'MIN', 'AVG', 'SUM')))
390 {
391 show_error('Invalid function type: '.$type);
392 }
Barry Mienydd671972010-10-04 16:33:58 +0200393
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100394 if ($alias === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000395 {
396 $alias = $this->_create_alias_from_table(trim($select));
397 }
Barry Mienydd671972010-10-04 16:33:58 +0200398
Andrey Andreev5b55c152013-08-06 14:14:32 +0300399 $sql = $type.'('.$this->protect_identifiers(trim($select)).') AS '.$this->escape_identifiers(trim($alias));
Andrey Andreev7b5eb732012-05-24 20:52:41 +0300400
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000401 $this->qb_select[] = $sql;
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +0100402 $this->qb_no_escape[] = NULL;
Barry Mienydd671972010-10-04 16:33:58 +0200403
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000404 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000405 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000406 $this->qb_cache_select[] = $sql;
407 $this->qb_cache_exists[] = 'select';
Derek Allard2067d1a2008-11-13 22:59:24 +0000408 }
Barry Mienydd671972010-10-04 16:33:58 +0200409
Derek Allard2067d1a2008-11-13 22:59:24 +0000410 return $this;
411 }
412
413 // --------------------------------------------------------------------
414
415 /**
416 * Determines the alias name based on the table
417 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200418 * @param string $item
Derek Allard2067d1a2008-11-13 22:59:24 +0000419 * @return string
420 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600421 protected function _create_alias_from_table($item)
Derek Allard2067d1a2008-11-13 22:59:24 +0000422 {
423 if (strpos($item, '.') !== FALSE)
424 {
Andrey Andreevdb0c0622012-02-29 19:02:46 +0200425 $item = explode('.', $item);
426 return end($item);
Derek Allard2067d1a2008-11-13 22:59:24 +0000427 }
Barry Mienydd671972010-10-04 16:33:58 +0200428
Derek Allard2067d1a2008-11-13 22:59:24 +0000429 return $item;
430 }
431
432 // --------------------------------------------------------------------
433
434 /**
435 * DISTINCT
436 *
437 * Sets a flag which tells the query string compiler to add DISTINCT
438 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200439 * @param bool $val
Andrew Podner4296a652012-12-17 07:51:15 -0500440 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000441 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600442 public function distinct($val = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000443 {
Andrey Andreev7b5eb732012-05-24 20:52:41 +0300444 $this->qb_distinct = is_bool($val) ? $val : TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000445 return $this;
446 }
Barry Mienydd671972010-10-04 16:33:58 +0200447
Derek Allard2067d1a2008-11-13 22:59:24 +0000448 // --------------------------------------------------------------------
449
450 /**
451 * From
452 *
453 * Generates the FROM portion of the query
454 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200455 * @param mixed $from can be a string or array
Andrew Podner4296a652012-12-17 07:51:15 -0500456 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000457 */
Phil Sturgeon9789f322011-07-15 15:14:05 -0600458 public function from($from)
Derek Allard2067d1a2008-11-13 22:59:24 +0000459 {
Andrey Andreev7b5eb732012-05-24 20:52:41 +0300460 foreach ((array) $from as $val)
Derek Allard2067d1a2008-11-13 22:59:24 +0000461 {
462 if (strpos($val, ',') !== FALSE)
463 {
464 foreach (explode(',', $val) as $v)
465 {
466 $v = trim($v);
467 $this->_track_aliases($v);
Barry Mienydd671972010-10-04 16:33:58 +0200468
George Petsagourakis193d4482012-04-28 11:16:18 +0300469 $this->qb_from[] = $v = $this->protect_identifiers($v, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +0000470
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000471 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000472 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000473 $this->qb_cache_from[] = $v;
474 $this->qb_cache_exists[] = 'from';
Barry Mienydd671972010-10-04 16:33:58 +0200475 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000476 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000477 }
478 else
479 {
480 $val = trim($val);
481
Andrey Andreev24276a32012-01-08 02:44:38 +0200482 // Extract any aliases that might exist. We use this information
Jamie Rumbelow0c092992012-03-06 22:05:16 +0000483 // in the protect_identifiers to know whether to add a table prefix
Derek Allard2067d1a2008-11-13 22:59:24 +0000484 $this->_track_aliases($val);
Barry Mienydd671972010-10-04 16:33:58 +0200485
Jamie Rumbelow0c092992012-03-06 22:05:16 +0000486 $this->qb_from[] = $val = $this->protect_identifiers($val, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +0000487
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000488 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000489 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000490 $this->qb_cache_from[] = $val;
491 $this->qb_cache_exists[] = 'from';
Derek Allard2067d1a2008-11-13 22:59:24 +0000492 }
493 }
494 }
495
496 return $this;
497 }
498
499 // --------------------------------------------------------------------
500
501 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200502 * JOIN
Derek Allard2067d1a2008-11-13 22:59:24 +0000503 *
504 * Generates the JOIN portion of the query
505 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000506 * @param string
507 * @param string the join condition
508 * @param string the type of join
Alex Bilbief512b732012-06-16 11:15:19 +0100509 * @param string whether not to try to escape identifiers
Andrew Podner4296a652012-12-17 07:51:15 -0500510 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000511 */
Andrey Andreevfe642da2012-06-16 03:47:33 +0300512 public function join($table, $cond, $type = '', $escape = NULL)
Barry Mienydd671972010-10-04 16:33:58 +0200513 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100514 if ($type !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000515 {
516 $type = strtoupper(trim($type));
517
Andrey Andreev42870232012-06-12 01:30:20 +0300518 if ( ! in_array($type, array('LEFT', 'RIGHT', 'OUTER', 'INNER', 'LEFT OUTER', 'RIGHT OUTER'), TRUE))
Derek Allard2067d1a2008-11-13 22:59:24 +0000519 {
520 $type = '';
521 }
522 else
523 {
524 $type .= ' ';
525 }
526 }
527
Andrey Andreev24276a32012-01-08 02:44:38 +0200528 // Extract any aliases that might exist. We use this information
Jamie Rumbelow0c092992012-03-06 22:05:16 +0000529 // in the protect_identifiers to know whether to add a table prefix
Derek Allard2067d1a2008-11-13 22:59:24 +0000530 $this->_track_aliases($table);
531
Andrey Andreevfe642da2012-06-16 03:47:33 +0300532 is_bool($escape) OR $escape = $this->_protect_identifiers;
533
Andrey Andreev42870232012-06-12 01:30:20 +0300534 // Split multiple conditions
Andrey Andreev49aa45b2012-07-06 16:22:21 +0300535 if ($escape === TRUE && preg_match_all('/\sAND\s|\sOR\s/i', $cond, $m, PREG_OFFSET_CAPTURE))
Andrey Andreev42870232012-06-12 01:30:20 +0300536 {
537 $newcond = '';
538 $m[0][] = array('', strlen($cond));
539
540 for ($i = 0, $c = count($m[0]), $s = 0;
541 $i < $c;
Andrey Andreev49aa45b2012-07-06 16:22:21 +0300542 $s = $m[0][$i][1] + strlen($m[0][$i][0]), $i++)
Andrey Andreev42870232012-06-12 01:30:20 +0300543 {
Andrey Andreev49aa45b2012-07-06 16:22:21 +0300544 $temp = substr($cond, $s, ($m[0][$i][1] - $s));
Andrey Andreev42870232012-06-12 01:30:20 +0300545
Andrey Andreev49aa45b2012-07-06 16:22:21 +0300546 $newcond .= preg_match("/([\[\]\w\.'-]+)(\s*[^\"\[`'\w]+\s*)(.+)/i", $temp, $match)
Andrey Andreev42870232012-06-12 01:30:20 +0300547 ? $this->protect_identifiers($match[1]).$match[2].$this->protect_identifiers($match[3])
548 : $temp;
549
550 $newcond .= $m[0][$i][0];
551 }
552
Andrey Andreev3751f932012-06-17 18:07:48 +0300553 $cond = ' ON '.$newcond;
Andrey Andreev42870232012-06-12 01:30:20 +0300554 }
555 // Split apart the condition and protect the identifiers
Andrey Andreev49aa45b2012-07-06 16:22:21 +0300556 elseif ($escape === TRUE && preg_match("/([\[\]\w\.'-]+)(\s*[^\"\[`'\w]+\s*)(.+)/i", $cond, $match))
Derek Allard2067d1a2008-11-13 22:59:24 +0000557 {
Andrey Andreev3751f932012-06-17 18:07:48 +0300558 $cond = ' ON '.$this->protect_identifiers($match[1]).$match[2].$this->protect_identifiers($match[3]);
559 }
560 elseif ( ! $this->_has_operator($cond))
561 {
562 $cond = ' USING ('.($escape ? $this->escape_identifiers($cond) : $cond).')';
563 }
564 else
565 {
566 $cond = ' ON '.$cond;
Derek Allard2067d1a2008-11-13 22:59:24 +0000567 }
Barry Mienydd671972010-10-04 16:33:58 +0200568
Andrey Andreev42870232012-06-12 01:30:20 +0300569 // Do we want to escape the table name?
570 if ($escape === TRUE)
571 {
572 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
573 }
574
Derek Allard2067d1a2008-11-13 22:59:24 +0000575 // Assemble the JOIN statement
Andrey Andreev3751f932012-06-17 18:07:48 +0300576 $this->qb_join[] = $join = $type.'JOIN '.$table.$cond;
Derek Allard2067d1a2008-11-13 22:59:24 +0000577
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000578 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000579 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000580 $this->qb_cache_join[] = $join;
581 $this->qb_cache_exists[] = 'join';
Derek Allard2067d1a2008-11-13 22:59:24 +0000582 }
583
584 return $this;
585 }
586
587 // --------------------------------------------------------------------
588
589 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200590 * WHERE
Derek Allard2067d1a2008-11-13 22:59:24 +0000591 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200592 * Generates the WHERE portion of the query.
593 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000594 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000595 * @param mixed
596 * @param mixed
Andrey Andreev42870232012-06-12 01:30:20 +0300597 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500598 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000599 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300600 public function where($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000601 {
Andrey Andreevd40459d2012-07-18 16:46:39 +0300602 return $this->_wh('qb_where', $key, $value, 'AND ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000603 }
Barry Mienydd671972010-10-04 16:33:58 +0200604
Derek Allard2067d1a2008-11-13 22:59:24 +0000605 // --------------------------------------------------------------------
606
607 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200608 * OR WHERE
Derek Allard2067d1a2008-11-13 22:59:24 +0000609 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200610 * Generates the WHERE portion of the query.
611 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000612 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000613 * @param mixed
614 * @param mixed
Andrey Andreev42870232012-06-12 01:30:20 +0300615 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -0500616 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000617 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300618 public function or_where($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000619 {
Andrey Andreevd40459d2012-07-18 16:46:39 +0300620 return $this->_wh('qb_where', $key, $value, 'OR ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000621 }
622
623 // --------------------------------------------------------------------
624
625 /**
Andrey Andreevd40459d2012-07-18 16:46:39 +0300626 * WHERE, HAVING
Derek Allard2067d1a2008-11-13 22:59:24 +0000627 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200628 * @used-by where()
629 * @used-by or_where()
630 * @used-by having()
631 * @used-by or_having()
Derek Allard2067d1a2008-11-13 22:59:24 +0000632 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200633 * @param string $qb_key 'qb_where' or 'qb_having'
634 * @param mixed $key
635 * @param mixed $value
636 * @param string $type
637 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500638 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000639 */
Andrey Andreevd40459d2012-07-18 16:46:39 +0300640 protected function _wh($qb_key, $key, $value = NULL, $type = 'AND ', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000641 {
Andrey Andreevd40459d2012-07-18 16:46:39 +0300642 $qb_cache_key = ($qb_key === 'qb_having') ? 'qb_cache_having' : 'qb_cache_where';
643
Derek Allard2067d1a2008-11-13 22:59:24 +0000644 if ( ! is_array($key))
645 {
646 $key = array($key => $value);
647 }
Barry Mienydd671972010-10-04 16:33:58 +0200648
Rougin Royce Gutib191550a2014-08-24 16:19:08 +0800649 // If the escape value was not set will base it on the global setting
Andrey Andreeve10fb792012-06-15 12:07:04 +0300650 is_bool($escape) OR $escape = $this->_protect_identifiers;
Derek Allard2067d1a2008-11-13 22:59:24 +0000651
652 foreach ($key as $k => $v)
653 {
Andrey Andreevd40459d2012-07-18 16:46:39 +0300654 $prefix = (count($this->$qb_key) === 0 && count($this->$qb_cache_key) === 0)
Andrey Andreev58803fb2012-06-24 00:45:37 +0300655 ? $this->_group_get_type('')
656 : $this->_group_get_type($type);
Derek Allard2067d1a2008-11-13 22:59:24 +0000657
vlakoff1228fe22013-01-14 01:30:09 +0100658 if ($v !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000659 {
Andrey Andreevf7631f12015-07-27 21:54:41 +0300660 if ($escape === TRUE)
661 {
662 $v = ' '.$this->escape($v);
663 }
WanWizard7219c072011-12-28 14:09:05 +0100664
Derek Allard2067d1a2008-11-13 22:59:24 +0000665 if ( ! $this->_has_operator($k))
666 {
Greg Akere156c6e2011-04-20 16:03:04 -0500667 $k .= ' = ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000668 }
669 }
Andrey Andreev3a5efc22012-11-20 21:18:08 +0200670 elseif ( ! $this->_has_operator($k))
671 {
672 // value appears not to have been set, assign the test to IS NULL
673 $k .= ' IS NULL';
674 }
Andrey Andreev5078eb52014-12-02 01:11:54 +0200675 elseif (preg_match('/\s*(!?=|<>|IS(?:\s+NOT)?)\s*$/i', $k, $match, PREG_OFFSET_CAPTURE))
Andrey Andreev5bf4dcd2014-09-29 20:07:15 +0300676 {
677 $k = substr($k, 0, $match[0][1]).($match[1][0] === '=' ? ' IS NULL' : ' IS NOT NULL');
678 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000679
Andrey Andreevd40459d2012-07-18 16:46:39 +0300680 $this->{$qb_key}[] = array('condition' => $prefix.$k.$v, 'escape' => $escape);
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000681 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000682 {
Andrey Andreevd40459d2012-07-18 16:46:39 +0300683 $this->{$qb_cache_key}[] = array('condition' => $prefix.$k.$v, 'escape' => $escape);
684 $this->qb_cache_exists[] = substr($qb_key, 3);
Derek Allard2067d1a2008-11-13 22:59:24 +0000685 }
Barry Mienydd671972010-10-04 16:33:58 +0200686
Derek Allard2067d1a2008-11-13 22:59:24 +0000687 }
Barry Mienydd671972010-10-04 16:33:58 +0200688
Derek Allard2067d1a2008-11-13 22:59:24 +0000689 return $this;
690 }
691
692 // --------------------------------------------------------------------
693
694 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200695 * WHERE IN
Derek Allard2067d1a2008-11-13 22:59:24 +0000696 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200697 * Generates a WHERE field IN('item', 'item') SQL query,
698 * joined with 'AND' if appropriate.
Derek Allard2067d1a2008-11-13 22:59:24 +0000699 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200700 * @param string $key The field to search
701 * @param array $values The values searched on
702 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500703 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000704 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300705 public function where_in($key = NULL, $values = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000706 {
Andrey Andreev498c1e02012-06-16 03:34:10 +0300707 return $this->_where_in($key, $values, FALSE, 'AND ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000708 }
Barry Mienydd671972010-10-04 16:33:58 +0200709
Derek Allard2067d1a2008-11-13 22:59:24 +0000710 // --------------------------------------------------------------------
711
712 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200713 * OR WHERE IN
Derek Allard2067d1a2008-11-13 22:59:24 +0000714 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200715 * Generates a WHERE field IN('item', 'item') SQL query,
716 * joined with 'OR' if appropriate.
Derek Allard2067d1a2008-11-13 22:59:24 +0000717 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200718 * @param string $key The field to search
719 * @param array $values The values searched on
720 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500721 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000722 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300723 public function or_where_in($key = NULL, $values = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000724 {
Andrey Andreev498c1e02012-06-16 03:34:10 +0300725 return $this->_where_in($key, $values, FALSE, 'OR ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000726 }
727
728 // --------------------------------------------------------------------
729
730 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200731 * WHERE NOT IN
Derek Allard2067d1a2008-11-13 22:59:24 +0000732 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200733 * Generates a WHERE field NOT IN('item', 'item') SQL query,
734 * joined with 'AND' if appropriate.
Derek Allard2067d1a2008-11-13 22:59:24 +0000735 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200736 * @param string $key The field to search
737 * @param array $values The values searched on
738 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500739 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000740 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300741 public function where_not_in($key = NULL, $values = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000742 {
Andrey Andreev498c1e02012-06-16 03:34:10 +0300743 return $this->_where_in($key, $values, TRUE, 'AND ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000744 }
Barry Mienydd671972010-10-04 16:33:58 +0200745
Derek Allard2067d1a2008-11-13 22:59:24 +0000746 // --------------------------------------------------------------------
747
748 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200749 * OR WHERE NOT IN
Derek Allard2067d1a2008-11-13 22:59:24 +0000750 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200751 * Generates a WHERE field NOT IN('item', 'item') SQL query,
752 * joined with 'OR' if appropriate.
Derek Allard2067d1a2008-11-13 22:59:24 +0000753 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200754 * @param string $key The field to search
755 * @param array $values The values searched on
756 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500757 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000758 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300759 public function or_where_not_in($key = NULL, $values = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000760 {
Andrey Andreev498c1e02012-06-16 03:34:10 +0300761 return $this->_where_in($key, $values, TRUE, 'OR ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000762 }
763
764 // --------------------------------------------------------------------
765
766 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200767 * Internal WHERE IN
Derek Allard2067d1a2008-11-13 22:59:24 +0000768 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200769 * @used-by where_in()
770 * @used-by or_where_in()
771 * @used-by where_not_in()
772 * @used-by or_where_not_in()
Derek Allard2067d1a2008-11-13 22:59:24 +0000773 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200774 * @param string $key The field to search
775 * @param array $values The values searched on
776 * @param bool $not If the statement would be IN or NOT IN
777 * @param string $type
778 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500779 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000780 */
Andrey Andreev498c1e02012-06-16 03:34:10 +0300781 protected function _where_in($key = NULL, $values = NULL, $not = FALSE, $type = 'AND ', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000782 {
783 if ($key === NULL OR $values === NULL)
784 {
Rafael Queiroz6600b692012-06-08 14:34:20 -0300785 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000786 }
Barry Mienydd671972010-10-04 16:33:58 +0200787
Derek Allard2067d1a2008-11-13 22:59:24 +0000788 if ( ! is_array($values))
789 {
790 $values = array($values);
791 }
Barry Mienydd671972010-10-04 16:33:58 +0200792
Andrey Andreev498c1e02012-06-16 03:34:10 +0300793 is_bool($escape) OR $escape = $this->_protect_identifiers;
794
Derek Allard2067d1a2008-11-13 22:59:24 +0000795 $not = ($not) ? ' NOT' : '';
796
Andrey Andreevd738b6b2015-07-29 16:24:57 +0300797 if ($escape === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000798 {
Andrey Andreevd738b6b2015-07-29 16:24:57 +0300799 $where_in = array();
800 foreach ($values as $value)
801 {
802 $where_in[] = $this->escape($value);
803 }
804 }
805 else
806 {
807 $where_in = array_values($values);
Derek Allard2067d1a2008-11-13 22:59:24 +0000808 }
809
WanWizardbc69f362012-06-22 00:10:11 +0200810 $prefix = (count($this->qb_where) === 0) ? $this->_group_get_type('') : $this->_group_get_type($type);
Andrey Andreev6e704752012-07-18 00:46:33 +0300811 $where_in = array(
Andrey Andreev94611df2012-07-19 12:29:54 +0300812 'condition' => $prefix.$key.$not.' IN('.implode(', ', $where_in).')',
Andrey Andreev6e704752012-07-18 00:46:33 +0300813 'escape' => $escape
814 );
Barry Mienydd671972010-10-04 16:33:58 +0200815
Andrey Andreev6e704752012-07-18 00:46:33 +0300816 $this->qb_where[] = $where_in;
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000817 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000818 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000819 $this->qb_cache_where[] = $where_in;
820 $this->qb_cache_exists[] = 'where';
Derek Allard2067d1a2008-11-13 22:59:24 +0000821 }
822
Derek Allard2067d1a2008-11-13 22:59:24 +0000823 return $this;
824 }
Barry Mienydd671972010-10-04 16:33:58 +0200825
Derek Allard2067d1a2008-11-13 22:59:24 +0000826 // --------------------------------------------------------------------
827
828 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200829 * LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000830 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200831 * Generates a %LIKE% portion of the query.
832 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000833 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200834 * @param mixed $field
835 * @param string $match
836 * @param string $side
837 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500838 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000839 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300840 public function like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000841 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300842 return $this->_like($field, $match, 'AND ', $side, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000843 }
844
845 // --------------------------------------------------------------------
846
847 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200848 * NOT LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000849 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200850 * Generates a NOT LIKE portion of the query.
851 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000852 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200853 * @param mixed $field
854 * @param string $match
855 * @param string $side
856 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500857 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000858 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300859 public function not_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000860 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300861 return $this->_like($field, $match, 'AND ', $side, 'NOT', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000862 }
Barry Mienydd671972010-10-04 16:33:58 +0200863
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 // --------------------------------------------------------------------
865
866 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200867 * OR LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000868 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200869 * Generates a %LIKE% portion of the query.
870 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000871 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200872 * @param mixed $field
873 * @param string $match
874 * @param string $side
875 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500876 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000877 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300878 public function or_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000879 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300880 return $this->_like($field, $match, 'OR ', $side, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000881 }
882
883 // --------------------------------------------------------------------
884
885 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200886 * OR NOT LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000887 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200888 * Generates a NOT LIKE portion of the query.
889 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000890 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200891 * @param mixed $field
892 * @param string $match
893 * @param string $side
894 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500895 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000896 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300897 public function or_not_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000898 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300899 return $this->_like($field, $match, 'OR ', $side, 'NOT', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000900 }
Barry Mienydd671972010-10-04 16:33:58 +0200901
Derek Allard2067d1a2008-11-13 22:59:24 +0000902 // --------------------------------------------------------------------
903
904 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200905 * Internal LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000906 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200907 * @used-by like()
908 * @used-by or_like()
909 * @used-by not_like()
910 * @used-by or_not_like()
Derek Allard2067d1a2008-11-13 22:59:24 +0000911 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200912 * @param mixed $field
913 * @param string $match
914 * @param string $type
915 * @param string $side
916 * @param string $not
917 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500918 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000919 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300920 protected function _like($field, $match = '', $type = 'AND ', $side = 'both', $not = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000921 {
922 if ( ! is_array($field))
923 {
924 $field = array($field => $match);
925 }
Barry Mienydd671972010-10-04 16:33:58 +0200926
Andrey Andreevb0478652012-07-18 15:34:46 +0300927 is_bool($escape) OR $escape = $this->_protect_identifiers;
Andrey Andreev19311362015-04-07 00:02:14 +0300928 // lowercase $side in case somebody writes e.g. 'BEFORE' instead of 'before' (doh)
929 $side = strtolower($side);
Andrey Andreevb0478652012-07-18 15:34:46 +0300930
Derek Allard2067d1a2008-11-13 22:59:24 +0000931 foreach ($field as $k => $v)
932 {
Andrey Andreev41738232012-11-30 00:13:17 +0200933 $prefix = (count($this->qb_where) === 0 && count($this->qb_cache_where) === 0)
934 ? $this->_group_get_type('') : $this->_group_get_type($type);
935
Andrey Andreevd738b6b2015-07-29 16:24:57 +0300936 if ($escape === TRUE)
937 {
938 $v = $this->escape_like_str($v);
939 }
Andrey Andreevfc11dcc2012-06-04 16:39:19 +0300940
Andrey Andreev24276a32012-01-08 02:44:38 +0200941 if ($side === 'none')
Kyle Farris81ef70f2011-08-31 11:59:12 -0400942 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300943 $like_statement = "{$prefix} {$k} {$not} LIKE '{$v}'";
Kyle Farris81ef70f2011-08-31 11:59:12 -0400944 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200945 elseif ($side === 'before')
Derek Allard2067d1a2008-11-13 22:59:24 +0000946 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300947 $like_statement = "{$prefix} {$k} {$not} LIKE '%{$v}'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000948 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200949 elseif ($side === 'after')
Derek Allard2067d1a2008-11-13 22:59:24 +0000950 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300951 $like_statement = "{$prefix} {$k} {$not} LIKE '{$v}%'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000952 }
953 else
954 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300955 $like_statement = "{$prefix} {$k} {$not} LIKE '%{$v}%'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000956 }
Derek Jonesd10e8962010-03-02 17:10:36 -0600957
Derek Jonese4ed5832009-02-20 21:44:59 +0000958 // some platforms require an escape sequence definition for LIKE wildcards
Andrey Andreevd738b6b2015-07-29 16:24:57 +0300959 if ($escape === TRUE && $this->_like_escape_str !== '')
Derek Jonese4ed5832009-02-20 21:44:59 +0000960 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300961 $like_statement .= sprintf($this->_like_escape_str, $this->_like_escape_chr);
Derek Jonese4ed5832009-02-20 21:44:59 +0000962 }
Derek Jonesd10e8962010-03-02 17:10:36 -0600963
Andrey Andreevb0478652012-07-18 15:34:46 +0300964 $this->qb_where[] = array('condition' => $like_statement, 'escape' => $escape);
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000965 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000966 {
Andrey Andreev55bbd722013-01-28 19:02:13 +0200967 $this->qb_cache_where[] = array('condition' => $like_statement, 'escape' => $escape);
Andrey Andreevededc4a2012-07-18 01:16:15 +0300968 $this->qb_cache_exists[] = 'where';
Derek Allard2067d1a2008-11-13 22:59:24 +0000969 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000970 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200971
Derek Allard2067d1a2008-11-13 22:59:24 +0000972 return $this;
973 }
Barry Mienydd671972010-10-04 16:33:58 +0200974
Derek Allard2067d1a2008-11-13 22:59:24 +0000975 // --------------------------------------------------------------------
976
977 /**
WanWizard7219c072011-12-28 14:09:05 +0100978 * Starts a query group.
979 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200980 * @param string $not (Internal use only)
981 * @param string $type (Internal use only)
Andrew Podner4296a652012-12-17 07:51:15 -0500982 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +0100983 */
984 public function group_start($not = '', $type = 'AND ')
985 {
986 $type = $this->_group_get_type($type);
WanWizard7219c072011-12-28 14:09:05 +0100987
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000988 $this->qb_where_group_started = TRUE;
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +0100989 $prefix = (count($this->qb_where) === 0 && count($this->qb_cache_where) === 0) ? '' : $type;
Andrey Andreev6e704752012-07-18 00:46:33 +0300990 $where = array(
991 'condition' => $prefix.$not.str_repeat(' ', ++$this->qb_where_group_count).' (',
992 'escape' => FALSE
993 );
WanWizard7219c072011-12-28 14:09:05 +0100994
Andrey Andreev6e704752012-07-18 00:46:33 +0300995 $this->qb_where[] = $where;
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000996 if ($this->qb_caching)
WanWizard7219c072011-12-28 14:09:05 +0100997 {
Andrey Andreev6e704752012-07-18 00:46:33 +0300998 $this->qb_cache_where[] = $where;
WanWizard7219c072011-12-28 14:09:05 +0100999 }
1000
1001 return $this;
1002 }
1003
1004 // --------------------------------------------------------------------
1005
1006 /**
1007 * Starts a query group, but ORs the group
1008 *
Andrew Podner4296a652012-12-17 07:51:15 -05001009 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +01001010 */
1011 public function or_group_start()
1012 {
1013 return $this->group_start('', 'OR ');
1014 }
1015
1016 // --------------------------------------------------------------------
1017
1018 /**
1019 * Starts a query group, but NOTs the group
1020 *
Andrew Podner4296a652012-12-17 07:51:15 -05001021 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +01001022 */
1023 public function not_group_start()
1024 {
1025 return $this->group_start('NOT ', 'AND ');
1026 }
1027
1028 // --------------------------------------------------------------------
1029
1030 /**
1031 * Starts a query group, but OR NOTs the group
1032 *
Andrew Podner4296a652012-12-17 07:51:15 -05001033 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +01001034 */
1035 public function or_not_group_start()
1036 {
1037 return $this->group_start('NOT ', 'OR ');
1038 }
1039
1040 // --------------------------------------------------------------------
1041
1042 /**
1043 * Ends a query group
1044 *
Andrew Podner4296a652012-12-17 07:51:15 -05001045 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +01001046 */
1047 public function group_end()
1048 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001049 $this->qb_where_group_started = FALSE;
Andrey Andreev6e704752012-07-18 00:46:33 +03001050 $where = array(
1051 'condition' => str_repeat(' ', $this->qb_where_group_count--).')',
1052 'escape' => FALSE
1053 );
WanWizard7219c072011-12-28 14:09:05 +01001054
Andrey Andreev6e704752012-07-18 00:46:33 +03001055 $this->qb_where[] = $where;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001056 if ($this->qb_caching)
WanWizard7219c072011-12-28 14:09:05 +01001057 {
Andrey Andreev6e704752012-07-18 00:46:33 +03001058 $this->qb_cache_where[] = $where;
WanWizard7219c072011-12-28 14:09:05 +01001059 }
1060
WanWizard7219c072011-12-28 14:09:05 +01001061 return $this;
1062 }
1063
1064 // --------------------------------------------------------------------
1065
1066 /**
1067 * Group_get_type
1068 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001069 * @used-by group_start()
1070 * @used-by _like()
1071 * @used-by _wh()
1072 * @used-by _where_in()
WanWizard7219c072011-12-28 14:09:05 +01001073 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001074 * @param string $type
WanWizard7219c072011-12-28 14:09:05 +01001075 * @return string
1076 */
1077 protected function _group_get_type($type)
1078 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001079 if ($this->qb_where_group_started)
WanWizard7219c072011-12-28 14:09:05 +01001080 {
1081 $type = '';
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001082 $this->qb_where_group_started = FALSE;
WanWizard7219c072011-12-28 14:09:05 +01001083 }
1084
1085 return $type;
1086 }
1087
1088 // --------------------------------------------------------------------
1089
1090 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001091 * GROUP BY
1092 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001093 * @param string $by
1094 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -05001095 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001096 */
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001097 public function group_by($by, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001098 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001099 is_bool($escape) OR $escape = $this->_protect_identifiers;
1100
Derek Allard2067d1a2008-11-13 22:59:24 +00001101 if (is_string($by))
1102 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001103 $by = ($escape === TRUE)
1104 ? explode(',', $by)
1105 : array($by);
Derek Allard2067d1a2008-11-13 22:59:24 +00001106 }
Barry Mienydd671972010-10-04 16:33:58 +02001107
Derek Allard2067d1a2008-11-13 22:59:24 +00001108 foreach ($by as $val)
1109 {
1110 $val = trim($val);
Barry Mienydd671972010-10-04 16:33:58 +02001111
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001112 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001113 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001114 $val = array('field' => $val, 'escape' => $escape);
Barry Mienydd671972010-10-04 16:33:58 +02001115
Andrey Andreev96feb582012-07-19 13:12:34 +03001116 $this->qb_groupby[] = $val;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001117 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001118 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001119 $this->qb_cache_groupby[] = $val;
1120 $this->qb_cache_exists[] = 'groupby';
Derek Allard2067d1a2008-11-13 22:59:24 +00001121 }
1122 }
1123 }
Andrey Andreev24276a32012-01-08 02:44:38 +02001124
Derek Allard2067d1a2008-11-13 22:59:24 +00001125 return $this;
1126 }
1127
1128 // --------------------------------------------------------------------
1129
1130 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001131 * HAVING
Derek Allard2067d1a2008-11-13 22:59:24 +00001132 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001133 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +00001134 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001135 * @param string $key
1136 * @param string $value
1137 * @param bool $escape
Derek Allard2067d1a2008-11-13 22:59:24 +00001138 * @return object
1139 */
Andrey Andreev0bcf5902012-10-12 13:03:29 +03001140 public function having($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001141 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03001142 return $this->_wh('qb_having', $key, $value, 'AND ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001143 }
Barry Mienydd671972010-10-04 16:33:58 +02001144
Derek Allard2067d1a2008-11-13 22:59:24 +00001145 // --------------------------------------------------------------------
1146
1147 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001148 * OR HAVING
Derek Allard2067d1a2008-11-13 22:59:24 +00001149 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001150 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +00001151 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001152 * @param string $key
1153 * @param string $value
1154 * @param bool $escape
Derek Allard2067d1a2008-11-13 22:59:24 +00001155 * @return object
1156 */
Andrey Andreev0bcf5902012-10-12 13:03:29 +03001157 public function or_having($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001158 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03001159 return $this->_wh('qb_having', $key, $value, 'OR ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001160 }
Barry Mienydd671972010-10-04 16:33:58 +02001161
Derek Allard2067d1a2008-11-13 22:59:24 +00001162 // --------------------------------------------------------------------
1163
1164 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001165 * ORDER BY
Derek Allard2067d1a2008-11-13 22:59:24 +00001166 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001167 * @param string $orderby
vlakoff9f8e2992013-09-08 14:05:04 +02001168 * @param string $direction ASC, DESC or RANDOM
Andrey Andreevae85eb42012-11-02 01:42:31 +02001169 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -05001170 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001171 */
Andrey Andreevd24160c2012-06-16 03:21:20 +03001172 public function order_by($orderby, $direction = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001173 {
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001174 $direction = strtoupper(trim($direction));
Andrey Andreev2d486232012-07-19 14:46:51 +03001175
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001176 if ($direction === 'RANDOM')
Derek Allard2067d1a2008-11-13 22:59:24 +00001177 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001178 $direction = '';
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001179
1180 // Do we have a seed value?
1181 $orderby = ctype_digit((string) $orderby)
vlakoffe6c4d5b2013-09-08 13:54:57 +02001182 ? sprintf($this->_random_keyword[1], $orderby)
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001183 : $this->_random_keyword[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00001184 }
Andrey Andreev2d486232012-07-19 14:46:51 +03001185 elseif (empty($orderby))
Derek Allard2067d1a2008-11-13 22:59:24 +00001186 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001187 return $this;
1188 }
1189 elseif ($direction !== '')
1190 {
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001191 $direction = in_array($direction, array('ASC', 'DESC'), TRUE) ? ' '.$direction : '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001192 }
Barry Mienydd671972010-10-04 16:33:58 +02001193
Andrey Andreevd24160c2012-06-16 03:21:20 +03001194 is_bool($escape) OR $escape = $this->_protect_identifiers;
Barry Mienydd671972010-10-04 16:33:58 +02001195
Andrey Andreev2d486232012-07-19 14:46:51 +03001196 if ($escape === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001197 {
Andrey Andreev93dd2f22012-10-24 10:09:18 +03001198 $qb_orderby[] = array('field' => $orderby, 'direction' => $direction, 'escape' => FALSE);
Andrey Andreev2d486232012-07-19 14:46:51 +03001199 }
1200 else
1201 {
1202 $qb_orderby = array();
1203 foreach (explode(',', $orderby) as $field)
Derek Allard2067d1a2008-11-13 22:59:24 +00001204 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001205 $qb_orderby[] = ($direction === '' && preg_match('/\s+(ASC|DESC)$/i', rtrim($field), $match, PREG_OFFSET_CAPTURE))
1206 ? array('field' => ltrim(substr($field, 0, $match[0][1])), 'direction' => ' '.$match[1][0], 'escape' => TRUE)
1207 : array('field' => trim($field), 'direction' => $direction, 'escape' => TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001208 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001209 }
Barry Mienydd671972010-10-04 16:33:58 +02001210
Andrey Andreev2d486232012-07-19 14:46:51 +03001211 $this->qb_orderby = array_merge($this->qb_orderby, $qb_orderby);
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001212 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001213 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001214 $this->qb_cache_orderby = array_merge($this->qb_cache_orderby, $qb_orderby);
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001215 $this->qb_cache_exists[] = 'orderby';
Derek Allard2067d1a2008-11-13 22:59:24 +00001216 }
1217
1218 return $this;
1219 }
Barry Mienydd671972010-10-04 16:33:58 +02001220
Derek Allard2067d1a2008-11-13 22:59:24 +00001221 // --------------------------------------------------------------------
1222
1223 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001224 * LIMIT
Derek Allard2067d1a2008-11-13 22:59:24 +00001225 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001226 * @param int $value LIMIT value
1227 * @param int $offset OFFSET value
Andrew Podner4296a652012-12-17 07:51:15 -05001228 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001229 */
Andrey Andreev4a587f52014-12-11 16:27:15 +02001230 public function limit($value, $offset = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001231 {
vlakoff912f1bc2013-01-15 03:34:12 +01001232 is_null($value) OR $this->qb_limit = (int) $value;
Andrey Andreev777153d2012-06-18 13:30:45 +03001233 empty($offset) OR $this->qb_offset = (int) $offset;
Barry Mienydd671972010-10-04 16:33:58 +02001234
Derek Allard2067d1a2008-11-13 22:59:24 +00001235 return $this;
1236 }
Barry Mienydd671972010-10-04 16:33:58 +02001237
Derek Allard2067d1a2008-11-13 22:59:24 +00001238 // --------------------------------------------------------------------
1239
1240 /**
1241 * Sets the OFFSET value
1242 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001243 * @param int $offset OFFSET value
Andrew Podner4296a652012-12-17 07:51:15 -05001244 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001245 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001246 public function offset($offset)
Derek Allard2067d1a2008-11-13 22:59:24 +00001247 {
Andrey Andreev777153d2012-06-18 13:30:45 +03001248 empty($offset) OR $this->qb_offset = (int) $offset;
Derek Allard2067d1a2008-11-13 22:59:24 +00001249 return $this;
1250 }
Barry Mienydd671972010-10-04 16:33:58 +02001251
Derek Allard2067d1a2008-11-13 22:59:24 +00001252 // --------------------------------------------------------------------
1253
1254 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001255 * LIMIT string
Andrey Andreev2c35b642012-06-24 03:05:26 +03001256 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001257 * Generates a platform-specific LIMIT clause.
Andrey Andreev2c35b642012-06-24 03:05:26 +03001258 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001259 * @param string $sql SQL Query
Andrey Andreev2c35b642012-06-24 03:05:26 +03001260 * @return string
1261 */
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001262 protected function _limit($sql)
Andrey Andreev2c35b642012-06-24 03:05:26 +03001263 {
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001264 return $sql.' LIMIT '.($this->qb_offset ? $this->qb_offset.', ' : '').$this->qb_limit;
Andrey Andreev2c35b642012-06-24 03:05:26 +03001265 }
1266
1267 // --------------------------------------------------------------------
1268
1269 /**
Andrey Andreevfe642da2012-06-16 03:47:33 +03001270 * The "set" function.
1271 *
1272 * Allows key/value pairs to be set for inserting or updating
Derek Allard2067d1a2008-11-13 22:59:24 +00001273 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001274 * @param mixed
1275 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001276 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001277 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001278 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001279 public function set($key, $value = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001280 {
1281 $key = $this->_object_to_array($key);
Barry Mienydd671972010-10-04 16:33:58 +02001282
Derek Allard2067d1a2008-11-13 22:59:24 +00001283 if ( ! is_array($key))
1284 {
1285 $key = array($key => $value);
Barry Mienydd671972010-10-04 16:33:58 +02001286 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001287
Andrey Andreevfe642da2012-06-16 03:47:33 +03001288 is_bool($escape) OR $escape = $this->_protect_identifiers;
1289
Derek Allard2067d1a2008-11-13 22:59:24 +00001290 foreach ($key as $k => $v)
1291 {
Andrey Andreev2dfbe992015-07-27 21:54:18 +03001292 $this->qb_set[$this->protect_identifiers($k, FALSE, $escape)] = ($escape)
1293 ? $this->escape($v) : $v;
Derek Allard2067d1a2008-11-13 22:59:24 +00001294 }
Barry Mienydd671972010-10-04 16:33:58 +02001295
Derek Allard2067d1a2008-11-13 22:59:24 +00001296 return $this;
1297 }
WanWizard7219c072011-12-28 14:09:05 +01001298
Kyle Farris0c147b32011-08-26 02:29:31 -04001299 // --------------------------------------------------------------------
1300
1301 /**
1302 * Get SELECT query string
1303 *
1304 * Compiles a SELECT query string and returns the sql.
1305 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001306 * @param string the table name to select from (optional)
Calvin Tam55bc5052015-07-24 02:27:24 -07001307 * @param bool TRUE: resets QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001308 * @return string
1309 */
WanWizard7219c072011-12-28 14:09:05 +01001310 public function get_compiled_select($table = '', $reset = TRUE)
Kyle Farris0c147b32011-08-26 02:29:31 -04001311 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001312 if ($table !== '')
kylefarris0a3176b2011-08-26 02:37:52 -04001313 {
Kyle Farris0c147b32011-08-26 02:29:31 -04001314 $this->_track_aliases($table);
1315 $this->from($table);
1316 }
WanWizard7219c072011-12-28 14:09:05 +01001317
Andrey Andreev650b4c02012-06-11 12:07:15 +03001318 $select = $this->_compile_select();
WanWizard7219c072011-12-28 14:09:05 +01001319
Kyle Farris0c147b32011-08-26 02:29:31 -04001320 if ($reset === TRUE)
1321 {
1322 $this->_reset_select();
1323 }
WanWizard7219c072011-12-28 14:09:05 +01001324
Kyle Farris0c147b32011-08-26 02:29:31 -04001325 return $select;
1326 }
WanWizard7219c072011-12-28 14:09:05 +01001327
Derek Allard2067d1a2008-11-13 22:59:24 +00001328 // --------------------------------------------------------------------
1329
1330 /**
1331 * Get
1332 *
1333 * Compiles the select statement based on the other functions called
1334 * and runs the query
1335 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001336 * @param string the table
1337 * @param string the limit clause
1338 * @param string the offset clause
1339 * @return object
1340 */
Andrey Andreev650b4c02012-06-11 12:07:15 +03001341 public function get($table = '', $limit = NULL, $offset = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001342 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001343 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001344 {
1345 $this->_track_aliases($table);
1346 $this->from($table);
1347 }
Barry Mienydd671972010-10-04 16:33:58 +02001348
Andrey Andreev650b4c02012-06-11 12:07:15 +03001349 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00001350 {
1351 $this->limit($limit, $offset);
1352 }
Barry Mienydd671972010-10-04 16:33:58 +02001353
Andrey Andreev24276a32012-01-08 02:44:38 +02001354 $result = $this->query($this->_compile_select());
Derek Allard2067d1a2008-11-13 22:59:24 +00001355 $this->_reset_select();
1356 return $result;
1357 }
1358
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001359 // --------------------------------------------------------------------
1360
Derek Allard2067d1a2008-11-13 22:59:24 +00001361 /**
1362 * "Count All Results" query
1363 *
Barry Mienydd671972010-10-04 16:33:58 +02001364 * Generates a platform-specific query string that counts all records
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001365 * returned by an Query Builder query.
Derek Allard2067d1a2008-11-13 22:59:24 +00001366 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001367 * @param string
yaoshanliang2f164052015-03-16 16:48:15 +08001368 * @param bool the reset clause
vlakoffc6ac7482013-11-17 00:50:06 +01001369 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +00001370 */
yaoshanliang19c28472015-03-15 10:42:18 +08001371 public function count_all_results($table = '', $reset = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001372 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001373 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001374 {
1375 $this->_track_aliases($table);
1376 $this->from($table);
1377 }
Barry Mienydd671972010-10-04 16:33:58 +02001378
Andrey Andreevb05f5062012-10-26 12:01:02 +03001379 $result = ($this->qb_distinct === TRUE)
1380 ? $this->query($this->_count_string.$this->protect_identifiers('numrows')."\nFROM (\n".$this->_compile_select()."\n) CI_count_all_results")
1381 : $this->query($this->_compile_select($this->_count_string.$this->protect_identifiers('numrows')));
yaoshanliang9971e7b2015-03-14 13:09:16 +08001382
yaoshanliang2f164052015-03-16 16:48:15 +08001383 if ($reset === TRUE)
yaoshanliang19c28472015-03-15 10:42:18 +08001384 {
yaoshanliang2f164052015-03-16 16:48:15 +08001385 $this->_reset_select();
yaoshanliang19c28472015-03-15 10:42:18 +08001386 }
Barry Mienydd671972010-10-04 16:33:58 +02001387
Purwandi1d160e72012-01-09 16:33:28 +07001388 if ($result->num_rows() === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001389 {
Phil Sturgeonaf6f3442011-03-22 19:12:23 +00001390 return 0;
Derek Allard2067d1a2008-11-13 22:59:24 +00001391 }
1392
Purwandi1d160e72012-01-09 16:33:28 +07001393 $row = $result->row();
Phil Sturgeonaf6f3442011-03-22 19:12:23 +00001394 return (int) $row->numrows;
Derek Allard2067d1a2008-11-13 22:59:24 +00001395 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001396
Derek Allard2067d1a2008-11-13 22:59:24 +00001397 // --------------------------------------------------------------------
1398
1399 /**
1400 * Get_Where
1401 *
1402 * Allows the where clause, limit and offset to be added directly
1403 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001404 * @param string $table
1405 * @param string $where
1406 * @param int $limit
1407 * @param int $offset
Derek Allard2067d1a2008-11-13 22:59:24 +00001408 * @return object
1409 */
Andrey Andreeveb22d542012-06-26 23:16:35 +03001410 public function get_where($table = '', $where = NULL, $limit = NULL, $offset = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001411 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001412 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001413 {
1414 $this->from($table);
1415 }
1416
vlakoff1228fe22013-01-14 01:30:09 +01001417 if ($where !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001418 {
1419 $this->where($where);
1420 }
Barry Mienydd671972010-10-04 16:33:58 +02001421
Andrey Andreev650b4c02012-06-11 12:07:15 +03001422 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00001423 {
1424 $this->limit($limit, $offset);
1425 }
Barry Mienydd671972010-10-04 16:33:58 +02001426
Andrey Andreev24276a32012-01-08 02:44:38 +02001427 $result = $this->query($this->_compile_select());
Derek Allard2067d1a2008-11-13 22:59:24 +00001428 $this->_reset_select();
1429 return $result;
1430 }
1431
1432 // --------------------------------------------------------------------
1433
1434 /**
Derek Jonesd10e8962010-03-02 17:10:36 -06001435 * Insert_Batch
1436 *
1437 * Compiles batch insert strings and runs the queries
1438 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001439 * @param string $table Table to insert into
1440 * @param array $set An associative array of insert values
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001441 * @param bool $escape Whether to escape values and identifiers
Andrey Andreevae85eb42012-11-02 01:42:31 +02001442 * @return int Number of rows inserted or FALSE on failure
Derek Jonesd10e8962010-03-02 17:10:36 -06001443 */
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001444 public function insert_batch($table = '', $set = NULL, $escape = NULL)
Barry Mienydd671972010-10-04 16:33:58 +02001445 {
vlakoff1228fe22013-01-14 01:30:09 +01001446 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001447 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001448 $this->set_insert_batch($set, '', $escape);
Derek Jonesd10e8962010-03-02 17:10:36 -06001449 }
Barry Mienydd671972010-10-04 16:33:58 +02001450
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001451 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001452 {
Andrey Andreev9f808b02012-10-24 17:38:48 +03001453 // No valid data array. Folds in cases where keys and values did not match up
1454 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001455 }
1456
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001457 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001458 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001459 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001460 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001461 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001462 }
Barry Mienydd671972010-10-04 16:33:58 +02001463
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001464 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001465 }
1466
1467 // Batch this baby
Andrey Andreev9f808b02012-10-24 17:38:48 +03001468 $affected_rows = 0;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001469 for ($i = 0, $total = count($this->qb_set); $i < $total; $i += 100)
Derek Jonesd10e8962010-03-02 17:10:36 -06001470 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001471 $this->query($this->_insert_batch($this->protect_identifiers($table, TRUE, $escape, FALSE), $this->qb_keys, array_slice($this->qb_set, $i, 100)));
Andrey Andreev9f808b02012-10-24 17:38:48 +03001472 $affected_rows += $this->affected_rows();
Derek Jonesd10e8962010-03-02 17:10:36 -06001473 }
Barry Mienydd671972010-10-04 16:33:58 +02001474
Derek Jonesd10e8962010-03-02 17:10:36 -06001475 $this->_reset_write();
Andrey Andreev9f808b02012-10-24 17:38:48 +03001476 return $affected_rows;
Derek Jonesd10e8962010-03-02 17:10:36 -06001477 }
1478
1479 // --------------------------------------------------------------------
1480
1481 /**
Andrey Andreev083e3c82012-11-06 12:48:32 +02001482 * Insert batch statement
Andrey Andreev97f36972012-04-05 12:44:36 +03001483 *
1484 * Generates a platform-specific insert string from the supplied data.
1485 *
Andrey Andreev083e3c82012-11-06 12:48:32 +02001486 * @param string $table Table name
1487 * @param array $keys INSERT keys
1488 * @param array $values INSERT values
Andrey Andreeva3bca8f2012-04-05 15:17:25 +03001489 * @return string
Andrey Andreev97f36972012-04-05 12:44:36 +03001490 */
1491 protected function _insert_batch($table, $keys, $values)
1492 {
Andrey Andreev65d537c2012-04-05 14:11:41 +03001493 return 'INSERT INTO '.$table.' ('.implode(', ', $keys).') VALUES '.implode(', ', $values);
Andrey Andreev97f36972012-04-05 12:44:36 +03001494 }
1495
1496 // --------------------------------------------------------------------
1497
1498 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001499 * The "set_insert_batch" function. Allows key/value pairs to be set for batch inserts
Derek Jonesd10e8962010-03-02 17:10:36 -06001500 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001501 * @param mixed
1502 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001503 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001504 * @return CI_DB_query_builder
Derek Jonesd10e8962010-03-02 17:10:36 -06001505 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001506 public function set_insert_batch($key, $value = '', $escape = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001507 {
1508 $key = $this->_object_to_array_batch($key);
Barry Mienydd671972010-10-04 16:33:58 +02001509
Derek Jonesd10e8962010-03-02 17:10:36 -06001510 if ( ! is_array($key))
1511 {
1512 $key = array($key => $value);
Barry Mienydd671972010-10-04 16:33:58 +02001513 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001514
Andrey Andreevfe642da2012-06-16 03:47:33 +03001515 is_bool($escape) OR $escape = $this->_protect_identifiers;
1516
Iban Eguia3c0a4522012-04-15 13:30:44 +02001517 $keys = array_keys($this->_object_to_array(current($key)));
Derek Jonesd10e8962010-03-02 17:10:36 -06001518 sort($keys);
1519
1520 foreach ($key as $row)
1521 {
Iban Eguia3c0a4522012-04-15 13:30:44 +02001522 $row = $this->_object_to_array($row);
Barry Mienydd671972010-10-04 16:33:58 +02001523 if (count(array_diff($keys, array_keys($row))) > 0 OR count(array_diff(array_keys($row), $keys)) > 0)
1524 {
1525 // batch function above returns an error on an empty array
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001526 $this->qb_set[] = array();
Barry Mienydd671972010-10-04 16:33:58 +02001527 return;
1528 }
Phil Sturgeond0ac1a22011-02-15 22:54:08 +00001529
Barry Mienydd671972010-10-04 16:33:58 +02001530 ksort($row); // puts $row in the same order as our keys
1531
Andrey Andreev2dfbe992015-07-27 21:54:18 +03001532 if ($escape !== FALSE)
Derek Jonesd10e8962010-03-02 17:10:36 -06001533 {
Andrey Andreev2dfbe992015-07-27 21:54:18 +03001534 $clean = array();
1535 foreach ($row as $value)
1536 {
1537 $clean[] = $this->escape($value);
1538 }
1539
1540 $row = $clean;
Barry Mienydd671972010-10-04 16:33:58 +02001541 }
Andrey Andreev650b4c02012-06-11 12:07:15 +03001542
Andrey Andreev838a9d62012-12-03 14:37:47 +02001543 $this->qb_set[] = '('.implode(',', $row).')';
Derek Jonesd10e8962010-03-02 17:10:36 -06001544 }
1545
1546 foreach ($keys as $k)
1547 {
Andrey Andreevfe642da2012-06-16 03:47:33 +03001548 $this->qb_keys[] = $this->protect_identifiers($k, FALSE, $escape);
Derek Jonesd10e8962010-03-02 17:10:36 -06001549 }
Barry Mienydd671972010-10-04 16:33:58 +02001550
Derek Jonesd10e8962010-03-02 17:10:36 -06001551 return $this;
1552 }
WanWizard7219c072011-12-28 14:09:05 +01001553
Kyle Farris0c147b32011-08-26 02:29:31 -04001554 // --------------------------------------------------------------------
1555
1556 /**
1557 * Get INSERT query string
1558 *
1559 * Compiles an insert query and returns the sql
1560 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001561 * @param string the table to insert into
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01001562 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001563 * @return string
1564 */
1565 public function get_compiled_insert($table = '', $reset = TRUE)
WanWizard7219c072011-12-28 14:09:05 +01001566 {
Kyle Farris0c147b32011-08-26 02:29:31 -04001567 if ($this->_validate_insert($table) === FALSE)
1568 {
1569 return FALSE;
1570 }
WanWizard7219c072011-12-28 14:09:05 +01001571
Kyle Farris76116012011-08-31 11:17:48 -04001572 $sql = $this->_insert(
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001573 $this->protect_identifiers(
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001574 $this->qb_from[0], TRUE, NULL, FALSE
Kyle Farris76116012011-08-31 11:17:48 -04001575 ),
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001576 array_keys($this->qb_set),
1577 array_values($this->qb_set)
Kyle Farris76116012011-08-31 11:17:48 -04001578 );
WanWizard7219c072011-12-28 14:09:05 +01001579
Kyle Farris0c147b32011-08-26 02:29:31 -04001580 if ($reset === TRUE)
1581 {
1582 $this->_reset_write();
1583 }
WanWizard7219c072011-12-28 14:09:05 +01001584
Kyle Farris0c147b32011-08-26 02:29:31 -04001585 return $sql;
1586 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001587
Derek Allard2067d1a2008-11-13 22:59:24 +00001588 // --------------------------------------------------------------------
1589
1590 /**
1591 * Insert
1592 *
1593 * Compiles an insert string and runs the query
1594 *
Phil Sturgeon9789f322011-07-15 15:14:05 -06001595 * @param string the table to insert data into
Derek Allard2067d1a2008-11-13 22:59:24 +00001596 * @param array an associative array of insert values
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001597 * @param bool $escape Whether to escape values and identifiers
Derek Allard2067d1a2008-11-13 22:59:24 +00001598 * @return object
1599 */
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001600 public function insert($table = '', $set = NULL, $escape = NULL)
Barry Mienydd671972010-10-04 16:33:58 +02001601 {
vlakoff1228fe22013-01-14 01:30:09 +01001602 if ($set !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001603 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001604 $this->set($set, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001605 }
WanWizard7219c072011-12-28 14:09:05 +01001606
Kyle Farris0c147b32011-08-26 02:29:31 -04001607 if ($this->_validate_insert($table) === FALSE)
1608 {
1609 return FALSE;
1610 }
WanWizard7219c072011-12-28 14:09:05 +01001611
Kyle Farris76116012011-08-31 11:17:48 -04001612 $sql = $this->_insert(
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001613 $this->protect_identifiers(
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001614 $this->qb_from[0], TRUE, $escape, FALSE
WanWizard7219c072011-12-28 14:09:05 +01001615 ),
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001616 array_keys($this->qb_set),
1617 array_values($this->qb_set)
Kyle Farris76116012011-08-31 11:17:48 -04001618 );
Barry Mienydd671972010-10-04 16:33:58 +02001619
Kyle Farris0c147b32011-08-26 02:29:31 -04001620 $this->_reset_write();
1621 return $this->query($sql);
1622 }
WanWizard7219c072011-12-28 14:09:05 +01001623
Kyle Farris0c147b32011-08-26 02:29:31 -04001624 // --------------------------------------------------------------------
1625
1626 /**
1627 * Validate Insert
1628 *
1629 * This method is used by both insert() and get_compiled_insert() to
1630 * validate that the there data is actually being set and that table
1631 * has been chosen to be inserted into.
1632 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001633 * @param string the table to insert data into
1634 * @return string
1635 */
WanWizard7219c072011-12-28 14:09:05 +01001636 protected function _validate_insert($table = '')
Kyle Farris0c147b32011-08-26 02:29:31 -04001637 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001638 if (count($this->qb_set) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001639 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001640 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001641 }
1642
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001643 if ($table !== '')
Kyle Farris0c147b32011-08-26 02:29:31 -04001644 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001645 $this->qb_from[0] = $table;
Kyle Farris0c147b32011-08-26 02:29:31 -04001646 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001647 elseif ( ! isset($this->qb_from[0]))
1648 {
1649 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
1650 }
WanWizard7219c072011-12-28 14:09:05 +01001651
Kyle Farris0c147b32011-08-26 02:29:31 -04001652 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001653 }
Barry Mienydd671972010-10-04 16:33:58 +02001654
Phil Sturgeon9789f322011-07-15 15:14:05 -06001655 // --------------------------------------------------------------------
1656
1657 /**
1658 * Replace
1659 *
1660 * Compiles an replace into string and runs the query
1661 *
1662 * @param string the table to replace data into
1663 * @param array an associative array of insert values
1664 * @return object
1665 */
1666 public function replace($table = '', $set = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001667 {
vlakoff1228fe22013-01-14 01:30:09 +01001668 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001669 {
1670 $this->set($set);
1671 }
Barry Mienydd671972010-10-04 16:33:58 +02001672
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001673 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001674 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001675 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001676 }
1677
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001678 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001679 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001680 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001681 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001682 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001683 }
Barry Mienydd671972010-10-04 16:33:58 +02001684
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001685 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001686 }
1687
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001688 $sql = $this->_replace($this->protect_identifiers($table, TRUE, NULL, FALSE), array_keys($this->qb_set), array_values($this->qb_set));
Jamie Rumbelow3b1355c2012-03-06 21:27:46 +00001689
Derek Jonesd10e8962010-03-02 17:10:36 -06001690 $this->_reset_write();
Barry Mienydd671972010-10-04 16:33:58 +02001691 return $this->query($sql);
Derek Jonesd10e8962010-03-02 17:10:36 -06001692 }
WanWizard7219c072011-12-28 14:09:05 +01001693
Kyle Farris0c147b32011-08-26 02:29:31 -04001694 // --------------------------------------------------------------------
Derek Jonesd10e8962010-03-02 17:10:36 -06001695
Kyle Farris0c147b32011-08-26 02:29:31 -04001696 /**
Andrey Andreeva3bca8f2012-04-05 15:17:25 +03001697 * Replace statement
1698 *
1699 * Generates a platform-specific replace string from the supplied data
1700 *
1701 * @param string the table name
1702 * @param array the insert keys
1703 * @param array the insert values
1704 * @return string
1705 */
1706 protected function _replace($table, $keys, $values)
1707 {
1708 return 'REPLACE INTO '.$table.' ('.implode(', ', $keys).') VALUES ('.implode(', ', $values).')';
1709 }
1710
1711 // --------------------------------------------------------------------
1712
1713 /**
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001714 * FROM tables
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001715 *
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001716 * Groups tables in FROM clauses if needed, so there is no confusion
1717 * about operator precedence.
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001718 *
Claudio Galdiolo93e78132015-01-29 11:43:56 -05001719 * Note: This is only used (and overridden) by MySQL and CUBRID.
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001720 *
1721 * @return string
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001722 */
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001723 protected function _from_tables()
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001724 {
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001725 return implode(', ', $this->qb_from);
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001726 }
1727
1728 // --------------------------------------------------------------------
1729
1730 /**
Kyle Farris0c147b32011-08-26 02:29:31 -04001731 * Get UPDATE query string
1732 *
1733 * Compiles an update query and returns the sql
1734 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001735 * @param string the table to update
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01001736 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001737 * @return string
1738 */
1739 public function get_compiled_update($table = '', $reset = TRUE)
1740 {
1741 // Combine any cached components with the current statements
1742 $this->_merge_cache();
WanWizard7219c072011-12-28 14:09:05 +01001743
Kyle Farris0c147b32011-08-26 02:29:31 -04001744 if ($this->_validate_update($table) === FALSE)
1745 {
1746 return FALSE;
1747 }
WanWizard7219c072011-12-28 14:09:05 +01001748
Andrey Andreev4b9fec62015-07-20 17:26:31 +03001749 $sql = $this->_update($this->qb_from[0], $this->qb_set);
WanWizard7219c072011-12-28 14:09:05 +01001750
Kyle Farris0c147b32011-08-26 02:29:31 -04001751 if ($reset === TRUE)
1752 {
1753 $this->_reset_write();
1754 }
WanWizard7219c072011-12-28 14:09:05 +01001755
Kyle Farris0c147b32011-08-26 02:29:31 -04001756 return $sql;
1757 }
WanWizard7219c072011-12-28 14:09:05 +01001758
Derek Allard2067d1a2008-11-13 22:59:24 +00001759 // --------------------------------------------------------------------
1760
1761 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001762 * UPDATE
Derek Allard2067d1a2008-11-13 22:59:24 +00001763 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001764 * Compiles an update string and runs the query.
Derek Allard2067d1a2008-11-13 22:59:24 +00001765 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001766 * @param string $table
1767 * @param array $set An associative array of update values
1768 * @param mixed $where
1769 * @param int $limit
Derek Allard2067d1a2008-11-13 22:59:24 +00001770 * @return object
1771 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001772 public function update($table = '', $set = NULL, $where = NULL, $limit = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001773 {
1774 // Combine any cached components with the current statements
1775 $this->_merge_cache();
1776
vlakoff1228fe22013-01-14 01:30:09 +01001777 if ($set !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001778 {
1779 $this->set($set);
1780 }
Barry Mienydd671972010-10-04 16:33:58 +02001781
Kyle Farris0c147b32011-08-26 02:29:31 -04001782 if ($this->_validate_update($table) === FALSE)
1783 {
1784 return FALSE;
1785 }
1786
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001787 if ($where !== NULL)
Kyle Farris0c147b32011-08-26 02:29:31 -04001788 {
1789 $this->where($where);
1790 }
1791
Andrey Andreev650b4c02012-06-11 12:07:15 +03001792 if ( ! empty($limit))
Kyle Farris0c147b32011-08-26 02:29:31 -04001793 {
1794 $this->limit($limit);
1795 }
1796
Andrey Andreev4b9fec62015-07-20 17:26:31 +03001797 $sql = $this->_update($this->qb_from[0], $this->qb_set);
Kyle Farris0c147b32011-08-26 02:29:31 -04001798 $this->_reset_write();
1799 return $this->query($sql);
1800 }
WanWizard7219c072011-12-28 14:09:05 +01001801
Kyle Farris0c147b32011-08-26 02:29:31 -04001802 // --------------------------------------------------------------------
1803
1804 /**
1805 * Validate Update
1806 *
1807 * This method is used by both update() and get_compiled_update() to
1808 * validate that data is actually being set and that a table has been
1809 * chosen to be update.
1810 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001811 * @param string the table to update data on
Andrey Andreev24276a32012-01-08 02:44:38 +02001812 * @return bool
Kyle Farris0c147b32011-08-26 02:29:31 -04001813 */
Andrey Andreev4b9fec62015-07-20 17:26:31 +03001814 protected function _validate_update($table)
Kyle Farris0c147b32011-08-26 02:29:31 -04001815 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001816 if (count($this->qb_set) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001817 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001818 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001819 }
1820
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001821 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001822 {
Andrey Andreev4b9fec62015-07-20 17:26:31 +03001823 $this->qb_from = array($this->protect_identifiers($table, TRUE, NULL, FALSE));
Derek Allard2067d1a2008-11-13 22:59:24 +00001824 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001825 elseif ( ! isset($this->qb_from[0]))
1826 {
1827 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
1828 }
Andrey Andreev24276a32012-01-08 02:44:38 +02001829
1830 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001831 }
WanWizard7219c072011-12-28 14:09:05 +01001832
Derek Jonesd10e8962010-03-02 17:10:36 -06001833 // --------------------------------------------------------------------
1834
1835 /**
1836 * Update_Batch
1837 *
1838 * Compiles an update string and runs the query
1839 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001840 * @param string the table to retrieve the results from
1841 * @param array an associative array of update values
1842 * @param string the where key
Andrey Andreev9f808b02012-10-24 17:38:48 +03001843 * @return int number of rows affected or FALSE on failure
Derek Jonesd10e8962010-03-02 17:10:36 -06001844 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001845 public function update_batch($table = '', $set = NULL, $index = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001846 {
1847 // Combine any cached components with the current statements
1848 $this->_merge_cache();
Barry Mienydd671972010-10-04 16:33:58 +02001849
vlakoff1228fe22013-01-14 01:30:09 +01001850 if ($index === NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001851 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001852 return ($this->db_debug) ? $this->display_error('db_must_use_index') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001853 }
1854
vlakoff1228fe22013-01-14 01:30:09 +01001855 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001856 {
1857 $this->set_update_batch($set, $index);
1858 }
1859
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001860 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001861 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001862 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001863 }
1864
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001865 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001866 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001867 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001868 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001869 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001870 }
Barry Mienydd671972010-10-04 16:33:58 +02001871
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001872 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001873 }
Barry Mienydd671972010-10-04 16:33:58 +02001874
Derek Jonesd10e8962010-03-02 17:10:36 -06001875 // Batch this baby
Andrey Andreev9f808b02012-10-24 17:38:48 +03001876 $affected_rows = 0;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001877 for ($i = 0, $total = count($this->qb_set); $i < $total; $i += 100)
Derek Jonesd10e8962010-03-02 17:10:36 -06001878 {
Andrey Andreevb0478652012-07-18 15:34:46 +03001879 $this->query($this->_update_batch($this->protect_identifiers($table, TRUE, NULL, FALSE), array_slice($this->qb_set, $i, 100), $this->protect_identifiers($index)));
Andrey Andreev9f808b02012-10-24 17:38:48 +03001880 $affected_rows += $this->affected_rows();
Andrey Andreev79f888b2013-08-06 13:59:23 +03001881 $this->qb_where = array();
Derek Jonesd10e8962010-03-02 17:10:36 -06001882 }
Barry Mienydd671972010-10-04 16:33:58 +02001883
Derek Jonesd10e8962010-03-02 17:10:36 -06001884 $this->_reset_write();
Andrey Andreev9f808b02012-10-24 17:38:48 +03001885 return $affected_rows;
Derek Jonesd10e8962010-03-02 17:10:36 -06001886 }
1887
1888 // --------------------------------------------------------------------
1889
1890 /**
Andrey Andreev219565d2013-03-12 20:00:08 +02001891 * Update_Batch statement
1892 *
1893 * Generates a platform-specific batch update string from the supplied data
1894 *
1895 * @param string $table Table name
1896 * @param array $values Update data
1897 * @param string $index WHERE key
1898 * @return string
1899 */
1900 protected function _update_batch($table, $values, $index)
1901 {
1902 $ids = array();
1903 foreach ($values as $key => $val)
1904 {
1905 $ids[] = $val[$index];
1906
1907 foreach (array_keys($val) as $field)
1908 {
1909 if ($field !== $index)
1910 {
1911 $final[$field][] = 'WHEN '.$index.' = '.$val[$index].' THEN '.$val[$field];
1912 }
1913 }
1914 }
1915
1916 $cases = '';
1917 foreach ($final as $k => $v)
1918 {
1919 $cases .= $k." = CASE \n"
1920 .implode("\n", $v)."\n"
1921 .'ELSE '.$k.' END, ';
1922 }
1923
1924 $this->where($index.' IN('.implode(',', $ids).')', NULL, FALSE);
1925
1926 return 'UPDATE '.$table.' SET '.substr($cases, 0, -2).$this->_compile_wh('qb_where');
1927 }
1928
1929 // --------------------------------------------------------------------
1930
1931 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001932 * The "set_update_batch" function. Allows key/value pairs to be set for batch updating
Derek Jonesd10e8962010-03-02 17:10:36 -06001933 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001934 * @param array
1935 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001936 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001937 * @return CI_DB_query_builder
Derek Jonesd10e8962010-03-02 17:10:36 -06001938 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001939 public function set_update_batch($key, $index = '', $escape = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001940 {
1941 $key = $this->_object_to_array_batch($key);
Barry Mienydd671972010-10-04 16:33:58 +02001942
Derek Jonesd10e8962010-03-02 17:10:36 -06001943 if ( ! is_array($key))
1944 {
1945 // @todo error
Barry Mienydd671972010-10-04 16:33:58 +02001946 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001947
Andrey Andreevfe642da2012-06-16 03:47:33 +03001948 is_bool($escape) OR $escape = $this->_protect_identifiers;
1949
Derek Jonesd10e8962010-03-02 17:10:36 -06001950 foreach ($key as $k => $v)
1951 {
1952 $index_set = FALSE;
1953 $clean = array();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001954 foreach ($v as $k2 => $v2)
Derek Jonesd10e8962010-03-02 17:10:36 -06001955 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001956 if ($k2 === $index)
Derek Jonesd10e8962010-03-02 17:10:36 -06001957 {
1958 $index_set = TRUE;
1959 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001960
Andrey Andreev2dfbe992015-07-27 21:54:18 +03001961 $clean[$this->protect_identifiers($k2, FALSE, $escape)] = ($escape === FALSE) ? $v2 : $this->escape($v2);
Derek Jonesd10e8962010-03-02 17:10:36 -06001962 }
1963
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001964 if ($index_set === FALSE)
Derek Jonesd10e8962010-03-02 17:10:36 -06001965 {
1966 return $this->display_error('db_batch_missing_index');
1967 }
1968
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001969 $this->qb_set[] = $clean;
Derek Jonesd10e8962010-03-02 17:10:36 -06001970 }
Barry Mienydd671972010-10-04 16:33:58 +02001971
Derek Jonesd10e8962010-03-02 17:10:36 -06001972 return $this;
1973 }
1974
Derek Allard2067d1a2008-11-13 22:59:24 +00001975 // --------------------------------------------------------------------
1976
1977 /**
1978 * Empty Table
1979 *
1980 * Compiles a delete string and runs "DELETE FROM table"
1981 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001982 * @param string the table to empty
1983 * @return object
1984 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001985 public function empty_table($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001986 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001987 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001988 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001989 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00001990 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001991 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001992 }
1993
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001994 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00001995 }
1996 else
1997 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001998 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001999 }
2000
2001 $sql = $this->_delete($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00002002 $this->_reset_write();
Derek Allard2067d1a2008-11-13 22:59:24 +00002003 return $this->query($sql);
2004 }
2005
2006 // --------------------------------------------------------------------
2007
2008 /**
2009 * Truncate
2010 *
2011 * Compiles a truncate string and runs the query
2012 * If the database does not support the truncate() command
2013 * This function maps to "DELETE FROM table"
2014 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002015 * @param string the table to truncate
2016 * @return object
2017 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002018 public function truncate($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002019 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002020 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002021 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002022 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00002023 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002024 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002025 }
2026
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002027 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00002028 }
2029 else
2030 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02002031 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00002032 }
2033
2034 $sql = $this->_truncate($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00002035 $this->_reset_write();
Derek Allard2067d1a2008-11-13 22:59:24 +00002036 return $this->query($sql);
2037 }
WanWizard7219c072011-12-28 14:09:05 +01002038
Kyle Farris0c147b32011-08-26 02:29:31 -04002039 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02002040
Kyle Farris0c147b32011-08-26 02:29:31 -04002041 /**
Andrey Andreeva6fe36e2012-04-05 16:00:32 +03002042 * Truncate statement
2043 *
2044 * Generates a platform-specific truncate string from the supplied data
2045 *
2046 * If the database does not support the truncate() command,
2047 * then this method maps to 'DELETE FROM table'
2048 *
2049 * @param string the table name
2050 * @return string
2051 */
2052 protected function _truncate($table)
2053 {
2054 return 'TRUNCATE '.$table;
2055 }
2056
2057 // --------------------------------------------------------------------
2058
2059 /**
Kyle Farris0c147b32011-08-26 02:29:31 -04002060 * Get DELETE query string
2061 *
2062 * Compiles a delete query string and returns the sql
2063 *
Kyle Farris0c147b32011-08-26 02:29:31 -04002064 * @param string the table to delete from
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002065 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04002066 * @return string
2067 */
2068 public function get_compiled_delete($table = '', $reset = TRUE)
2069 {
2070 $this->return_delete_sql = TRUE;
2071 $sql = $this->delete($table, '', NULL, $reset);
2072 $this->return_delete_sql = FALSE;
2073 return $sql;
2074 }
WanWizard7219c072011-12-28 14:09:05 +01002075
Derek Allard2067d1a2008-11-13 22:59:24 +00002076 // --------------------------------------------------------------------
2077
2078 /**
2079 * Delete
2080 *
2081 * Compiles a delete string and runs the query
2082 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002083 * @param mixed the table(s) to delete from. String or array
2084 * @param mixed the where clause
2085 * @param mixed the limit clause
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03002086 * @param bool
Andrey Andreev0bcf5902012-10-12 13:03:29 +03002087 * @return mixed
Derek Allard2067d1a2008-11-13 22:59:24 +00002088 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002089 public function delete($table = '', $where = '', $limit = NULL, $reset_data = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002090 {
2091 // Combine any cached components with the current statements
2092 $this->_merge_cache();
2093
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002094 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002095 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002096 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00002097 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002098 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002099 }
2100
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002101 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00002102 }
2103 elseif (is_array($table))
2104 {
Andrey Andreeva1170af2015-07-02 11:46:56 +03002105 empty($where) && $reset_data = FALSE;
2106
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05002107 foreach ($table as $single_table)
Derek Allard2067d1a2008-11-13 22:59:24 +00002108 {
Andrey Andreev13f50542012-10-12 12:31:02 +03002109 $this->delete($single_table, $where, $limit, $reset_data);
Derek Allard2067d1a2008-11-13 22:59:24 +00002110 }
Andrey Andreeva1170af2015-07-02 11:46:56 +03002111
Derek Allard2067d1a2008-11-13 22:59:24 +00002112 return;
2113 }
2114 else
2115 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02002116 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00002117 }
2118
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002119 if ($where !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002120 {
2121 $this->where($where);
2122 }
2123
Andrey Andreev650b4c02012-06-11 12:07:15 +03002124 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00002125 {
2126 $this->limit($limit);
2127 }
2128
Andrey Andreev94611df2012-07-19 12:29:54 +03002129 if (count($this->qb_where) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002130 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002131 return ($this->db_debug) ? $this->display_error('db_del_must_use_where') : FALSE;
Barry Mienydd671972010-10-04 16:33:58 +02002132 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002133
Andrey Andreevb0478652012-07-18 15:34:46 +03002134 $sql = $this->_delete($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00002135 if ($reset_data)
2136 {
2137 $this->_reset_write();
2138 }
WanWizard7219c072011-12-28 14:09:05 +01002139
Andrey Andreev24276a32012-01-08 02:44:38 +02002140 return ($this->return_delete_sql === TRUE) ? $sql : $this->query($sql);
Derek Allard2067d1a2008-11-13 22:59:24 +00002141 }
WanWizard7219c072011-12-28 14:09:05 +01002142
Derek Allard2067d1a2008-11-13 22:59:24 +00002143 // --------------------------------------------------------------------
2144
2145 /**
Andrey Andreevc01d3162012-04-09 12:55:11 +03002146 * Delete statement
2147 *
2148 * Generates a platform-specific delete string from the supplied data
2149 *
2150 * @param string the table name
Andrey Andreevc01d3162012-04-09 12:55:11 +03002151 * @return string
2152 */
Andrey Andreevb0478652012-07-18 15:34:46 +03002153 protected function _delete($table)
Andrey Andreevc01d3162012-04-09 12:55:11 +03002154 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002155 return 'DELETE FROM '.$table.$this->_compile_wh('qb_where')
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002156 .($this->qb_limit ? ' LIMIT '.$this->qb_limit : '');
Andrey Andreevc01d3162012-04-09 12:55:11 +03002157 }
2158
2159 // --------------------------------------------------------------------
2160
2161 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002162 * DB Prefix
2163 *
2164 * Prepends a database prefix if one exists in configuration
2165 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002166 * @param string the table
2167 * @return string
2168 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002169 public function dbprefix($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002170 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002171 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002172 {
2173 $this->display_error('db_table_name_required');
2174 }
2175
2176 return $this->dbprefix.$table;
2177 }
2178
2179 // --------------------------------------------------------------------
2180
2181 /**
Phil Sturgeon8a022472011-07-15 15:25:15 -06002182 * Set DB Prefix
2183 *
2184 * Set's the DB Prefix to something new without needing to reconnect
2185 *
2186 * @param string the prefix
2187 * @return string
2188 */
2189 public function set_dbprefix($prefix = '')
2190 {
2191 return $this->dbprefix = $prefix;
2192 }
2193
2194 // --------------------------------------------------------------------
2195
2196 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002197 * Track Aliases
2198 *
2199 * Used to track SQL statements written with aliased tables.
2200 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002201 * @param string The table to inspect
2202 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02002203 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002204 protected function _track_aliases($table)
Derek Allard2067d1a2008-11-13 22:59:24 +00002205 {
2206 if (is_array($table))
2207 {
2208 foreach ($table as $t)
2209 {
2210 $this->_track_aliases($t);
2211 }
2212 return;
2213 }
Barry Mienydd671972010-10-04 16:33:58 +02002214
Derek Jones37f4b9c2011-07-01 17:56:50 -05002215 // Does the string contain a comma? If so, we need to separate
Derek Allard2067d1a2008-11-13 22:59:24 +00002216 // the string into discreet statements
2217 if (strpos($table, ',') !== FALSE)
2218 {
2219 return $this->_track_aliases(explode(',', $table));
2220 }
Barry Mienydd671972010-10-04 16:33:58 +02002221
Derek Allard2067d1a2008-11-13 22:59:24 +00002222 // if a table alias is used we can recognize it by a space
Andrey Andreev24276a32012-01-08 02:44:38 +02002223 if (strpos($table, ' ') !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002224 {
2225 // if the alias is written with the AS keyword, remove it
Andrey Andreev5a257182012-06-10 06:18:14 +03002226 $table = preg_replace('/\s+AS\s+/i', ' ', $table);
Barry Mienydd671972010-10-04 16:33:58 +02002227
Derek Allard2067d1a2008-11-13 22:59:24 +00002228 // Grab the alias
Andrey Andreev24276a32012-01-08 02:44:38 +02002229 $table = trim(strrchr($table, ' '));
Barry Mienydd671972010-10-04 16:33:58 +02002230
Derek Allard2067d1a2008-11-13 22:59:24 +00002231 // Store the alias, if it doesn't already exist
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002232 if ( ! in_array($table, $this->qb_aliased_tables))
Derek Allard2067d1a2008-11-13 22:59:24 +00002233 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002234 $this->qb_aliased_tables[] = $table;
Derek Allard2067d1a2008-11-13 22:59:24 +00002235 }
2236 }
2237 }
WanWizard7219c072011-12-28 14:09:05 +01002238
Derek Allard2067d1a2008-11-13 22:59:24 +00002239 // --------------------------------------------------------------------
2240
2241 /**
2242 * Compile the SELECT statement
2243 *
2244 * Generates a query string based on which functions were used.
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002245 * Should not be called directly.
Derek Allard2067d1a2008-11-13 22:59:24 +00002246 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02002247 * @param bool $select_override
Derek Allard2067d1a2008-11-13 22:59:24 +00002248 * @return string
2249 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002250 protected function _compile_select($select_override = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002251 {
2252 // Combine any cached components with the current statements
2253 $this->_merge_cache();
2254
Derek Allard2067d1a2008-11-13 22:59:24 +00002255 // Write the "select" portion of the query
Derek Allard2067d1a2008-11-13 22:59:24 +00002256 if ($select_override !== FALSE)
2257 {
2258 $sql = $select_override;
2259 }
2260 else
2261 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002262 $sql = ( ! $this->qb_distinct) ? 'SELECT ' : 'SELECT DISTINCT ';
Barry Mienydd671972010-10-04 16:33:58 +02002263
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002264 if (count($this->qb_select) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002265 {
Barry Mienydd671972010-10-04 16:33:58 +02002266 $sql .= '*';
Derek Allard2067d1a2008-11-13 22:59:24 +00002267 }
2268 else
Barry Mienydd671972010-10-04 16:33:58 +02002269 {
Derek Allard2067d1a2008-11-13 22:59:24 +00002270 // Cycle through the "select" portion of the query and prep each column name.
Andrey Andreev1924eb32015-04-08 17:19:24 +03002271 // The reason we protect identifiers here rather than in the select() function
Derek Allard2067d1a2008-11-13 22:59:24 +00002272 // is because until the user calls the from() function we don't know if there are aliases
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002273 foreach ($this->qb_select as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00002274 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002275 $no_escape = isset($this->qb_no_escape[$key]) ? $this->qb_no_escape[$key] : NULL;
Jamie Rumbelow0c092992012-03-06 22:05:16 +00002276 $this->qb_select[$key] = $this->protect_identifiers($val, FALSE, $no_escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00002277 }
Barry Mienydd671972010-10-04 16:33:58 +02002278
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002279 $sql .= implode(', ', $this->qb_select);
Derek Allard2067d1a2008-11-13 22:59:24 +00002280 }
2281 }
2282
Derek Allard2067d1a2008-11-13 22:59:24 +00002283 // Write the "FROM" portion of the query
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002284 if (count($this->qb_from) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002285 {
Andrey Andreeve78f8152012-10-09 11:38:38 +03002286 $sql .= "\nFROM ".$this->_from_tables();
Derek Allard2067d1a2008-11-13 22:59:24 +00002287 }
2288
Derek Allard2067d1a2008-11-13 22:59:24 +00002289 // Write the "JOIN" portion of the query
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002290 if (count($this->qb_join) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002291 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002292 $sql .= "\n".implode("\n", $this->qb_join);
Derek Allard2067d1a2008-11-13 22:59:24 +00002293 }
2294
Andrey Andreev2d486232012-07-19 14:46:51 +03002295 $sql .= $this->_compile_wh('qb_where')
2296 .$this->_compile_group_by()
2297 .$this->_compile_wh('qb_having')
2298 .$this->_compile_order_by(); // ORDER BY
Andrey Andreevb0478652012-07-18 15:34:46 +03002299
Andrey Andreevd40459d2012-07-18 16:46:39 +03002300 // LIMIT
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002301 if ($this->qb_limit)
Derek Allard2067d1a2008-11-13 22:59:24 +00002302 {
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002303 return $this->_limit($sql."\n");
Derek Allard2067d1a2008-11-13 22:59:24 +00002304 }
2305
2306 return $sql;
2307 }
2308
2309 // --------------------------------------------------------------------
2310
2311 /**
Andrey Andreevd40459d2012-07-18 16:46:39 +03002312 * Compile WHERE, HAVING statements
Andrey Andreev6e704752012-07-18 00:46:33 +03002313 *
Andrey Andreevd40459d2012-07-18 16:46:39 +03002314 * Escapes identifiers in WHERE and HAVING statements at execution time.
2315 *
Andrey Andreevb0478652012-07-18 15:34:46 +03002316 * Required so that aliases are tracked properly, regardless of wether
Andrey Andreevd40459d2012-07-18 16:46:39 +03002317 * where(), or_where(), having(), or_having are called prior to from(),
2318 * join() and dbprefix is added only if needed.
Andrey Andreev6e704752012-07-18 00:46:33 +03002319 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02002320 * @param string $qb_key 'qb_where' or 'qb_having'
Andrey Andreevd40459d2012-07-18 16:46:39 +03002321 * @return string SQL statement
Andrey Andreev6e704752012-07-18 00:46:33 +03002322 */
Andrey Andreevd40459d2012-07-18 16:46:39 +03002323 protected function _compile_wh($qb_key)
Andrey Andreev6e704752012-07-18 00:46:33 +03002324 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002325 if (count($this->$qb_key) > 0)
Andrey Andreev6e704752012-07-18 00:46:33 +03002326 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002327 for ($i = 0, $c = count($this->$qb_key); $i < $c; $i++)
Andrey Andreev6e704752012-07-18 00:46:33 +03002328 {
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002329 // Is this condition already compiled?
2330 if (is_string($this->{$qb_key}[$i]))
2331 {
2332 continue;
2333 }
2334 elseif ($this->{$qb_key}[$i]['escape'] === FALSE)
Andrey Andreev6e704752012-07-18 00:46:33 +03002335 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002336 $this->{$qb_key}[$i] = $this->{$qb_key}[$i]['condition'];
Andrey Andreev6e704752012-07-18 00:46:33 +03002337 continue;
2338 }
2339
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002340 // Split multiple conditions
2341 $conditions = preg_split(
Andrey Andreev7ed93be2015-06-29 11:43:32 +03002342 '/((^|\s+)AND\s+|(^|\s+)OR\s+)/i',
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002343 $this->{$qb_key}[$i]['condition'],
2344 -1,
2345 PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
2346 );
2347
2348 for ($ci = 0, $cc = count($conditions); $ci < $cc; $ci++)
Andrey Andreev6e704752012-07-18 00:46:33 +03002349 {
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002350 if (($op = $this->_get_operator($conditions[$ci])) === FALSE
Andrey Andreeve4742582012-10-25 13:25:13 +03002351 OR ! preg_match('/^(\(?)(.*)('.preg_quote($op, '/').')\s*(.*(?<!\)))?(\)?)$/i', $conditions[$ci], $matches))
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002352 {
2353 continue;
2354 }
2355
2356 // $matches = array(
2357 // 0 => '(test <= foo)', /* the whole thing */
2358 // 1 => '(', /* optional */
2359 // 2 => 'test', /* the field name */
2360 // 3 => ' <= ', /* $op */
2361 // 4 => 'foo', /* optional, if $op is e.g. 'IS NULL' */
2362 // 5 => ')' /* optional */
2363 // );
Andrey Andreev082aa402012-10-22 19:41:55 +03002364
2365 if ( ! empty($matches[4]))
2366 {
2367 $this->_is_literal($matches[4]) OR $matches[4] = $this->protect_identifiers(trim($matches[4]));
2368 $matches[4] = ' '.$matches[4];
2369 }
2370
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002371 $conditions[$ci] = $matches[1].$this->protect_identifiers(trim($matches[2]))
2372 .' '.trim($matches[3]).$matches[4].$matches[5];
Andrey Andreev6e704752012-07-18 00:46:33 +03002373 }
2374
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002375 $this->{$qb_key}[$i] = implode('', $conditions);
Andrey Andreev6e704752012-07-18 00:46:33 +03002376 }
2377
Andrey Andreev9d3aa1b2012-10-12 12:14:09 +03002378 return ($qb_key === 'qb_having' ? "\nHAVING " : "\nWHERE ")
2379 .implode("\n", $this->$qb_key);
Andrey Andreev6e704752012-07-18 00:46:33 +03002380 }
2381
Andrey Andreevb0478652012-07-18 15:34:46 +03002382 return '';
Andrey Andreev6e704752012-07-18 00:46:33 +03002383 }
2384
2385 // --------------------------------------------------------------------
2386
2387 /**
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002388 * Compile GROUP BY
2389 *
2390 * Escapes identifiers in GROUP BY statements at execution time.
2391 *
2392 * Required so that aliases are tracked properly, regardless of wether
2393 * group_by() is called prior to from(), join() and dbprefix is added
2394 * only if needed.
2395 *
2396 * @return string SQL statement
2397 */
2398 protected function _compile_group_by()
2399 {
2400 if (count($this->qb_groupby) > 0)
2401 {
Andrey Andreev96feb582012-07-19 13:12:34 +03002402 for ($i = 0, $c = count($this->qb_groupby); $i < $c; $i++)
2403 {
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002404 // Is it already compiled?
Andrey Andreev18eba242014-01-23 22:52:31 +02002405 if (is_string($this->qb_groupby[$i]))
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002406 {
2407 continue;
2408 }
2409
Andrey Andreev082aa402012-10-22 19:41:55 +03002410 $this->qb_groupby[$i] = ($this->qb_groupby[$i]['escape'] === FALSE OR $this->_is_literal($this->qb_groupby[$i]['field']))
Andrey Andreev96feb582012-07-19 13:12:34 +03002411 ? $this->qb_groupby[$i]['field']
Andrey Andreev13f50542012-10-12 12:31:02 +03002412 : $this->protect_identifiers($this->qb_groupby[$i]['field']);
Andrey Andreev96feb582012-07-19 13:12:34 +03002413 }
2414
Andrey Andreev0bcf5902012-10-12 13:03:29 +03002415 return "\nGROUP BY ".implode(', ', $this->qb_groupby);
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002416 }
2417
2418 return '';
2419 }
2420
2421 // --------------------------------------------------------------------
2422
2423 /**
Andrey Andreev2d486232012-07-19 14:46:51 +03002424 * Compile ORDER BY
2425 *
2426 * Escapes identifiers in ORDER BY statements at execution time.
2427 *
2428 * Required so that aliases are tracked properly, regardless of wether
2429 * order_by() is called prior to from(), join() and dbprefix is added
2430 * only if needed.
2431 *
2432 * @return string SQL statement
2433 */
2434 protected function _compile_order_by()
2435 {
Andrey Andreeva53ea842012-10-23 12:44:09 +03002436 if (is_array($this->qb_orderby) && count($this->qb_orderby) > 0)
Andrey Andreev2d486232012-07-19 14:46:51 +03002437 {
Andrey Andreev2d486232012-07-19 14:46:51 +03002438 for ($i = 0, $c = count($this->qb_orderby); $i < $c; $i++)
2439 {
Andrey Andreev082aa402012-10-22 19:41:55 +03002440 if ($this->qb_orderby[$i]['escape'] !== FALSE && ! $this->_is_literal($this->qb_orderby[$i]['field']))
Andrey Andreev2d486232012-07-19 14:46:51 +03002441 {
Andrey Andreevfc043b32012-10-12 14:46:14 +03002442 $this->qb_orderby[$i]['field'] = $this->protect_identifiers($this->qb_orderby[$i]['field']);
Andrey Andreev2d486232012-07-19 14:46:51 +03002443 }
2444
2445 $this->qb_orderby[$i] = $this->qb_orderby[$i]['field'].$this->qb_orderby[$i]['direction'];
2446 }
2447
Andrey Andreeva53ea842012-10-23 12:44:09 +03002448 return $this->qb_orderby = "\nORDER BY ".implode(', ', $this->qb_orderby);
2449 }
2450 elseif (is_string($this->qb_orderby))
2451 {
2452 return $this->qb_orderby;
Andrey Andreev2d486232012-07-19 14:46:51 +03002453 }
2454
2455 return '';
2456 }
2457
2458 // --------------------------------------------------------------------
2459
2460 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002461 * Object to Array
2462 *
2463 * Takes an object as input and converts the class variables to array key/vals
2464 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002465 * @param object
2466 * @return array
2467 */
Andrey Andreev7b5eb732012-05-24 20:52:41 +03002468 protected function _object_to_array($object)
Derek Allard2067d1a2008-11-13 22:59:24 +00002469 {
2470 if ( ! is_object($object))
2471 {
2472 return $object;
2473 }
Barry Mienydd671972010-10-04 16:33:58 +02002474
Derek Allard2067d1a2008-11-13 22:59:24 +00002475 $array = array();
2476 foreach (get_object_vars($object) as $key => $val)
2477 {
2478 // There are some built in keys we need to ignore for this conversion
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002479 if ( ! is_object($val) && ! is_array($val) && $key !== '_parent_name')
Derek Allard2067d1a2008-11-13 22:59:24 +00002480 {
2481 $array[$key] = $val;
2482 }
2483 }
Derek Jonesd10e8962010-03-02 17:10:36 -06002484
2485 return $array;
2486 }
Barry Mienydd671972010-10-04 16:33:58 +02002487
Derek Jonesd10e8962010-03-02 17:10:36 -06002488 // --------------------------------------------------------------------
2489
2490 /**
2491 * Object to Array
2492 *
2493 * Takes an object as input and converts the class variables to array key/vals
2494 *
Derek Jonesd10e8962010-03-02 17:10:36 -06002495 * @param object
2496 * @return array
2497 */
Andrey Andreev7b5eb732012-05-24 20:52:41 +03002498 protected function _object_to_array_batch($object)
Derek Jonesd10e8962010-03-02 17:10:36 -06002499 {
2500 if ( ! is_object($object))
2501 {
2502 return $object;
2503 }
Barry Mienydd671972010-10-04 16:33:58 +02002504
Derek Jonesd10e8962010-03-02 17:10:36 -06002505 $array = array();
2506 $out = get_object_vars($object);
2507 $fields = array_keys($out);
2508
2509 foreach ($fields as $val)
2510 {
2511 // There are some built in keys we need to ignore for this conversion
Andrey Andreev24276a32012-01-08 02:44:38 +02002512 if ($val !== '_parent_name')
Derek Jonesd10e8962010-03-02 17:10:36 -06002513 {
Derek Jonesd10e8962010-03-02 17:10:36 -06002514 $i = 0;
2515 foreach ($out[$val] as $data)
2516 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002517 $array[$i++][$val] = $data;
Derek Jonesd10e8962010-03-02 17:10:36 -06002518 }
2519 }
2520 }
2521
Derek Allard2067d1a2008-11-13 22:59:24 +00002522 return $array;
2523 }
Barry Mienydd671972010-10-04 16:33:58 +02002524
Derek Allard2067d1a2008-11-13 22:59:24 +00002525 // --------------------------------------------------------------------
2526
2527 /**
2528 * Start Cache
2529 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002530 * Starts QB caching
Derek Allard2067d1a2008-11-13 22:59:24 +00002531 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002532 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002533 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002534 public function start_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002535 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002536 $this->qb_caching = TRUE;
Andrey Andreev4a587f52014-12-11 16:27:15 +02002537 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002538 }
2539
2540 // --------------------------------------------------------------------
2541
2542 /**
2543 * Stop Cache
2544 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002545 * Stops QB caching
Derek Allard2067d1a2008-11-13 22:59:24 +00002546 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002547 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002548 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002549 public function stop_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002550 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002551 $this->qb_caching = FALSE;
Andrey Andreev4a587f52014-12-11 16:27:15 +02002552 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002553 }
2554
2555 // --------------------------------------------------------------------
2556
2557 /**
2558 * Flush Cache
2559 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002560 * Empties the QB cache
Derek Allard2067d1a2008-11-13 22:59:24 +00002561 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002562 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002563 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002564 public function flush_cache()
Barry Mienydd671972010-10-04 16:33:58 +02002565 {
Phil Sturgeon9789f322011-07-15 15:14:05 -06002566 $this->_reset_run(array(
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002567 'qb_cache_select' => array(),
2568 'qb_cache_from' => array(),
2569 'qb_cache_join' => array(),
2570 'qb_cache_where' => array(),
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002571 'qb_cache_groupby' => array(),
2572 'qb_cache_having' => array(),
2573 'qb_cache_orderby' => array(),
2574 'qb_cache_set' => array(),
2575 'qb_cache_exists' => array(),
2576 'qb_cache_no_escape' => array()
Phil Sturgeon9789f322011-07-15 15:14:05 -06002577 ));
Andrey Andreev4a587f52014-12-11 16:27:15 +02002578
2579 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002580 }
2581
2582 // --------------------------------------------------------------------
2583
2584 /**
2585 * Merge Cache
2586 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002587 * When called, this function merges any cached QB arrays with
Derek Allard2067d1a2008-11-13 22:59:24 +00002588 * locally called ones.
2589 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002590 * @return void
2591 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002592 protected function _merge_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002593 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002594 if (count($this->qb_cache_exists) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002595 {
2596 return;
2597 }
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002598 elseif (in_array('select', $this->qb_cache_exists, TRUE))
2599 {
2600 $qb_no_escape = $this->qb_cache_no_escape;
2601 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002602
GDmac17a05282013-11-11 13:18:09 +01002603 foreach (array_unique($this->qb_cache_exists) as $val) // select, from, etc.
Derek Allard2067d1a2008-11-13 22:59:24 +00002604 {
Jamie Rumbelowae123e02012-02-21 16:39:56 +00002605 $qb_variable = 'qb_'.$val;
2606 $qb_cache_var = 'qb_cache_'.$val;
Andrey Andreev35e3b0b2013-11-12 16:07:08 +02002607 $qb_new = $this->$qb_cache_var;
GDmace1b86832013-11-08 16:52:54 +01002608
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002609 for ($i = 0, $c = count($this->$qb_variable); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00002610 {
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002611 if ( ! in_array($this->{$qb_variable}[$i], $qb_new, TRUE))
2612 {
2613 $qb_new[] = $this->{$qb_variable}[$i];
2614 if ($val === 'select')
2615 {
2616 $qb_no_escape[] = $this->qb_no_escape[$i];
2617 }
2618 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002619 }
Andrey Andreev35e3b0b2013-11-12 16:07:08 +02002620
GDmace1b86832013-11-08 16:52:54 +01002621 $this->$qb_variable = $qb_new;
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002622 if ($val === 'select')
2623 {
2624 $this->qb_no_escape = $qb_no_escape;
2625 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002626 }
2627
2628 // If we are "protecting identifiers" we need to examine the "from"
2629 // portion of the query to determine if there are any aliases
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002630 if ($this->_protect_identifiers === TRUE && count($this->qb_cache_from) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002631 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002632 $this->_track_aliases($this->qb_from);
Derek Allard2067d1a2008-11-13 22:59:24 +00002633 }
2634 }
WanWizard7219c072011-12-28 14:09:05 +01002635
Kyle Farris0c147b32011-08-26 02:29:31 -04002636 // --------------------------------------------------------------------
2637
2638 /**
Andrey Andreev082aa402012-10-22 19:41:55 +03002639 * Is literal
2640 *
2641 * Determines if a string represents a literal value or a field name
2642 *
Andrey Andreev02e4cd72012-11-13 11:50:47 +02002643 * @param string $str
Andrey Andreev082aa402012-10-22 19:41:55 +03002644 * @return bool
2645 */
2646 protected function _is_literal($str)
2647 {
2648 $str = trim($str);
2649
Andrey Andreev3a5efc22012-11-20 21:18:08 +02002650 if (empty($str) OR ctype_digit($str) OR (string) (float) $str === $str OR in_array(strtoupper($str), array('TRUE', 'FALSE'), TRUE))
Andrey Andreev082aa402012-10-22 19:41:55 +03002651 {
2652 return TRUE;
2653 }
2654
2655 static $_str;
2656
2657 if (empty($_str))
2658 {
2659 $_str = ($this->_escape_char !== '"')
2660 ? array('"', "'") : array("'");
2661 }
2662
Andrey Andreev3a5efc22012-11-20 21:18:08 +02002663 return in_array($str[0], $_str, TRUE);
Andrey Andreev082aa402012-10-22 19:41:55 +03002664 }
2665
2666 // --------------------------------------------------------------------
2667
2668 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002669 * Reset Query Builder values.
WanWizard7219c072011-12-28 14:09:05 +01002670 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002671 * Publicly-visible method to reset the QB values.
Kyle Farris0c147b32011-08-26 02:29:31 -04002672 *
Andrey Andreev435e0c22014-12-11 16:30:13 +02002673 * @return CI_DB_query_builder
Kyle Farris0c147b32011-08-26 02:29:31 -04002674 */
2675 public function reset_query()
2676 {
2677 $this->_reset_select();
2678 $this->_reset_write();
Andrey Andreev435e0c22014-12-11 16:30:13 +02002679 return $this;
Kyle Farris0c147b32011-08-26 02:29:31 -04002680 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002681
2682 // --------------------------------------------------------------------
2683
2684 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002685 * Resets the query builder values. Called by the get() function
Derek Allard2067d1a2008-11-13 22:59:24 +00002686 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002687 * @param array An array of fields to reset
2688 * @return void
2689 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002690 protected function _reset_run($qb_reset_items)
Derek Allard2067d1a2008-11-13 22:59:24 +00002691 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002692 foreach ($qb_reset_items as $item => $default_value)
Derek Allard2067d1a2008-11-13 22:59:24 +00002693 {
Andrey Andreevae85eb42012-11-02 01:42:31 +02002694 $this->$item = $default_value;
Derek Allard2067d1a2008-11-13 22:59:24 +00002695 }
2696 }
2697
2698 // --------------------------------------------------------------------
2699
2700 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002701 * Resets the query builder values. Called by the get() function
Derek Allard2067d1a2008-11-13 22:59:24 +00002702 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002703 * @return void
2704 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002705 protected function _reset_select()
Derek Allard2067d1a2008-11-13 22:59:24 +00002706 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002707 $this->_reset_run(array(
Andrey Andreev4a587f52014-12-11 16:27:15 +02002708 'qb_select' => array(),
2709 'qb_from' => array(),
2710 'qb_join' => array(),
2711 'qb_where' => array(),
2712 'qb_groupby' => array(),
2713 'qb_having' => array(),
2714 'qb_orderby' => array(),
2715 'qb_aliased_tables' => array(),
2716 'qb_no_escape' => array(),
2717 'qb_distinct' => FALSE,
2718 'qb_limit' => FALSE,
2719 'qb_offset' => FALSE
2720 ));
Derek Allard2067d1a2008-11-13 22:59:24 +00002721 }
Barry Mienydd671972010-10-04 16:33:58 +02002722
Derek Allard2067d1a2008-11-13 22:59:24 +00002723 // --------------------------------------------------------------------
2724
2725 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002726 * Resets the query builder "write" values.
Derek Allard2067d1a2008-11-13 22:59:24 +00002727 *
Robin Sowell43753fd2010-09-16 12:52:07 -04002728 * Called by the insert() update() insert_batch() update_batch() and delete() functions
Derek Allard2067d1a2008-11-13 22:59:24 +00002729 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002730 * @return void
2731 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002732 protected function _reset_write()
Barry Mienydd671972010-10-04 16:33:58 +02002733 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002734 $this->_reset_run(array(
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002735 'qb_set' => array(),
2736 'qb_from' => array(),
Andrey Andreev3e014372013-02-21 15:59:34 +02002737 'qb_join' => array(),
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002738 'qb_where' => array(),
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002739 'qb_orderby' => array(),
2740 'qb_keys' => array(),
Andrey Andreev650b4c02012-06-11 12:07:15 +03002741 'qb_limit' => FALSE
Andrey Andreev4a587f52014-12-11 16:27:15 +02002742 ));
Derek Allard2067d1a2008-11-13 22:59:24 +00002743 }
Andrey Andreev24276a32012-01-08 02:44:38 +02002744
Derek Allard2067d1a2008-11-13 22:59:24 +00002745}