blob: 3d4a8576c90b5af6f7729ae57db8edf6f2279f49 [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 {
660 if ($escape === TRUE)
661 {
Andrey Andreev3a5efc22012-11-20 21:18:08 +0200662 $v = ' '.$this->escape($v);
Derek Allard2067d1a2008-11-13 22:59:24 +0000663 }
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 Andreev94611df2012-07-19 12:29:54 +0300797 $where_in = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000798 foreach ($values as $value)
799 {
Andrey Andreevcc02db92012-10-12 14:30:10 +0300800 $where_in[] = $this->escape($value);
Derek Allard2067d1a2008-11-13 22:59:24 +0000801 }
802
WanWizardbc69f362012-06-22 00:10:11 +0200803 $prefix = (count($this->qb_where) === 0) ? $this->_group_get_type('') : $this->_group_get_type($type);
Andrey Andreev6e704752012-07-18 00:46:33 +0300804 $where_in = array(
Andrey Andreev94611df2012-07-19 12:29:54 +0300805 'condition' => $prefix.$key.$not.' IN('.implode(', ', $where_in).')',
Andrey Andreev6e704752012-07-18 00:46:33 +0300806 'escape' => $escape
807 );
Barry Mienydd671972010-10-04 16:33:58 +0200808
Andrey Andreev6e704752012-07-18 00:46:33 +0300809 $this->qb_where[] = $where_in;
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000810 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000811 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000812 $this->qb_cache_where[] = $where_in;
813 $this->qb_cache_exists[] = 'where';
Derek Allard2067d1a2008-11-13 22:59:24 +0000814 }
815
Derek Allard2067d1a2008-11-13 22:59:24 +0000816 return $this;
817 }
Barry Mienydd671972010-10-04 16:33:58 +0200818
Derek Allard2067d1a2008-11-13 22:59:24 +0000819 // --------------------------------------------------------------------
820
821 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200822 * LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000823 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200824 * Generates a %LIKE% portion of the query.
825 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000826 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200827 * @param mixed $field
828 * @param string $match
829 * @param string $side
830 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500831 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000832 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300833 public function like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000834 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300835 return $this->_like($field, $match, 'AND ', $side, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000836 }
837
838 // --------------------------------------------------------------------
839
840 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200841 * NOT LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000842 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200843 * Generates a NOT LIKE portion of the query.
844 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000845 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200846 * @param mixed $field
847 * @param string $match
848 * @param string $side
849 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500850 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000851 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300852 public function not_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000853 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300854 return $this->_like($field, $match, 'AND ', $side, 'NOT', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000855 }
Barry Mienydd671972010-10-04 16:33:58 +0200856
Derek Allard2067d1a2008-11-13 22:59:24 +0000857 // --------------------------------------------------------------------
858
859 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200860 * OR LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000861 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200862 * Generates a %LIKE% portion of the query.
863 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200865 * @param mixed $field
866 * @param string $match
867 * @param string $side
868 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500869 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000870 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300871 public function or_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000872 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300873 return $this->_like($field, $match, 'OR ', $side, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000874 }
875
876 // --------------------------------------------------------------------
877
878 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200879 * OR NOT LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000880 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200881 * Generates a NOT LIKE portion of the query.
882 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +0000883 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200884 * @param mixed $field
885 * @param string $match
886 * @param string $side
887 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500888 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000889 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300890 public function or_not_like($field, $match = '', $side = 'both', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000891 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300892 return $this->_like($field, $match, 'OR ', $side, 'NOT', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +0000893 }
Barry Mienydd671972010-10-04 16:33:58 +0200894
Derek Allard2067d1a2008-11-13 22:59:24 +0000895 // --------------------------------------------------------------------
896
897 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +0200898 * Internal LIKE
Derek Allard2067d1a2008-11-13 22:59:24 +0000899 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200900 * @used-by like()
901 * @used-by or_like()
902 * @used-by not_like()
903 * @used-by or_not_like()
Derek Allard2067d1a2008-11-13 22:59:24 +0000904 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200905 * @param mixed $field
906 * @param string $match
907 * @param string $type
908 * @param string $side
909 * @param string $not
910 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -0500911 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +0000912 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300913 protected function _like($field, $match = '', $type = 'AND ', $side = 'both', $not = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000914 {
915 if ( ! is_array($field))
916 {
917 $field = array($field => $match);
918 }
Barry Mienydd671972010-10-04 16:33:58 +0200919
Andrey Andreevb0478652012-07-18 15:34:46 +0300920 is_bool($escape) OR $escape = $this->_protect_identifiers;
Andrey Andreevb0478652012-07-18 15:34:46 +0300921
Derek Allard2067d1a2008-11-13 22:59:24 +0000922 foreach ($field as $k => $v)
923 {
Andrey Andreev41738232012-11-30 00:13:17 +0200924 $prefix = (count($this->qb_where) === 0 && count($this->qb_cache_where) === 0)
925 ? $this->_group_get_type('') : $this->_group_get_type($type);
926
Derek Jonese4ed5832009-02-20 21:44:59 +0000927 $v = $this->escape_like_str($v);
Andrey Andreevfc11dcc2012-06-04 16:39:19 +0300928
Andrey Andreev24276a32012-01-08 02:44:38 +0200929 if ($side === 'none')
Kyle Farris81ef70f2011-08-31 11:59:12 -0400930 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300931 $like_statement = "{$prefix} {$k} {$not} LIKE '{$v}'";
Kyle Farris81ef70f2011-08-31 11:59:12 -0400932 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200933 elseif ($side === 'before')
Derek Allard2067d1a2008-11-13 22:59:24 +0000934 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300935 $like_statement = "{$prefix} {$k} {$not} LIKE '%{$v}'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000936 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200937 elseif ($side === 'after')
Derek Allard2067d1a2008-11-13 22:59:24 +0000938 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300939 $like_statement = "{$prefix} {$k} {$not} LIKE '{$v}%'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000940 }
941 else
942 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300943 $like_statement = "{$prefix} {$k} {$not} LIKE '%{$v}%'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000944 }
Derek Jonesd10e8962010-03-02 17:10:36 -0600945
Derek Jonese4ed5832009-02-20 21:44:59 +0000946 // some platforms require an escape sequence definition for LIKE wildcards
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100947 if ($this->_like_escape_str !== '')
Derek Jonese4ed5832009-02-20 21:44:59 +0000948 {
Andrey Andreevb0478652012-07-18 15:34:46 +0300949 $like_statement .= sprintf($this->_like_escape_str, $this->_like_escape_chr);
Derek Jonese4ed5832009-02-20 21:44:59 +0000950 }
Derek Jonesd10e8962010-03-02 17:10:36 -0600951
Andrey Andreevb0478652012-07-18 15:34:46 +0300952 $this->qb_where[] = array('condition' => $like_statement, 'escape' => $escape);
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000953 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000954 {
Andrey Andreev55bbd722013-01-28 19:02:13 +0200955 $this->qb_cache_where[] = array('condition' => $like_statement, 'escape' => $escape);
Andrey Andreevededc4a2012-07-18 01:16:15 +0300956 $this->qb_cache_exists[] = 'where';
Derek Allard2067d1a2008-11-13 22:59:24 +0000957 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000958 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200959
Derek Allard2067d1a2008-11-13 22:59:24 +0000960 return $this;
961 }
Barry Mienydd671972010-10-04 16:33:58 +0200962
Derek Allard2067d1a2008-11-13 22:59:24 +0000963 // --------------------------------------------------------------------
964
965 /**
WanWizard7219c072011-12-28 14:09:05 +0100966 * Starts a query group.
967 *
Andrey Andreevae85eb42012-11-02 01:42:31 +0200968 * @param string $not (Internal use only)
969 * @param string $type (Internal use only)
Andrew Podner4296a652012-12-17 07:51:15 -0500970 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +0100971 */
972 public function group_start($not = '', $type = 'AND ')
973 {
974 $type = $this->_group_get_type($type);
WanWizard7219c072011-12-28 14:09:05 +0100975
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000976 $this->qb_where_group_started = TRUE;
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +0100977 $prefix = (count($this->qb_where) === 0 && count($this->qb_cache_where) === 0) ? '' : $type;
Andrey Andreev6e704752012-07-18 00:46:33 +0300978 $where = array(
979 'condition' => $prefix.$not.str_repeat(' ', ++$this->qb_where_group_count).' (',
980 'escape' => FALSE
981 );
WanWizard7219c072011-12-28 14:09:05 +0100982
Andrey Andreev6e704752012-07-18 00:46:33 +0300983 $this->qb_where[] = $where;
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000984 if ($this->qb_caching)
WanWizard7219c072011-12-28 14:09:05 +0100985 {
Andrey Andreev6e704752012-07-18 00:46:33 +0300986 $this->qb_cache_where[] = $where;
WanWizard7219c072011-12-28 14:09:05 +0100987 }
988
989 return $this;
990 }
991
992 // --------------------------------------------------------------------
993
994 /**
995 * Starts a query group, but ORs the group
996 *
Andrew Podner4296a652012-12-17 07:51:15 -0500997 * @return CI_DB_query_builder
WanWizard7219c072011-12-28 14:09:05 +0100998 */
999 public function or_group_start()
1000 {
1001 return $this->group_start('', 'OR ');
1002 }
1003
1004 // --------------------------------------------------------------------
1005
1006 /**
1007 * Starts a query group, but NOTs 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 not_group_start()
1012 {
1013 return $this->group_start('NOT ', 'AND ');
1014 }
1015
1016 // --------------------------------------------------------------------
1017
1018 /**
1019 * Starts a query group, but OR 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 or_not_group_start()
1024 {
1025 return $this->group_start('NOT ', 'OR ');
1026 }
1027
1028 // --------------------------------------------------------------------
1029
1030 /**
1031 * Ends a query 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 group_end()
1036 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001037 $this->qb_where_group_started = FALSE;
Andrey Andreev6e704752012-07-18 00:46:33 +03001038 $where = array(
1039 'condition' => str_repeat(' ', $this->qb_where_group_count--).')',
1040 'escape' => FALSE
1041 );
WanWizard7219c072011-12-28 14:09:05 +01001042
Andrey Andreev6e704752012-07-18 00:46:33 +03001043 $this->qb_where[] = $where;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001044 if ($this->qb_caching)
WanWizard7219c072011-12-28 14:09:05 +01001045 {
Andrey Andreev6e704752012-07-18 00:46:33 +03001046 $this->qb_cache_where[] = $where;
WanWizard7219c072011-12-28 14:09:05 +01001047 }
1048
WanWizard7219c072011-12-28 14:09:05 +01001049 return $this;
1050 }
1051
1052 // --------------------------------------------------------------------
1053
1054 /**
1055 * Group_get_type
1056 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001057 * @used-by group_start()
1058 * @used-by _like()
1059 * @used-by _wh()
1060 * @used-by _where_in()
WanWizard7219c072011-12-28 14:09:05 +01001061 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001062 * @param string $type
WanWizard7219c072011-12-28 14:09:05 +01001063 * @return string
1064 */
1065 protected function _group_get_type($type)
1066 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001067 if ($this->qb_where_group_started)
WanWizard7219c072011-12-28 14:09:05 +01001068 {
1069 $type = '';
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001070 $this->qb_where_group_started = FALSE;
WanWizard7219c072011-12-28 14:09:05 +01001071 }
1072
1073 return $type;
1074 }
1075
1076 // --------------------------------------------------------------------
1077
1078 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001079 * GROUP BY
1080 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001081 * @param string $by
1082 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -05001083 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001084 */
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001085 public function group_by($by, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001086 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001087 is_bool($escape) OR $escape = $this->_protect_identifiers;
1088
Derek Allard2067d1a2008-11-13 22:59:24 +00001089 if (is_string($by))
1090 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001091 $by = ($escape === TRUE)
1092 ? explode(',', $by)
1093 : array($by);
Derek Allard2067d1a2008-11-13 22:59:24 +00001094 }
Barry Mienydd671972010-10-04 16:33:58 +02001095
Derek Allard2067d1a2008-11-13 22:59:24 +00001096 foreach ($by as $val)
1097 {
1098 $val = trim($val);
Barry Mienydd671972010-10-04 16:33:58 +02001099
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001100 if ($val !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001101 {
Andrey Andreev96feb582012-07-19 13:12:34 +03001102 $val = array('field' => $val, 'escape' => $escape);
Barry Mienydd671972010-10-04 16:33:58 +02001103
Andrey Andreev96feb582012-07-19 13:12:34 +03001104 $this->qb_groupby[] = $val;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001105 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001106 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001107 $this->qb_cache_groupby[] = $val;
1108 $this->qb_cache_exists[] = 'groupby';
Derek Allard2067d1a2008-11-13 22:59:24 +00001109 }
1110 }
1111 }
Andrey Andreev24276a32012-01-08 02:44:38 +02001112
Derek Allard2067d1a2008-11-13 22:59:24 +00001113 return $this;
1114 }
1115
1116 // --------------------------------------------------------------------
1117
1118 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001119 * HAVING
Derek Allard2067d1a2008-11-13 22:59:24 +00001120 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001121 * Separates multiple calls with 'AND'.
Derek Allard2067d1a2008-11-13 22:59:24 +00001122 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001123 * @param string $key
1124 * @param string $value
1125 * @param bool $escape
Derek Allard2067d1a2008-11-13 22:59:24 +00001126 * @return object
1127 */
Andrey Andreev0bcf5902012-10-12 13:03:29 +03001128 public function having($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001129 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03001130 return $this->_wh('qb_having', $key, $value, 'AND ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001131 }
Barry Mienydd671972010-10-04 16:33:58 +02001132
Derek Allard2067d1a2008-11-13 22:59:24 +00001133 // --------------------------------------------------------------------
1134
1135 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001136 * OR HAVING
Derek Allard2067d1a2008-11-13 22:59:24 +00001137 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001138 * Separates multiple calls with 'OR'.
Derek Allard2067d1a2008-11-13 22:59:24 +00001139 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001140 * @param string $key
1141 * @param string $value
1142 * @param bool $escape
Derek Allard2067d1a2008-11-13 22:59:24 +00001143 * @return object
1144 */
Andrey Andreev0bcf5902012-10-12 13:03:29 +03001145 public function or_having($key, $value = NULL, $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001146 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03001147 return $this->_wh('qb_having', $key, $value, 'OR ', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001148 }
Barry Mienydd671972010-10-04 16:33:58 +02001149
Derek Allard2067d1a2008-11-13 22:59:24 +00001150 // --------------------------------------------------------------------
1151
1152 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001153 * ORDER BY
Derek Allard2067d1a2008-11-13 22:59:24 +00001154 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001155 * @param string $orderby
vlakoff9f8e2992013-09-08 14:05:04 +02001156 * @param string $direction ASC, DESC or RANDOM
Andrey Andreevae85eb42012-11-02 01:42:31 +02001157 * @param bool $escape
Andrew Podner4296a652012-12-17 07:51:15 -05001158 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001159 */
Andrey Andreevd24160c2012-06-16 03:21:20 +03001160 public function order_by($orderby, $direction = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001161 {
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001162 $direction = strtoupper(trim($direction));
Andrey Andreev2d486232012-07-19 14:46:51 +03001163
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001164 if ($direction === 'RANDOM')
Derek Allard2067d1a2008-11-13 22:59:24 +00001165 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001166 $direction = '';
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001167
1168 // Do we have a seed value?
1169 $orderby = ctype_digit((string) $orderby)
vlakoffe6c4d5b2013-09-08 13:54:57 +02001170 ? sprintf($this->_random_keyword[1], $orderby)
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001171 : $this->_random_keyword[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00001172 }
Andrey Andreev2d486232012-07-19 14:46:51 +03001173 elseif (empty($orderby))
Derek Allard2067d1a2008-11-13 22:59:24 +00001174 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001175 return $this;
1176 }
1177 elseif ($direction !== '')
1178 {
Andrey Andreev98e46cf2012-11-13 03:01:42 +02001179 $direction = in_array($direction, array('ASC', 'DESC'), TRUE) ? ' '.$direction : '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001180 }
Barry Mienydd671972010-10-04 16:33:58 +02001181
Andrey Andreevd24160c2012-06-16 03:21:20 +03001182 is_bool($escape) OR $escape = $this->_protect_identifiers;
Barry Mienydd671972010-10-04 16:33:58 +02001183
Andrey Andreev2d486232012-07-19 14:46:51 +03001184 if ($escape === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001185 {
Andrey Andreev93dd2f22012-10-24 10:09:18 +03001186 $qb_orderby[] = array('field' => $orderby, 'direction' => $direction, 'escape' => FALSE);
Andrey Andreev2d486232012-07-19 14:46:51 +03001187 }
1188 else
1189 {
1190 $qb_orderby = array();
1191 foreach (explode(',', $orderby) as $field)
Derek Allard2067d1a2008-11-13 22:59:24 +00001192 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001193 $qb_orderby[] = ($direction === '' && preg_match('/\s+(ASC|DESC)$/i', rtrim($field), $match, PREG_OFFSET_CAPTURE))
1194 ? array('field' => ltrim(substr($field, 0, $match[0][1])), 'direction' => ' '.$match[1][0], 'escape' => TRUE)
1195 : array('field' => trim($field), 'direction' => $direction, 'escape' => TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001196 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001197 }
Barry Mienydd671972010-10-04 16:33:58 +02001198
Andrey Andreev2d486232012-07-19 14:46:51 +03001199 $this->qb_orderby = array_merge($this->qb_orderby, $qb_orderby);
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001200 if ($this->qb_caching === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001201 {
Andrey Andreev2d486232012-07-19 14:46:51 +03001202 $this->qb_cache_orderby = array_merge($this->qb_cache_orderby, $qb_orderby);
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001203 $this->qb_cache_exists[] = 'orderby';
Derek Allard2067d1a2008-11-13 22:59:24 +00001204 }
1205
1206 return $this;
1207 }
Barry Mienydd671972010-10-04 16:33:58 +02001208
Derek Allard2067d1a2008-11-13 22:59:24 +00001209 // --------------------------------------------------------------------
1210
1211 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001212 * LIMIT
Derek Allard2067d1a2008-11-13 22:59:24 +00001213 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001214 * @param int $value LIMIT value
1215 * @param int $offset OFFSET value
Andrew Podner4296a652012-12-17 07:51:15 -05001216 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001217 */
Andrey Andreev4a587f52014-12-11 16:27:15 +02001218 public function limit($value, $offset = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001219 {
vlakoff912f1bc2013-01-15 03:34:12 +01001220 is_null($value) OR $this->qb_limit = (int) $value;
Andrey Andreev777153d2012-06-18 13:30:45 +03001221 empty($offset) OR $this->qb_offset = (int) $offset;
Barry Mienydd671972010-10-04 16:33:58 +02001222
Derek Allard2067d1a2008-11-13 22:59:24 +00001223 return $this;
1224 }
Barry Mienydd671972010-10-04 16:33:58 +02001225
Derek Allard2067d1a2008-11-13 22:59:24 +00001226 // --------------------------------------------------------------------
1227
1228 /**
1229 * Sets the OFFSET value
1230 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001231 * @param int $offset OFFSET value
Andrew Podner4296a652012-12-17 07:51:15 -05001232 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001233 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001234 public function offset($offset)
Derek Allard2067d1a2008-11-13 22:59:24 +00001235 {
Andrey Andreev777153d2012-06-18 13:30:45 +03001236 empty($offset) OR $this->qb_offset = (int) $offset;
Derek Allard2067d1a2008-11-13 22:59:24 +00001237 return $this;
1238 }
Barry Mienydd671972010-10-04 16:33:58 +02001239
Derek Allard2067d1a2008-11-13 22:59:24 +00001240 // --------------------------------------------------------------------
1241
1242 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001243 * LIMIT string
Andrey Andreev2c35b642012-06-24 03:05:26 +03001244 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001245 * Generates a platform-specific LIMIT clause.
Andrey Andreev2c35b642012-06-24 03:05:26 +03001246 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001247 * @param string $sql SQL Query
Andrey Andreev2c35b642012-06-24 03:05:26 +03001248 * @return string
1249 */
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001250 protected function _limit($sql)
Andrey Andreev2c35b642012-06-24 03:05:26 +03001251 {
Andrey Andreevc9b924c2012-07-19 13:06:02 +03001252 return $sql.' LIMIT '.($this->qb_offset ? $this->qb_offset.', ' : '').$this->qb_limit;
Andrey Andreev2c35b642012-06-24 03:05:26 +03001253 }
1254
1255 // --------------------------------------------------------------------
1256
1257 /**
Andrey Andreevfe642da2012-06-16 03:47:33 +03001258 * The "set" function.
1259 *
1260 * Allows key/value pairs to be set for inserting or updating
Derek Allard2067d1a2008-11-13 22:59:24 +00001261 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001262 * @param mixed
1263 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001264 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001265 * @return CI_DB_query_builder
Derek Allard2067d1a2008-11-13 22:59:24 +00001266 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001267 public function set($key, $value = '', $escape = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001268 {
1269 $key = $this->_object_to_array($key);
Barry Mienydd671972010-10-04 16:33:58 +02001270
Derek Allard2067d1a2008-11-13 22:59:24 +00001271 if ( ! is_array($key))
1272 {
1273 $key = array($key => $value);
Barry Mienydd671972010-10-04 16:33:58 +02001274 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001275
Andrey Andreevfe642da2012-06-16 03:47:33 +03001276 is_bool($escape) OR $escape = $this->_protect_identifiers;
1277
Derek Allard2067d1a2008-11-13 22:59:24 +00001278 foreach ($key as $k => $v)
1279 {
Andrey Andreevfe642da2012-06-16 03:47:33 +03001280 $this->qb_set[$this->protect_identifiers($k, FALSE, $escape)] = ($escape)
1281 ? $this->escape($v) : $v;
Derek Allard2067d1a2008-11-13 22:59:24 +00001282 }
Barry Mienydd671972010-10-04 16:33:58 +02001283
Derek Allard2067d1a2008-11-13 22:59:24 +00001284 return $this;
1285 }
WanWizard7219c072011-12-28 14:09:05 +01001286
Kyle Farris0c147b32011-08-26 02:29:31 -04001287 // --------------------------------------------------------------------
1288
1289 /**
1290 * Get SELECT query string
1291 *
1292 * Compiles a SELECT query string and returns the sql.
1293 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001294 * @param string the table name to select from (optional)
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01001295 * @param bool TRUE: resets QB values; FALSE: leave QB vaules alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001296 * @return string
1297 */
WanWizard7219c072011-12-28 14:09:05 +01001298 public function get_compiled_select($table = '', $reset = TRUE)
Kyle Farris0c147b32011-08-26 02:29:31 -04001299 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001300 if ($table !== '')
kylefarris0a3176b2011-08-26 02:37:52 -04001301 {
Kyle Farris0c147b32011-08-26 02:29:31 -04001302 $this->_track_aliases($table);
1303 $this->from($table);
1304 }
WanWizard7219c072011-12-28 14:09:05 +01001305
Andrey Andreev650b4c02012-06-11 12:07:15 +03001306 $select = $this->_compile_select();
WanWizard7219c072011-12-28 14:09:05 +01001307
Kyle Farris0c147b32011-08-26 02:29:31 -04001308 if ($reset === TRUE)
1309 {
1310 $this->_reset_select();
1311 }
WanWizard7219c072011-12-28 14:09:05 +01001312
Kyle Farris0c147b32011-08-26 02:29:31 -04001313 return $select;
1314 }
WanWizard7219c072011-12-28 14:09:05 +01001315
Derek Allard2067d1a2008-11-13 22:59:24 +00001316 // --------------------------------------------------------------------
1317
1318 /**
1319 * Get
1320 *
1321 * Compiles the select statement based on the other functions called
1322 * and runs the query
1323 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001324 * @param string the table
1325 * @param string the limit clause
1326 * @param string the offset clause
1327 * @return object
1328 */
Andrey Andreev650b4c02012-06-11 12:07:15 +03001329 public function get($table = '', $limit = NULL, $offset = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001330 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001331 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001332 {
1333 $this->_track_aliases($table);
1334 $this->from($table);
1335 }
Barry Mienydd671972010-10-04 16:33:58 +02001336
Andrey Andreev650b4c02012-06-11 12:07:15 +03001337 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00001338 {
1339 $this->limit($limit, $offset);
1340 }
Barry Mienydd671972010-10-04 16:33:58 +02001341
Andrey Andreev24276a32012-01-08 02:44:38 +02001342 $result = $this->query($this->_compile_select());
Derek Allard2067d1a2008-11-13 22:59:24 +00001343 $this->_reset_select();
1344 return $result;
1345 }
1346
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001347 // --------------------------------------------------------------------
1348
Derek Allard2067d1a2008-11-13 22:59:24 +00001349 /**
1350 * "Count All Results" query
1351 *
Barry Mienydd671972010-10-04 16:33:58 +02001352 * Generates a platform-specific query string that counts all records
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001353 * returned by an Query Builder query.
Derek Allard2067d1a2008-11-13 22:59:24 +00001354 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001355 * @param string
vlakoffc6ac7482013-11-17 00:50:06 +01001356 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +00001357 */
yaoshanliang5f8c0c12015-03-14 12:44:18 +08001358 public function count_all_results($table = '', $reset = true)
Derek Allard2067d1a2008-11-13 22:59:24 +00001359 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001360 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001361 {
1362 $this->_track_aliases($table);
1363 $this->from($table);
1364 }
Barry Mienydd671972010-10-04 16:33:58 +02001365
Andrey Andreevb05f5062012-10-26 12:01:02 +03001366 $result = ($this->qb_distinct === TRUE)
1367 ? $this->query($this->_count_string.$this->protect_identifiers('numrows')."\nFROM (\n".$this->_compile_select()."\n) CI_count_all_results")
1368 : $this->query($this->_compile_select($this->_count_string.$this->protect_identifiers('numrows')));
yaoshanliang9971e7b2015-03-14 13:09:16 +08001369
1370 if($reset)
1371 {
1372 $this->_reset_select();
1373 }
Barry Mienydd671972010-10-04 16:33:58 +02001374
Purwandi1d160e72012-01-09 16:33:28 +07001375 if ($result->num_rows() === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001376 {
Phil Sturgeonaf6f3442011-03-22 19:12:23 +00001377 return 0;
Derek Allard2067d1a2008-11-13 22:59:24 +00001378 }
1379
Purwandi1d160e72012-01-09 16:33:28 +07001380 $row = $result->row();
Phil Sturgeonaf6f3442011-03-22 19:12:23 +00001381 return (int) $row->numrows;
Derek Allard2067d1a2008-11-13 22:59:24 +00001382 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001383
Derek Allard2067d1a2008-11-13 22:59:24 +00001384 // --------------------------------------------------------------------
1385
1386 /**
1387 * Get_Where
1388 *
1389 * Allows the where clause, limit and offset to be added directly
1390 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001391 * @param string $table
1392 * @param string $where
1393 * @param int $limit
1394 * @param int $offset
Derek Allard2067d1a2008-11-13 22:59:24 +00001395 * @return object
1396 */
Andrey Andreeveb22d542012-06-26 23:16:35 +03001397 public function get_where($table = '', $where = NULL, $limit = NULL, $offset = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001398 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001399 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001400 {
1401 $this->from($table);
1402 }
1403
vlakoff1228fe22013-01-14 01:30:09 +01001404 if ($where !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001405 {
1406 $this->where($where);
1407 }
Barry Mienydd671972010-10-04 16:33:58 +02001408
Andrey Andreev650b4c02012-06-11 12:07:15 +03001409 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00001410 {
1411 $this->limit($limit, $offset);
1412 }
Barry Mienydd671972010-10-04 16:33:58 +02001413
Andrey Andreev24276a32012-01-08 02:44:38 +02001414 $result = $this->query($this->_compile_select());
Derek Allard2067d1a2008-11-13 22:59:24 +00001415 $this->_reset_select();
1416 return $result;
1417 }
1418
1419 // --------------------------------------------------------------------
1420
1421 /**
Derek Jonesd10e8962010-03-02 17:10:36 -06001422 * Insert_Batch
1423 *
1424 * Compiles batch insert strings and runs the queries
1425 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001426 * @param string $table Table to insert into
1427 * @param array $set An associative array of insert values
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001428 * @param bool $escape Whether to escape values and identifiers
Andrey Andreevae85eb42012-11-02 01:42:31 +02001429 * @return int Number of rows inserted or FALSE on failure
Derek Jonesd10e8962010-03-02 17:10:36 -06001430 */
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001431 public function insert_batch($table = '', $set = NULL, $escape = NULL)
Barry Mienydd671972010-10-04 16:33:58 +02001432 {
vlakoff1228fe22013-01-14 01:30:09 +01001433 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001434 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001435 $this->set_insert_batch($set, '', $escape);
Derek Jonesd10e8962010-03-02 17:10:36 -06001436 }
Barry Mienydd671972010-10-04 16:33:58 +02001437
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001438 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001439 {
Andrey Andreev9f808b02012-10-24 17:38:48 +03001440 // No valid data array. Folds in cases where keys and values did not match up
1441 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001442 }
1443
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001444 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001445 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001446 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001447 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001448 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001449 }
Barry Mienydd671972010-10-04 16:33:58 +02001450
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001451 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001452 }
1453
1454 // Batch this baby
Andrey Andreev9f808b02012-10-24 17:38:48 +03001455 $affected_rows = 0;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001456 for ($i = 0, $total = count($this->qb_set); $i < $total; $i += 100)
Derek Jonesd10e8962010-03-02 17:10:36 -06001457 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001458 $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 +03001459 $affected_rows += $this->affected_rows();
Derek Jonesd10e8962010-03-02 17:10:36 -06001460 }
Barry Mienydd671972010-10-04 16:33:58 +02001461
Derek Jonesd10e8962010-03-02 17:10:36 -06001462 $this->_reset_write();
Andrey Andreev9f808b02012-10-24 17:38:48 +03001463 return $affected_rows;
Derek Jonesd10e8962010-03-02 17:10:36 -06001464 }
1465
1466 // --------------------------------------------------------------------
1467
1468 /**
Andrey Andreev083e3c82012-11-06 12:48:32 +02001469 * Insert batch statement
Andrey Andreev97f36972012-04-05 12:44:36 +03001470 *
1471 * Generates a platform-specific insert string from the supplied data.
1472 *
Andrey Andreev083e3c82012-11-06 12:48:32 +02001473 * @param string $table Table name
1474 * @param array $keys INSERT keys
1475 * @param array $values INSERT values
Andrey Andreeva3bca8f2012-04-05 15:17:25 +03001476 * @return string
Andrey Andreev97f36972012-04-05 12:44:36 +03001477 */
1478 protected function _insert_batch($table, $keys, $values)
1479 {
Andrey Andreev65d537c2012-04-05 14:11:41 +03001480 return 'INSERT INTO '.$table.' ('.implode(', ', $keys).') VALUES '.implode(', ', $values);
Andrey Andreev97f36972012-04-05 12:44:36 +03001481 }
1482
1483 // --------------------------------------------------------------------
1484
1485 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001486 * The "set_insert_batch" function. Allows key/value pairs to be set for batch inserts
Derek Jonesd10e8962010-03-02 17:10:36 -06001487 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001488 * @param mixed
1489 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001490 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001491 * @return CI_DB_query_builder
Derek Jonesd10e8962010-03-02 17:10:36 -06001492 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001493 public function set_insert_batch($key, $value = '', $escape = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001494 {
1495 $key = $this->_object_to_array_batch($key);
Barry Mienydd671972010-10-04 16:33:58 +02001496
Derek Jonesd10e8962010-03-02 17:10:36 -06001497 if ( ! is_array($key))
1498 {
1499 $key = array($key => $value);
Barry Mienydd671972010-10-04 16:33:58 +02001500 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001501
Andrey Andreevfe642da2012-06-16 03:47:33 +03001502 is_bool($escape) OR $escape = $this->_protect_identifiers;
1503
Iban Eguia3c0a4522012-04-15 13:30:44 +02001504 $keys = array_keys($this->_object_to_array(current($key)));
Derek Jonesd10e8962010-03-02 17:10:36 -06001505 sort($keys);
1506
1507 foreach ($key as $row)
1508 {
Iban Eguia3c0a4522012-04-15 13:30:44 +02001509 $row = $this->_object_to_array($row);
Barry Mienydd671972010-10-04 16:33:58 +02001510 if (count(array_diff($keys, array_keys($row))) > 0 OR count(array_diff(array_keys($row), $keys)) > 0)
1511 {
1512 // batch function above returns an error on an empty array
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001513 $this->qb_set[] = array();
Barry Mienydd671972010-10-04 16:33:58 +02001514 return;
1515 }
Phil Sturgeond0ac1a22011-02-15 22:54:08 +00001516
Barry Mienydd671972010-10-04 16:33:58 +02001517 ksort($row); // puts $row in the same order as our keys
1518
Andrey Andreev650b4c02012-06-11 12:07:15 +03001519 if ($escape !== FALSE)
Derek Jonesd10e8962010-03-02 17:10:36 -06001520 {
1521 $clean = array();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001522 foreach ($row as $value)
Derek Jonesd10e8962010-03-02 17:10:36 -06001523 {
Barry Mienydd671972010-10-04 16:33:58 +02001524 $clean[] = $this->escape($value);
Derek Jonesd10e8962010-03-02 17:10:36 -06001525 }
1526
Andrey Andreev650b4c02012-06-11 12:07:15 +03001527 $row = $clean;
Barry Mienydd671972010-10-04 16:33:58 +02001528 }
Andrey Andreev650b4c02012-06-11 12:07:15 +03001529
Andrey Andreev838a9d62012-12-03 14:37:47 +02001530 $this->qb_set[] = '('.implode(',', $row).')';
Derek Jonesd10e8962010-03-02 17:10:36 -06001531 }
1532
1533 foreach ($keys as $k)
1534 {
Andrey Andreevfe642da2012-06-16 03:47:33 +03001535 $this->qb_keys[] = $this->protect_identifiers($k, FALSE, $escape);
Derek Jonesd10e8962010-03-02 17:10:36 -06001536 }
Barry Mienydd671972010-10-04 16:33:58 +02001537
Derek Jonesd10e8962010-03-02 17:10:36 -06001538 return $this;
1539 }
WanWizard7219c072011-12-28 14:09:05 +01001540
Kyle Farris0c147b32011-08-26 02:29:31 -04001541 // --------------------------------------------------------------------
1542
1543 /**
1544 * Get INSERT query string
1545 *
1546 * Compiles an insert query and returns the sql
1547 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001548 * @param string the table to insert into
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01001549 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001550 * @return string
1551 */
1552 public function get_compiled_insert($table = '', $reset = TRUE)
WanWizard7219c072011-12-28 14:09:05 +01001553 {
Kyle Farris0c147b32011-08-26 02:29:31 -04001554 if ($this->_validate_insert($table) === FALSE)
1555 {
1556 return FALSE;
1557 }
WanWizard7219c072011-12-28 14:09:05 +01001558
Kyle Farris76116012011-08-31 11:17:48 -04001559 $sql = $this->_insert(
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001560 $this->protect_identifiers(
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001561 $this->qb_from[0], TRUE, NULL, FALSE
Kyle Farris76116012011-08-31 11:17:48 -04001562 ),
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001563 array_keys($this->qb_set),
1564 array_values($this->qb_set)
Kyle Farris76116012011-08-31 11:17:48 -04001565 );
WanWizard7219c072011-12-28 14:09:05 +01001566
Kyle Farris0c147b32011-08-26 02:29:31 -04001567 if ($reset === TRUE)
1568 {
1569 $this->_reset_write();
1570 }
WanWizard7219c072011-12-28 14:09:05 +01001571
Kyle Farris0c147b32011-08-26 02:29:31 -04001572 return $sql;
1573 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001574
Derek Allard2067d1a2008-11-13 22:59:24 +00001575 // --------------------------------------------------------------------
1576
1577 /**
1578 * Insert
1579 *
1580 * Compiles an insert string and runs the query
1581 *
Phil Sturgeon9789f322011-07-15 15:14:05 -06001582 * @param string the table to insert data into
Derek Allard2067d1a2008-11-13 22:59:24 +00001583 * @param array an associative array of insert values
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001584 * @param bool $escape Whether to escape values and identifiers
Derek Allard2067d1a2008-11-13 22:59:24 +00001585 * @return object
1586 */
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001587 public function insert($table = '', $set = NULL, $escape = NULL)
Barry Mienydd671972010-10-04 16:33:58 +02001588 {
vlakoff1228fe22013-01-14 01:30:09 +01001589 if ($set !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001590 {
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001591 $this->set($set, '', $escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00001592 }
WanWizard7219c072011-12-28 14:09:05 +01001593
Kyle Farris0c147b32011-08-26 02:29:31 -04001594 if ($this->_validate_insert($table) === FALSE)
1595 {
1596 return FALSE;
1597 }
WanWizard7219c072011-12-28 14:09:05 +01001598
Kyle Farris76116012011-08-31 11:17:48 -04001599 $sql = $this->_insert(
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001600 $this->protect_identifiers(
Andrey Andreevbdd9c112012-11-06 12:07:16 +02001601 $this->qb_from[0], TRUE, $escape, FALSE
WanWizard7219c072011-12-28 14:09:05 +01001602 ),
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001603 array_keys($this->qb_set),
1604 array_values($this->qb_set)
Kyle Farris76116012011-08-31 11:17:48 -04001605 );
Barry Mienydd671972010-10-04 16:33:58 +02001606
Kyle Farris0c147b32011-08-26 02:29:31 -04001607 $this->_reset_write();
1608 return $this->query($sql);
1609 }
WanWizard7219c072011-12-28 14:09:05 +01001610
Kyle Farris0c147b32011-08-26 02:29:31 -04001611 // --------------------------------------------------------------------
1612
1613 /**
1614 * Validate Insert
1615 *
1616 * This method is used by both insert() and get_compiled_insert() to
1617 * validate that the there data is actually being set and that table
1618 * has been chosen to be inserted into.
1619 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001620 * @param string the table to insert data into
1621 * @return string
1622 */
WanWizard7219c072011-12-28 14:09:05 +01001623 protected function _validate_insert($table = '')
Kyle Farris0c147b32011-08-26 02:29:31 -04001624 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001625 if (count($this->qb_set) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001626 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001627 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001628 }
1629
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001630 if ($table !== '')
Kyle Farris0c147b32011-08-26 02:29:31 -04001631 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001632 $this->qb_from[0] = $table;
Kyle Farris0c147b32011-08-26 02:29:31 -04001633 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001634 elseif ( ! isset($this->qb_from[0]))
1635 {
1636 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
1637 }
WanWizard7219c072011-12-28 14:09:05 +01001638
Kyle Farris0c147b32011-08-26 02:29:31 -04001639 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001640 }
Barry Mienydd671972010-10-04 16:33:58 +02001641
Phil Sturgeon9789f322011-07-15 15:14:05 -06001642 // --------------------------------------------------------------------
1643
1644 /**
1645 * Replace
1646 *
1647 * Compiles an replace into string and runs the query
1648 *
1649 * @param string the table to replace data into
1650 * @param array an associative array of insert values
1651 * @return object
1652 */
1653 public function replace($table = '', $set = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001654 {
vlakoff1228fe22013-01-14 01:30:09 +01001655 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001656 {
1657 $this->set($set);
1658 }
Barry Mienydd671972010-10-04 16:33:58 +02001659
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001660 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001661 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001662 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001663 }
1664
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001665 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001666 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001667 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001668 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001669 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001670 }
Barry Mienydd671972010-10-04 16:33:58 +02001671
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001672 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001673 }
1674
Jamie Rumbelow0c092992012-03-06 22:05:16 +00001675 $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 +00001676
Derek Jonesd10e8962010-03-02 17:10:36 -06001677 $this->_reset_write();
Barry Mienydd671972010-10-04 16:33:58 +02001678 return $this->query($sql);
Derek Jonesd10e8962010-03-02 17:10:36 -06001679 }
WanWizard7219c072011-12-28 14:09:05 +01001680
Kyle Farris0c147b32011-08-26 02:29:31 -04001681 // --------------------------------------------------------------------
Derek Jonesd10e8962010-03-02 17:10:36 -06001682
Kyle Farris0c147b32011-08-26 02:29:31 -04001683 /**
Andrey Andreeva3bca8f2012-04-05 15:17:25 +03001684 * Replace statement
1685 *
1686 * Generates a platform-specific replace string from the supplied data
1687 *
1688 * @param string the table name
1689 * @param array the insert keys
1690 * @param array the insert values
1691 * @return string
1692 */
1693 protected function _replace($table, $keys, $values)
1694 {
1695 return 'REPLACE INTO '.$table.' ('.implode(', ', $keys).') VALUES ('.implode(', ', $values).')';
1696 }
1697
1698 // --------------------------------------------------------------------
1699
1700 /**
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001701 * FROM tables
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001702 *
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001703 * Groups tables in FROM clauses if needed, so there is no confusion
1704 * about operator precedence.
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001705 *
Claudio Galdiolo93e78132015-01-29 11:43:56 -05001706 * Note: This is only used (and overridden) by MySQL and CUBRID.
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001707 *
1708 * @return string
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001709 */
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001710 protected function _from_tables()
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001711 {
Andrey Andreev7eaa14f2012-10-09 11:34:01 +03001712 return implode(', ', $this->qb_from);
Andrey Andreevc78e56a2012-06-08 02:12:07 +03001713 }
1714
1715 // --------------------------------------------------------------------
1716
1717 /**
Kyle Farris0c147b32011-08-26 02:29:31 -04001718 * Get UPDATE query string
1719 *
1720 * Compiles an update query and returns the sql
1721 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001722 * @param string the table to update
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01001723 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04001724 * @return string
1725 */
1726 public function get_compiled_update($table = '', $reset = TRUE)
1727 {
1728 // Combine any cached components with the current statements
1729 $this->_merge_cache();
WanWizard7219c072011-12-28 14:09:05 +01001730
Kyle Farris0c147b32011-08-26 02:29:31 -04001731 if ($this->_validate_update($table) === FALSE)
1732 {
1733 return FALSE;
1734 }
WanWizard7219c072011-12-28 14:09:05 +01001735
Andrey Andreevb0478652012-07-18 15:34:46 +03001736 $sql = $this->_update($this->protect_identifiers($this->qb_from[0], TRUE, NULL, FALSE), $this->qb_set);
WanWizard7219c072011-12-28 14:09:05 +01001737
Kyle Farris0c147b32011-08-26 02:29:31 -04001738 if ($reset === TRUE)
1739 {
1740 $this->_reset_write();
1741 }
WanWizard7219c072011-12-28 14:09:05 +01001742
Kyle Farris0c147b32011-08-26 02:29:31 -04001743 return $sql;
1744 }
WanWizard7219c072011-12-28 14:09:05 +01001745
Derek Allard2067d1a2008-11-13 22:59:24 +00001746 // --------------------------------------------------------------------
1747
1748 /**
Andrey Andreevae85eb42012-11-02 01:42:31 +02001749 * UPDATE
Derek Allard2067d1a2008-11-13 22:59:24 +00001750 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001751 * Compiles an update string and runs the query.
Derek Allard2067d1a2008-11-13 22:59:24 +00001752 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02001753 * @param string $table
1754 * @param array $set An associative array of update values
1755 * @param mixed $where
1756 * @param int $limit
Derek Allard2067d1a2008-11-13 22:59:24 +00001757 * @return object
1758 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001759 public function update($table = '', $set = NULL, $where = NULL, $limit = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001760 {
1761 // Combine any cached components with the current statements
1762 $this->_merge_cache();
1763
vlakoff1228fe22013-01-14 01:30:09 +01001764 if ($set !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +00001765 {
1766 $this->set($set);
1767 }
Barry Mienydd671972010-10-04 16:33:58 +02001768
Kyle Farris0c147b32011-08-26 02:29:31 -04001769 if ($this->_validate_update($table) === FALSE)
1770 {
1771 return FALSE;
1772 }
1773
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001774 if ($where !== NULL)
Kyle Farris0c147b32011-08-26 02:29:31 -04001775 {
1776 $this->where($where);
1777 }
1778
Andrey Andreev650b4c02012-06-11 12:07:15 +03001779 if ( ! empty($limit))
Kyle Farris0c147b32011-08-26 02:29:31 -04001780 {
1781 $this->limit($limit);
1782 }
1783
Andrey Andreevb0478652012-07-18 15:34:46 +03001784 $sql = $this->_update($this->protect_identifiers($this->qb_from[0], TRUE, NULL, FALSE), $this->qb_set);
Kyle Farris0c147b32011-08-26 02:29:31 -04001785 $this->_reset_write();
1786 return $this->query($sql);
1787 }
WanWizard7219c072011-12-28 14:09:05 +01001788
Kyle Farris0c147b32011-08-26 02:29:31 -04001789 // --------------------------------------------------------------------
1790
1791 /**
1792 * Validate Update
1793 *
1794 * This method is used by both update() and get_compiled_update() to
1795 * validate that data is actually being set and that a table has been
1796 * chosen to be update.
1797 *
Kyle Farris0c147b32011-08-26 02:29:31 -04001798 * @param string the table to update data on
Andrey Andreev24276a32012-01-08 02:44:38 +02001799 * @return bool
Kyle Farris0c147b32011-08-26 02:29:31 -04001800 */
1801 protected function _validate_update($table = '')
1802 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001803 if (count($this->qb_set) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001804 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001805 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001806 }
1807
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001808 if ($table !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001809 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001810 $this->qb_from[0] = $table;
Derek Allard2067d1a2008-11-13 22:59:24 +00001811 }
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001812 elseif ( ! isset($this->qb_from[0]))
1813 {
1814 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
1815 }
Andrey Andreev24276a32012-01-08 02:44:38 +02001816
1817 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001818 }
WanWizard7219c072011-12-28 14:09:05 +01001819
Derek Jonesd10e8962010-03-02 17:10:36 -06001820 // --------------------------------------------------------------------
1821
1822 /**
1823 * Update_Batch
1824 *
1825 * Compiles an update string and runs the query
1826 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001827 * @param string the table to retrieve the results from
1828 * @param array an associative array of update values
1829 * @param string the where key
Andrey Andreev9f808b02012-10-24 17:38:48 +03001830 * @return int number of rows affected or FALSE on failure
Derek Jonesd10e8962010-03-02 17:10:36 -06001831 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001832 public function update_batch($table = '', $set = NULL, $index = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001833 {
1834 // Combine any cached components with the current statements
1835 $this->_merge_cache();
Barry Mienydd671972010-10-04 16:33:58 +02001836
vlakoff1228fe22013-01-14 01:30:09 +01001837 if ($index === NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001838 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001839 return ($this->db_debug) ? $this->display_error('db_must_use_index') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001840 }
1841
vlakoff1228fe22013-01-14 01:30:09 +01001842 if ($set !== NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001843 {
1844 $this->set_update_batch($set, $index);
1845 }
1846
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001847 if (count($this->qb_set) === 0)
Derek Jonesd10e8962010-03-02 17:10:36 -06001848 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001849 return ($this->db_debug) ? $this->display_error('db_must_use_set') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001850 }
1851
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001852 if ($table === '')
Derek Jonesd10e8962010-03-02 17:10:36 -06001853 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001854 if ( ! isset($this->qb_from[0]))
Derek Jonesd10e8962010-03-02 17:10:36 -06001855 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001856 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Jonesd10e8962010-03-02 17:10:36 -06001857 }
Barry Mienydd671972010-10-04 16:33:58 +02001858
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001859 $table = $this->qb_from[0];
Derek Jonesd10e8962010-03-02 17:10:36 -06001860 }
Barry Mienydd671972010-10-04 16:33:58 +02001861
Derek Jonesd10e8962010-03-02 17:10:36 -06001862 // Batch this baby
Andrey Andreev9f808b02012-10-24 17:38:48 +03001863 $affected_rows = 0;
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001864 for ($i = 0, $total = count($this->qb_set); $i < $total; $i += 100)
Derek Jonesd10e8962010-03-02 17:10:36 -06001865 {
Andrey Andreevb0478652012-07-18 15:34:46 +03001866 $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 +03001867 $affected_rows += $this->affected_rows();
Andrey Andreev79f888b2013-08-06 13:59:23 +03001868 $this->qb_where = array();
Derek Jonesd10e8962010-03-02 17:10:36 -06001869 }
Barry Mienydd671972010-10-04 16:33:58 +02001870
Derek Jonesd10e8962010-03-02 17:10:36 -06001871 $this->_reset_write();
Andrey Andreev9f808b02012-10-24 17:38:48 +03001872 return $affected_rows;
Derek Jonesd10e8962010-03-02 17:10:36 -06001873 }
1874
1875 // --------------------------------------------------------------------
1876
1877 /**
Andrey Andreev219565d2013-03-12 20:00:08 +02001878 * Update_Batch statement
1879 *
1880 * Generates a platform-specific batch update string from the supplied data
1881 *
1882 * @param string $table Table name
1883 * @param array $values Update data
1884 * @param string $index WHERE key
1885 * @return string
1886 */
1887 protected function _update_batch($table, $values, $index)
1888 {
1889 $ids = array();
1890 foreach ($values as $key => $val)
1891 {
1892 $ids[] = $val[$index];
1893
1894 foreach (array_keys($val) as $field)
1895 {
1896 if ($field !== $index)
1897 {
1898 $final[$field][] = 'WHEN '.$index.' = '.$val[$index].' THEN '.$val[$field];
1899 }
1900 }
1901 }
1902
1903 $cases = '';
1904 foreach ($final as $k => $v)
1905 {
1906 $cases .= $k." = CASE \n"
1907 .implode("\n", $v)."\n"
1908 .'ELSE '.$k.' END, ';
1909 }
1910
1911 $this->where($index.' IN('.implode(',', $ids).')', NULL, FALSE);
1912
1913 return 'UPDATE '.$table.' SET '.substr($cases, 0, -2).$this->_compile_wh('qb_where');
1914 }
1915
1916 // --------------------------------------------------------------------
1917
1918 /**
Derek Jones37f4b9c2011-07-01 17:56:50 -05001919 * The "set_update_batch" function. Allows key/value pairs to be set for batch updating
Derek Jonesd10e8962010-03-02 17:10:36 -06001920 *
Derek Jonesd10e8962010-03-02 17:10:36 -06001921 * @param array
1922 * @param string
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03001923 * @param bool
Andrew Podner4296a652012-12-17 07:51:15 -05001924 * @return CI_DB_query_builder
Derek Jonesd10e8962010-03-02 17:10:36 -06001925 */
Andrey Andreevfe642da2012-06-16 03:47:33 +03001926 public function set_update_batch($key, $index = '', $escape = NULL)
Derek Jonesd10e8962010-03-02 17:10:36 -06001927 {
1928 $key = $this->_object_to_array_batch($key);
Barry Mienydd671972010-10-04 16:33:58 +02001929
Derek Jonesd10e8962010-03-02 17:10:36 -06001930 if ( ! is_array($key))
1931 {
1932 // @todo error
Barry Mienydd671972010-10-04 16:33:58 +02001933 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001934
Andrey Andreevfe642da2012-06-16 03:47:33 +03001935 is_bool($escape) OR $escape = $this->_protect_identifiers;
1936
Derek Jonesd10e8962010-03-02 17:10:36 -06001937 foreach ($key as $k => $v)
1938 {
1939 $index_set = FALSE;
1940 $clean = array();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001941 foreach ($v as $k2 => $v2)
Derek Jonesd10e8962010-03-02 17:10:36 -06001942 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001943 if ($k2 === $index)
Derek Jonesd10e8962010-03-02 17:10:36 -06001944 {
1945 $index_set = TRUE;
1946 }
Derek Jonesd10e8962010-03-02 17:10:36 -06001947
Andrey Andreevfe642da2012-06-16 03:47:33 +03001948 $clean[$this->protect_identifiers($k2, FALSE, $escape)] = ($escape === FALSE) ? $v2 : $this->escape($v2);
Derek Jonesd10e8962010-03-02 17:10:36 -06001949 }
1950
Andrey Andreev7b5eb732012-05-24 20:52:41 +03001951 if ($index_set === FALSE)
Derek Jonesd10e8962010-03-02 17:10:36 -06001952 {
1953 return $this->display_error('db_batch_missing_index');
1954 }
1955
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001956 $this->qb_set[] = $clean;
Derek Jonesd10e8962010-03-02 17:10:36 -06001957 }
Barry Mienydd671972010-10-04 16:33:58 +02001958
Derek Jonesd10e8962010-03-02 17:10:36 -06001959 return $this;
1960 }
1961
Derek Allard2067d1a2008-11-13 22:59:24 +00001962 // --------------------------------------------------------------------
1963
1964 /**
1965 * Empty Table
1966 *
1967 * Compiles a delete string and runs "DELETE FROM table"
1968 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001969 * @param string the table to empty
1970 * @return object
1971 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06001972 public function empty_table($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001973 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001974 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001975 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001976 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00001977 {
Andrey Andreev24276a32012-01-08 02:44:38 +02001978 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001979 }
1980
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001981 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00001982 }
1983 else
1984 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001985 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001986 }
1987
1988 $sql = $this->_delete($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00001989 $this->_reset_write();
Derek Allard2067d1a2008-11-13 22:59:24 +00001990 return $this->query($sql);
1991 }
1992
1993 // --------------------------------------------------------------------
1994
1995 /**
1996 * Truncate
1997 *
1998 * Compiles a truncate string and runs the query
1999 * If the database does not support the truncate() command
2000 * This function maps to "DELETE FROM table"
2001 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002002 * @param string the table to truncate
2003 * @return object
2004 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002005 public function truncate($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002006 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002007 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002008 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002009 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00002010 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002011 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002012 }
2013
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002014 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00002015 }
2016 else
2017 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02002018 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00002019 }
2020
2021 $sql = $this->_truncate($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00002022 $this->_reset_write();
Derek Allard2067d1a2008-11-13 22:59:24 +00002023 return $this->query($sql);
2024 }
WanWizard7219c072011-12-28 14:09:05 +01002025
Kyle Farris0c147b32011-08-26 02:29:31 -04002026 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02002027
Kyle Farris0c147b32011-08-26 02:29:31 -04002028 /**
Andrey Andreeva6fe36e2012-04-05 16:00:32 +03002029 * Truncate statement
2030 *
2031 * Generates a platform-specific truncate string from the supplied data
2032 *
2033 * If the database does not support the truncate() command,
2034 * then this method maps to 'DELETE FROM table'
2035 *
2036 * @param string the table name
2037 * @return string
2038 */
2039 protected function _truncate($table)
2040 {
2041 return 'TRUNCATE '.$table;
2042 }
2043
2044 // --------------------------------------------------------------------
2045
2046 /**
Kyle Farris0c147b32011-08-26 02:29:31 -04002047 * Get DELETE query string
2048 *
2049 * Compiles a delete query string and returns the sql
2050 *
Kyle Farris0c147b32011-08-26 02:29:31 -04002051 * @param string the table to delete from
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002052 * @param bool TRUE: reset QB values; FALSE: leave QB values alone
Kyle Farris0c147b32011-08-26 02:29:31 -04002053 * @return string
2054 */
2055 public function get_compiled_delete($table = '', $reset = TRUE)
2056 {
2057 $this->return_delete_sql = TRUE;
2058 $sql = $this->delete($table, '', NULL, $reset);
2059 $this->return_delete_sql = FALSE;
2060 return $sql;
2061 }
WanWizard7219c072011-12-28 14:09:05 +01002062
Derek Allard2067d1a2008-11-13 22:59:24 +00002063 // --------------------------------------------------------------------
2064
2065 /**
2066 * Delete
2067 *
2068 * Compiles a delete string and runs the query
2069 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002070 * @param mixed the table(s) to delete from. String or array
2071 * @param mixed the where clause
2072 * @param mixed the limit clause
Andrey Andreeva8bb4be2012-03-26 15:54:23 +03002073 * @param bool
Andrey Andreev0bcf5902012-10-12 13:03:29 +03002074 * @return mixed
Derek Allard2067d1a2008-11-13 22:59:24 +00002075 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002076 public function delete($table = '', $where = '', $limit = NULL, $reset_data = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002077 {
2078 // Combine any cached components with the current statements
2079 $this->_merge_cache();
2080
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002081 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002082 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002083 if ( ! isset($this->qb_from[0]))
Derek Allard2067d1a2008-11-13 22:59:24 +00002084 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002085 return ($this->db_debug) ? $this->display_error('db_must_set_table') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00002086 }
2087
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002088 $table = $this->qb_from[0];
Derek Allard2067d1a2008-11-13 22:59:24 +00002089 }
2090 elseif (is_array($table))
2091 {
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05002092 foreach ($table as $single_table)
Derek Allard2067d1a2008-11-13 22:59:24 +00002093 {
Andrey Andreev13f50542012-10-12 12:31:02 +03002094 $this->delete($single_table, $where, $limit, $reset_data);
Derek Allard2067d1a2008-11-13 22:59:24 +00002095 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002096 return;
2097 }
2098 else
2099 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02002100 $table = $this->protect_identifiers($table, TRUE, NULL, FALSE);
Derek Allard2067d1a2008-11-13 22:59:24 +00002101 }
2102
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002103 if ($where !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002104 {
2105 $this->where($where);
2106 }
2107
Andrey Andreev650b4c02012-06-11 12:07:15 +03002108 if ( ! empty($limit))
Derek Allard2067d1a2008-11-13 22:59:24 +00002109 {
2110 $this->limit($limit);
2111 }
2112
Andrey Andreev94611df2012-07-19 12:29:54 +03002113 if (count($this->qb_where) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002114 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002115 return ($this->db_debug) ? $this->display_error('db_del_must_use_where') : FALSE;
Barry Mienydd671972010-10-04 16:33:58 +02002116 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002117
Andrey Andreevb0478652012-07-18 15:34:46 +03002118 $sql = $this->_delete($table);
Derek Allard2067d1a2008-11-13 22:59:24 +00002119 if ($reset_data)
2120 {
2121 $this->_reset_write();
2122 }
WanWizard7219c072011-12-28 14:09:05 +01002123
Andrey Andreev24276a32012-01-08 02:44:38 +02002124 return ($this->return_delete_sql === TRUE) ? $sql : $this->query($sql);
Derek Allard2067d1a2008-11-13 22:59:24 +00002125 }
WanWizard7219c072011-12-28 14:09:05 +01002126
Derek Allard2067d1a2008-11-13 22:59:24 +00002127 // --------------------------------------------------------------------
2128
2129 /**
Andrey Andreevc01d3162012-04-09 12:55:11 +03002130 * Delete statement
2131 *
2132 * Generates a platform-specific delete string from the supplied data
2133 *
2134 * @param string the table name
Andrey Andreevc01d3162012-04-09 12:55:11 +03002135 * @return string
2136 */
Andrey Andreevb0478652012-07-18 15:34:46 +03002137 protected function _delete($table)
Andrey Andreevc01d3162012-04-09 12:55:11 +03002138 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002139 return 'DELETE FROM '.$table.$this->_compile_wh('qb_where')
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002140 .($this->qb_limit ? ' LIMIT '.$this->qb_limit : '');
Andrey Andreevc01d3162012-04-09 12:55:11 +03002141 }
2142
2143 // --------------------------------------------------------------------
2144
2145 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002146 * DB Prefix
2147 *
2148 * Prepends a database prefix if one exists in configuration
2149 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002150 * @param string the table
2151 * @return string
2152 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002153 public function dbprefix($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002154 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002155 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00002156 {
2157 $this->display_error('db_table_name_required');
2158 }
2159
2160 return $this->dbprefix.$table;
2161 }
2162
2163 // --------------------------------------------------------------------
2164
2165 /**
Phil Sturgeon8a022472011-07-15 15:25:15 -06002166 * Set DB Prefix
2167 *
2168 * Set's the DB Prefix to something new without needing to reconnect
2169 *
2170 * @param string the prefix
2171 * @return string
2172 */
2173 public function set_dbprefix($prefix = '')
2174 {
2175 return $this->dbprefix = $prefix;
2176 }
2177
2178 // --------------------------------------------------------------------
2179
2180 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002181 * Track Aliases
2182 *
2183 * Used to track SQL statements written with aliased tables.
2184 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002185 * @param string The table to inspect
2186 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02002187 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002188 protected function _track_aliases($table)
Derek Allard2067d1a2008-11-13 22:59:24 +00002189 {
2190 if (is_array($table))
2191 {
2192 foreach ($table as $t)
2193 {
2194 $this->_track_aliases($t);
2195 }
2196 return;
2197 }
Barry Mienydd671972010-10-04 16:33:58 +02002198
Derek Jones37f4b9c2011-07-01 17:56:50 -05002199 // Does the string contain a comma? If so, we need to separate
Derek Allard2067d1a2008-11-13 22:59:24 +00002200 // the string into discreet statements
2201 if (strpos($table, ',') !== FALSE)
2202 {
2203 return $this->_track_aliases(explode(',', $table));
2204 }
Barry Mienydd671972010-10-04 16:33:58 +02002205
Derek Allard2067d1a2008-11-13 22:59:24 +00002206 // if a table alias is used we can recognize it by a space
Andrey Andreev24276a32012-01-08 02:44:38 +02002207 if (strpos($table, ' ') !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002208 {
2209 // if the alias is written with the AS keyword, remove it
Andrey Andreev5a257182012-06-10 06:18:14 +03002210 $table = preg_replace('/\s+AS\s+/i', ' ', $table);
Barry Mienydd671972010-10-04 16:33:58 +02002211
Derek Allard2067d1a2008-11-13 22:59:24 +00002212 // Grab the alias
Andrey Andreev24276a32012-01-08 02:44:38 +02002213 $table = trim(strrchr($table, ' '));
Barry Mienydd671972010-10-04 16:33:58 +02002214
Derek Allard2067d1a2008-11-13 22:59:24 +00002215 // Store the alias, if it doesn't already exist
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002216 if ( ! in_array($table, $this->qb_aliased_tables))
Derek Allard2067d1a2008-11-13 22:59:24 +00002217 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002218 $this->qb_aliased_tables[] = $table;
Derek Allard2067d1a2008-11-13 22:59:24 +00002219 }
2220 }
2221 }
WanWizard7219c072011-12-28 14:09:05 +01002222
Derek Allard2067d1a2008-11-13 22:59:24 +00002223 // --------------------------------------------------------------------
2224
2225 /**
2226 * Compile the SELECT statement
2227 *
2228 * Generates a query string based on which functions were used.
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03002229 * Should not be called directly.
Derek Allard2067d1a2008-11-13 22:59:24 +00002230 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02002231 * @param bool $select_override
Derek Allard2067d1a2008-11-13 22:59:24 +00002232 * @return string
2233 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002234 protected function _compile_select($select_override = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00002235 {
2236 // Combine any cached components with the current statements
2237 $this->_merge_cache();
2238
Derek Allard2067d1a2008-11-13 22:59:24 +00002239 // Write the "select" portion of the query
Derek Allard2067d1a2008-11-13 22:59:24 +00002240 if ($select_override !== FALSE)
2241 {
2242 $sql = $select_override;
2243 }
2244 else
2245 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002246 $sql = ( ! $this->qb_distinct) ? 'SELECT ' : 'SELECT DISTINCT ';
Barry Mienydd671972010-10-04 16:33:58 +02002247
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002248 if (count($this->qb_select) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002249 {
Barry Mienydd671972010-10-04 16:33:58 +02002250 $sql .= '*';
Derek Allard2067d1a2008-11-13 22:59:24 +00002251 }
2252 else
Barry Mienydd671972010-10-04 16:33:58 +02002253 {
Derek Allard2067d1a2008-11-13 22:59:24 +00002254 // Cycle through the "select" portion of the query and prep each column name.
2255 // The reason we protect identifiers here rather then in the select() function
2256 // is because until the user calls the from() function we don't know if there are aliases
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002257 foreach ($this->qb_select as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00002258 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002259 $no_escape = isset($this->qb_no_escape[$key]) ? $this->qb_no_escape[$key] : NULL;
Jamie Rumbelow0c092992012-03-06 22:05:16 +00002260 $this->qb_select[$key] = $this->protect_identifiers($val, FALSE, $no_escape);
Derek Allard2067d1a2008-11-13 22:59:24 +00002261 }
Barry Mienydd671972010-10-04 16:33:58 +02002262
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002263 $sql .= implode(', ', $this->qb_select);
Derek Allard2067d1a2008-11-13 22:59:24 +00002264 }
2265 }
2266
Derek Allard2067d1a2008-11-13 22:59:24 +00002267 // Write the "FROM" portion of the query
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002268 if (count($this->qb_from) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002269 {
Andrey Andreeve78f8152012-10-09 11:38:38 +03002270 $sql .= "\nFROM ".$this->_from_tables();
Derek Allard2067d1a2008-11-13 22:59:24 +00002271 }
2272
Derek Allard2067d1a2008-11-13 22:59:24 +00002273 // Write the "JOIN" portion of the query
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002274 if (count($this->qb_join) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002275 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002276 $sql .= "\n".implode("\n", $this->qb_join);
Derek Allard2067d1a2008-11-13 22:59:24 +00002277 }
2278
Andrey Andreev2d486232012-07-19 14:46:51 +03002279 $sql .= $this->_compile_wh('qb_where')
2280 .$this->_compile_group_by()
2281 .$this->_compile_wh('qb_having')
2282 .$this->_compile_order_by(); // ORDER BY
Andrey Andreevb0478652012-07-18 15:34:46 +03002283
Andrey Andreevd40459d2012-07-18 16:46:39 +03002284 // LIMIT
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002285 if ($this->qb_limit)
Derek Allard2067d1a2008-11-13 22:59:24 +00002286 {
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002287 return $this->_limit($sql."\n");
Derek Allard2067d1a2008-11-13 22:59:24 +00002288 }
2289
2290 return $sql;
2291 }
2292
2293 // --------------------------------------------------------------------
2294
2295 /**
Andrey Andreevd40459d2012-07-18 16:46:39 +03002296 * Compile WHERE, HAVING statements
Andrey Andreev6e704752012-07-18 00:46:33 +03002297 *
Andrey Andreevd40459d2012-07-18 16:46:39 +03002298 * Escapes identifiers in WHERE and HAVING statements at execution time.
2299 *
Andrey Andreevb0478652012-07-18 15:34:46 +03002300 * Required so that aliases are tracked properly, regardless of wether
Andrey Andreevd40459d2012-07-18 16:46:39 +03002301 * where(), or_where(), having(), or_having are called prior to from(),
2302 * join() and dbprefix is added only if needed.
Andrey Andreev6e704752012-07-18 00:46:33 +03002303 *
Andrey Andreevae85eb42012-11-02 01:42:31 +02002304 * @param string $qb_key 'qb_where' or 'qb_having'
Andrey Andreevd40459d2012-07-18 16:46:39 +03002305 * @return string SQL statement
Andrey Andreev6e704752012-07-18 00:46:33 +03002306 */
Andrey Andreevd40459d2012-07-18 16:46:39 +03002307 protected function _compile_wh($qb_key)
Andrey Andreev6e704752012-07-18 00:46:33 +03002308 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002309 if (count($this->$qb_key) > 0)
Andrey Andreev6e704752012-07-18 00:46:33 +03002310 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002311 for ($i = 0, $c = count($this->$qb_key); $i < $c; $i++)
Andrey Andreev6e704752012-07-18 00:46:33 +03002312 {
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002313 // Is this condition already compiled?
2314 if (is_string($this->{$qb_key}[$i]))
2315 {
2316 continue;
2317 }
2318 elseif ($this->{$qb_key}[$i]['escape'] === FALSE)
Andrey Andreev6e704752012-07-18 00:46:33 +03002319 {
Andrey Andreevd40459d2012-07-18 16:46:39 +03002320 $this->{$qb_key}[$i] = $this->{$qb_key}[$i]['condition'];
Andrey Andreev6e704752012-07-18 00:46:33 +03002321 continue;
2322 }
2323
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002324 // Split multiple conditions
2325 $conditions = preg_split(
Andrey Andreev5078eb52014-12-02 01:11:54 +02002326 '/(\s*AND\s+|\s*OR\s+)/i',
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002327 $this->{$qb_key}[$i]['condition'],
2328 -1,
2329 PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
2330 );
2331
2332 for ($ci = 0, $cc = count($conditions); $ci < $cc; $ci++)
Andrey Andreev6e704752012-07-18 00:46:33 +03002333 {
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002334 if (($op = $this->_get_operator($conditions[$ci])) === FALSE
Andrey Andreeve4742582012-10-25 13:25:13 +03002335 OR ! preg_match('/^(\(?)(.*)('.preg_quote($op, '/').')\s*(.*(?<!\)))?(\)?)$/i', $conditions[$ci], $matches))
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002336 {
2337 continue;
2338 }
2339
2340 // $matches = array(
2341 // 0 => '(test <= foo)', /* the whole thing */
2342 // 1 => '(', /* optional */
2343 // 2 => 'test', /* the field name */
2344 // 3 => ' <= ', /* $op */
2345 // 4 => 'foo', /* optional, if $op is e.g. 'IS NULL' */
2346 // 5 => ')' /* optional */
2347 // );
Andrey Andreev082aa402012-10-22 19:41:55 +03002348
2349 if ( ! empty($matches[4]))
2350 {
2351 $this->_is_literal($matches[4]) OR $matches[4] = $this->protect_identifiers(trim($matches[4]));
2352 $matches[4] = ' '.$matches[4];
2353 }
2354
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002355 $conditions[$ci] = $matches[1].$this->protect_identifiers(trim($matches[2]))
2356 .' '.trim($matches[3]).$matches[4].$matches[5];
Andrey Andreev6e704752012-07-18 00:46:33 +03002357 }
2358
Andrey Andreevf2ec8b82012-10-12 14:01:13 +03002359 $this->{$qb_key}[$i] = implode('', $conditions);
Andrey Andreev6e704752012-07-18 00:46:33 +03002360 }
2361
Andrey Andreev9d3aa1b2012-10-12 12:14:09 +03002362 return ($qb_key === 'qb_having' ? "\nHAVING " : "\nWHERE ")
2363 .implode("\n", $this->$qb_key);
Andrey Andreev6e704752012-07-18 00:46:33 +03002364 }
2365
Andrey Andreevb0478652012-07-18 15:34:46 +03002366 return '';
Andrey Andreev6e704752012-07-18 00:46:33 +03002367 }
2368
2369 // --------------------------------------------------------------------
2370
2371 /**
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002372 * Compile GROUP BY
2373 *
2374 * Escapes identifiers in GROUP BY statements at execution time.
2375 *
2376 * Required so that aliases are tracked properly, regardless of wether
2377 * group_by() is called prior to from(), join() and dbprefix is added
2378 * only if needed.
2379 *
2380 * @return string SQL statement
2381 */
2382 protected function _compile_group_by()
2383 {
2384 if (count($this->qb_groupby) > 0)
2385 {
Andrey Andreev96feb582012-07-19 13:12:34 +03002386 for ($i = 0, $c = count($this->qb_groupby); $i < $c; $i++)
2387 {
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002388 // Is it already compiled?
Andrey Andreev18eba242014-01-23 22:52:31 +02002389 if (is_string($this->qb_groupby[$i]))
Andrey Andreev5e3d48c2013-10-29 14:36:18 +02002390 {
2391 continue;
2392 }
2393
Andrey Andreev082aa402012-10-22 19:41:55 +03002394 $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 +03002395 ? $this->qb_groupby[$i]['field']
Andrey Andreev13f50542012-10-12 12:31:02 +03002396 : $this->protect_identifiers($this->qb_groupby[$i]['field']);
Andrey Andreev96feb582012-07-19 13:12:34 +03002397 }
2398
Andrey Andreev0bcf5902012-10-12 13:03:29 +03002399 return "\nGROUP BY ".implode(', ', $this->qb_groupby);
Andrey Andreevc9b924c2012-07-19 13:06:02 +03002400 }
2401
2402 return '';
2403 }
2404
2405 // --------------------------------------------------------------------
2406
2407 /**
Andrey Andreev2d486232012-07-19 14:46:51 +03002408 * Compile ORDER BY
2409 *
2410 * Escapes identifiers in ORDER BY statements at execution time.
2411 *
2412 * Required so that aliases are tracked properly, regardless of wether
2413 * order_by() is called prior to from(), join() and dbprefix is added
2414 * only if needed.
2415 *
2416 * @return string SQL statement
2417 */
2418 protected function _compile_order_by()
2419 {
Andrey Andreeva53ea842012-10-23 12:44:09 +03002420 if (is_array($this->qb_orderby) && count($this->qb_orderby) > 0)
Andrey Andreev2d486232012-07-19 14:46:51 +03002421 {
Andrey Andreev2d486232012-07-19 14:46:51 +03002422 for ($i = 0, $c = count($this->qb_orderby); $i < $c; $i++)
2423 {
Andrey Andreev082aa402012-10-22 19:41:55 +03002424 if ($this->qb_orderby[$i]['escape'] !== FALSE && ! $this->_is_literal($this->qb_orderby[$i]['field']))
Andrey Andreev2d486232012-07-19 14:46:51 +03002425 {
Andrey Andreevfc043b32012-10-12 14:46:14 +03002426 $this->qb_orderby[$i]['field'] = $this->protect_identifiers($this->qb_orderby[$i]['field']);
Andrey Andreev2d486232012-07-19 14:46:51 +03002427 }
2428
2429 $this->qb_orderby[$i] = $this->qb_orderby[$i]['field'].$this->qb_orderby[$i]['direction'];
2430 }
2431
Andrey Andreeva53ea842012-10-23 12:44:09 +03002432 return $this->qb_orderby = "\nORDER BY ".implode(', ', $this->qb_orderby);
2433 }
2434 elseif (is_string($this->qb_orderby))
2435 {
2436 return $this->qb_orderby;
Andrey Andreev2d486232012-07-19 14:46:51 +03002437 }
2438
2439 return '';
2440 }
2441
2442 // --------------------------------------------------------------------
2443
2444 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00002445 * Object to Array
2446 *
2447 * Takes an object as input and converts the class variables to array key/vals
2448 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002449 * @param object
2450 * @return array
2451 */
Andrey Andreev7b5eb732012-05-24 20:52:41 +03002452 protected function _object_to_array($object)
Derek Allard2067d1a2008-11-13 22:59:24 +00002453 {
2454 if ( ! is_object($object))
2455 {
2456 return $object;
2457 }
Barry Mienydd671972010-10-04 16:33:58 +02002458
Derek Allard2067d1a2008-11-13 22:59:24 +00002459 $array = array();
2460 foreach (get_object_vars($object) as $key => $val)
2461 {
2462 // There are some built in keys we need to ignore for this conversion
Alex Bilbie48a2baf2012-06-02 11:09:54 +01002463 if ( ! is_object($val) && ! is_array($val) && $key !== '_parent_name')
Derek Allard2067d1a2008-11-13 22:59:24 +00002464 {
2465 $array[$key] = $val;
2466 }
2467 }
Derek Jonesd10e8962010-03-02 17:10:36 -06002468
2469 return $array;
2470 }
Barry Mienydd671972010-10-04 16:33:58 +02002471
Derek Jonesd10e8962010-03-02 17:10:36 -06002472 // --------------------------------------------------------------------
2473
2474 /**
2475 * Object to Array
2476 *
2477 * Takes an object as input and converts the class variables to array key/vals
2478 *
Derek Jonesd10e8962010-03-02 17:10:36 -06002479 * @param object
2480 * @return array
2481 */
Andrey Andreev7b5eb732012-05-24 20:52:41 +03002482 protected function _object_to_array_batch($object)
Derek Jonesd10e8962010-03-02 17:10:36 -06002483 {
2484 if ( ! is_object($object))
2485 {
2486 return $object;
2487 }
Barry Mienydd671972010-10-04 16:33:58 +02002488
Derek Jonesd10e8962010-03-02 17:10:36 -06002489 $array = array();
2490 $out = get_object_vars($object);
2491 $fields = array_keys($out);
2492
2493 foreach ($fields as $val)
2494 {
2495 // There are some built in keys we need to ignore for this conversion
Andrey Andreev24276a32012-01-08 02:44:38 +02002496 if ($val !== '_parent_name')
Derek Jonesd10e8962010-03-02 17:10:36 -06002497 {
Derek Jonesd10e8962010-03-02 17:10:36 -06002498 $i = 0;
2499 foreach ($out[$val] as $data)
2500 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002501 $array[$i++][$val] = $data;
Derek Jonesd10e8962010-03-02 17:10:36 -06002502 }
2503 }
2504 }
2505
Derek Allard2067d1a2008-11-13 22:59:24 +00002506 return $array;
2507 }
Barry Mienydd671972010-10-04 16:33:58 +02002508
Derek Allard2067d1a2008-11-13 22:59:24 +00002509 // --------------------------------------------------------------------
2510
2511 /**
2512 * Start Cache
2513 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002514 * Starts QB caching
Derek Allard2067d1a2008-11-13 22:59:24 +00002515 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002516 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002517 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002518 public function start_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002519 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002520 $this->qb_caching = TRUE;
Andrey Andreev4a587f52014-12-11 16:27:15 +02002521 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002522 }
2523
2524 // --------------------------------------------------------------------
2525
2526 /**
2527 * Stop Cache
2528 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002529 * Stops QB caching
Derek Allard2067d1a2008-11-13 22:59:24 +00002530 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002531 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002532 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002533 public function stop_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002534 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002535 $this->qb_caching = FALSE;
Andrey Andreev4a587f52014-12-11 16:27:15 +02002536 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002537 }
2538
2539 // --------------------------------------------------------------------
2540
2541 /**
2542 * Flush Cache
2543 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002544 * Empties the QB cache
Derek Allard2067d1a2008-11-13 22:59:24 +00002545 *
Andrey Andreev4a587f52014-12-11 16:27:15 +02002546 * @return CI_DB_query_builder
Barry Mienydd671972010-10-04 16:33:58 +02002547 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002548 public function flush_cache()
Barry Mienydd671972010-10-04 16:33:58 +02002549 {
Phil Sturgeon9789f322011-07-15 15:14:05 -06002550 $this->_reset_run(array(
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002551 'qb_cache_select' => array(),
2552 'qb_cache_from' => array(),
2553 'qb_cache_join' => array(),
2554 'qb_cache_where' => array(),
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002555 'qb_cache_groupby' => array(),
2556 'qb_cache_having' => array(),
2557 'qb_cache_orderby' => array(),
2558 'qb_cache_set' => array(),
2559 'qb_cache_exists' => array(),
2560 'qb_cache_no_escape' => array()
Phil Sturgeon9789f322011-07-15 15:14:05 -06002561 ));
Andrey Andreev4a587f52014-12-11 16:27:15 +02002562
2563 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00002564 }
2565
2566 // --------------------------------------------------------------------
2567
2568 /**
2569 * Merge Cache
2570 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002571 * When called, this function merges any cached QB arrays with
Derek Allard2067d1a2008-11-13 22:59:24 +00002572 * locally called ones.
2573 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002574 * @return void
2575 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002576 protected function _merge_cache()
Derek Allard2067d1a2008-11-13 22:59:24 +00002577 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002578 if (count($this->qb_cache_exists) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002579 {
2580 return;
2581 }
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002582 elseif (in_array('select', $this->qb_cache_exists, TRUE))
2583 {
2584 $qb_no_escape = $this->qb_cache_no_escape;
2585 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002586
GDmac17a05282013-11-11 13:18:09 +01002587 foreach (array_unique($this->qb_cache_exists) as $val) // select, from, etc.
Derek Allard2067d1a2008-11-13 22:59:24 +00002588 {
Jamie Rumbelowae123e02012-02-21 16:39:56 +00002589 $qb_variable = 'qb_'.$val;
2590 $qb_cache_var = 'qb_cache_'.$val;
Andrey Andreev35e3b0b2013-11-12 16:07:08 +02002591 $qb_new = $this->$qb_cache_var;
GDmace1b86832013-11-08 16:52:54 +01002592
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002593 for ($i = 0, $c = count($this->$qb_variable); $i < $c; $i++)
Derek Allard2067d1a2008-11-13 22:59:24 +00002594 {
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002595 if ( ! in_array($this->{$qb_variable}[$i], $qb_new, TRUE))
2596 {
2597 $qb_new[] = $this->{$qb_variable}[$i];
2598 if ($val === 'select')
2599 {
2600 $qb_no_escape[] = $this->qb_no_escape[$i];
2601 }
2602 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002603 }
Andrey Andreev35e3b0b2013-11-12 16:07:08 +02002604
GDmace1b86832013-11-08 16:52:54 +01002605 $this->$qb_variable = $qb_new;
Andrey Andreev1720a6a2014-01-06 13:50:05 +02002606 if ($val === 'select')
2607 {
2608 $this->qb_no_escape = $qb_no_escape;
2609 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002610 }
2611
2612 // If we are "protecting identifiers" we need to examine the "from"
2613 // portion of the query to determine if there are any aliases
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002614 if ($this->_protect_identifiers === TRUE && count($this->qb_cache_from) > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00002615 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002616 $this->_track_aliases($this->qb_from);
Derek Allard2067d1a2008-11-13 22:59:24 +00002617 }
2618 }
WanWizard7219c072011-12-28 14:09:05 +01002619
Kyle Farris0c147b32011-08-26 02:29:31 -04002620 // --------------------------------------------------------------------
2621
2622 /**
Andrey Andreev082aa402012-10-22 19:41:55 +03002623 * Is literal
2624 *
2625 * Determines if a string represents a literal value or a field name
2626 *
Andrey Andreev02e4cd72012-11-13 11:50:47 +02002627 * @param string $str
Andrey Andreev082aa402012-10-22 19:41:55 +03002628 * @return bool
2629 */
2630 protected function _is_literal($str)
2631 {
2632 $str = trim($str);
2633
Andrey Andreev3a5efc22012-11-20 21:18:08 +02002634 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 +03002635 {
2636 return TRUE;
2637 }
2638
2639 static $_str;
2640
2641 if (empty($_str))
2642 {
2643 $_str = ($this->_escape_char !== '"')
2644 ? array('"', "'") : array("'");
2645 }
2646
Andrey Andreev3a5efc22012-11-20 21:18:08 +02002647 return in_array($str[0], $_str, TRUE);
Andrey Andreev082aa402012-10-22 19:41:55 +03002648 }
2649
2650 // --------------------------------------------------------------------
2651
2652 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002653 * Reset Query Builder values.
WanWizard7219c072011-12-28 14:09:05 +01002654 *
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00002655 * Publicly-visible method to reset the QB values.
Kyle Farris0c147b32011-08-26 02:29:31 -04002656 *
Andrey Andreev435e0c22014-12-11 16:30:13 +02002657 * @return CI_DB_query_builder
Kyle Farris0c147b32011-08-26 02:29:31 -04002658 */
2659 public function reset_query()
2660 {
2661 $this->_reset_select();
2662 $this->_reset_write();
Andrey Andreev435e0c22014-12-11 16:30:13 +02002663 return $this;
Kyle Farris0c147b32011-08-26 02:29:31 -04002664 }
Derek Allard2067d1a2008-11-13 22:59:24 +00002665
2666 // --------------------------------------------------------------------
2667
2668 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002669 * Resets the query builder values. Called by the get() function
Derek Allard2067d1a2008-11-13 22:59:24 +00002670 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002671 * @param array An array of fields to reset
2672 * @return void
2673 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002674 protected function _reset_run($qb_reset_items)
Derek Allard2067d1a2008-11-13 22:59:24 +00002675 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002676 foreach ($qb_reset_items as $item => $default_value)
Derek Allard2067d1a2008-11-13 22:59:24 +00002677 {
Andrey Andreevae85eb42012-11-02 01:42:31 +02002678 $this->$item = $default_value;
Derek Allard2067d1a2008-11-13 22:59:24 +00002679 }
2680 }
2681
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 * @return void
2688 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002689 protected function _reset_select()
Derek Allard2067d1a2008-11-13 22:59:24 +00002690 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002691 $this->_reset_run(array(
Andrey Andreev4a587f52014-12-11 16:27:15 +02002692 'qb_select' => array(),
2693 'qb_from' => array(),
2694 'qb_join' => array(),
2695 'qb_where' => array(),
2696 'qb_groupby' => array(),
2697 'qb_having' => array(),
2698 'qb_orderby' => array(),
2699 'qb_aliased_tables' => array(),
2700 'qb_no_escape' => array(),
2701 'qb_distinct' => FALSE,
2702 'qb_limit' => FALSE,
2703 'qb_offset' => FALSE
2704 ));
Derek Allard2067d1a2008-11-13 22:59:24 +00002705 }
Barry Mienydd671972010-10-04 16:33:58 +02002706
Derek Allard2067d1a2008-11-13 22:59:24 +00002707 // --------------------------------------------------------------------
2708
2709 /**
Jamie Rumbelow7efad202012-02-19 12:37:00 +00002710 * Resets the query builder "write" values.
Derek Allard2067d1a2008-11-13 22:59:24 +00002711 *
Robin Sowell43753fd2010-09-16 12:52:07 -04002712 * Called by the insert() update() insert_batch() update_batch() and delete() functions
Derek Allard2067d1a2008-11-13 22:59:24 +00002713 *
Derek Allard2067d1a2008-11-13 22:59:24 +00002714 * @return void
2715 */
Phil Sturgeon9789f322011-07-15 15:14:05 -06002716 protected function _reset_write()
Barry Mienydd671972010-10-04 16:33:58 +02002717 {
Andrey Andreev24276a32012-01-08 02:44:38 +02002718 $this->_reset_run(array(
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002719 'qb_set' => array(),
2720 'qb_from' => array(),
Andrey Andreev3e014372013-02-21 15:59:34 +02002721 'qb_join' => array(),
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002722 'qb_where' => array(),
Jamie Rumbelowd6ce1e92012-04-26 13:27:35 +01002723 'qb_orderby' => array(),
2724 'qb_keys' => array(),
Andrey Andreev650b4c02012-06-11 12:07:15 +03002725 'qb_limit' => FALSE
Andrey Andreev4a587f52014-12-11 16:27:15 +02002726 ));
Derek Allard2067d1a2008-11-13 22:59:24 +00002727 }
Andrey Andreev24276a32012-01-08 02:44:38 +02002728
Derek Allard2067d1a2008-11-13 22:59:24 +00002729}