summaryrefslogtreecommitdiffstats
path: root/system/database/drivers/oci8/oci8_result.php
blob: cbf4bec5297a03cee434d97c063d70220467fb7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 5.1.6 or newer
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the Open Software License version 3.0
 *
 * This source file is subject to the Open Software License (OSL 3.0) that is
 * bundled with this package in the files license.txt / license.rst.  It is
 * also available through the world wide web at this URL:
 * http://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to obtain it
 * through the world wide web, please send an email to
 * licensing@ellislab.com so we can send you a copy immediately.
 *
 * @package		CodeIgniter
 * @author		EllisLab Dev Team
 * @copyright   Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
 * @license		http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 * @link		http://codeigniter.com
 * @since		Version 1.0
 * @filesource
 */

// ------------------------------------------------------------------------

/**
 * oci8 Result Class
 *
 * This class extends the parent result class: CI_DB_result
 *
 * @category	Database
 * @author		EllisLab Dev Team
 * @link		http://codeigniter.com/user_guide/database/
 */
class CI_DB_oci8_result extends CI_DB_result {

	public $stmt_id;
	public $curs_id;
	public $limit_used;

	// This will be changed by CI_DB_driver, but it's good to have a default:
	public $commit_mode = OCI_DEFAULT;

	/* Overwriting the parent here, so we have a way to know if it's
	 * already called or not:
	 */
	public $num_rows;

	/**
	 * Number of rows in the result set.
	 *
	 * Oracle doesn't have a graceful way to return the number of rows
	 * so we have to use what amounts to a hack.
	 *
	 * @return  integer
	 */
	public function num_rows()
	{
		if ( ! is_int($this->num_rows))
		{
			if (count($this->result_array) > 0)
			{
				return $this->num_rows = count($this->result_array);
			}
			elseif (count($this->result_object) > 0)
			{
				return $this->num_rows = count($this->result_array);
			}

			return $this->num_rows = count($this->result_array());
		}

		return $this->num_rows;
	}

	// --------------------------------------------------------------------

	/**
	 * Number of fields in the result set
	 *
	 * @return  integer
	 */
	public function num_fields()
	{
		$count = @oci_num_fields($this->stmt_id);

		// if we used a limit we subtract it
		if ($this->limit_used)
		{
			return $count - 1;
		}

		return $count;
	}

	// --------------------------------------------------------------------

	/**
	 * Fetch Field Names
	 *
	 * Generates an array of column names
	 *
	 * @return	array
	 */
	public function list_fields()
	{
		$field_names = array();
		for ($c = 1, $fieldCount = $this->num_fields(); $c <= $fieldCount; $c++)
		{
			$field_names[] = oci_field_name($this->stmt_id, $c);
		}
		return $field_names;
	}

	// --------------------------------------------------------------------

	/**
	 * Field data
	 *
	 * Generates an array of objects containing field meta-data
	 *
	 * @return  array
	 */
	public function field_data()
	{
		$retval = array();
		for ($c = 1, $fieldCount = $this->num_fields(); $c <= $fieldCount; $c++)
		{
			$F			= new stdClass();
			$F->name		= oci_field_name($this->stmt_id, $c);
			$F->type		= oci_field_type($this->stmt_id, $c);
			$F->max_length		= oci_field_size($this->stmt_id, $c);

			$retval[] = $F;
		}

		return $retval;
	}

	// --------------------------------------------------------------------

	/**
	 * Free the result
	 *
	 * @return	void
	 */
	public function free_result()
	{
		if (is_resource($this->result_id))
		{
			oci_free_statement($this->result_id);
			$this->result_id = FALSE;
		}

		if (is_resource($this->stmt_id))
		{
			oci_free_statement($this->stmt_id);
		}

		if (is_resource($this->curs_id))
		{
			oci_cancel($this->curs_id);
			$this->curs_id = NULL;
		}
	}

	// --------------------------------------------------------------------

	/**
	 * Result - associative array
	 *
	 * Returns the result set as an array
	 *
	 * @return  array
	 */
	protected function _fetch_assoc()
	{
		$id = ($this->curs_id) ? $this->curs_id : $this->stmt_id;
		return oci_fetch_assoc($id);
	}

	// --------------------------------------------------------------------

	/**
	 * Result - object
	 *
	 * Returns the result set as an object
	 *
	 * @return  object
	 */
	protected function _fetch_object()
	{
		$id = ($this->curs_id) ? $this->curs_id : $this->stmt_id;
		return oci_fetch_object($id);
	}

	// --------------------------------------------------------------------

	/* Query result
	 *
	 * Acts as a wrapper for result_array(), result_object()
	 * and custom_result_object().
	 *
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	array
	 */

	public function result($type = 'object')
	{
		if ($type === 'object')
		{
			return $this->result_object();
		}
		elseif ($type === 'array')
		{
			return $this->result_array();
		}
		else
		{
			return $this->custom_result_object($type);
		}
	}

	// --------------------------------------------------------------------

	/**
	 * Query result. "array" version.
	 *
	 * @return	array
	 */
	public function result_array()
	{
		if (count($this->result_array) > 0)
		{
			return $this->result_array;
		}
		elseif (count($this->result_object) > 0)
		{
			for ($i = 0, $c = count($this->result_object); $i < $c; $i++)
			{
				$this->result_array[$i] = (array) $this->result_object[$i];
			}

			return $this->result_array;
		}
		elseif (is_array($this->row_data))
		{
			if (count($this->row_data) === 0)
			{
				return $this->result_array;
			}
			else
			{
				$row_index = count($this->row_data);
			}
		}
		else
		{
			$row_index = 0;
			$this->row_data = array();
		}

		$row = NULL;
		while ($row = $this->_fetch_assoc())
		{
			$this->row_data[$row_index++] = $row;
		}

		// Un-comment the following line, in case it becomes needed
		// $this->_data_seek();
		return $this->result_array = $this->row_data;
	}

	// --------------------------------------------------------------------

	/**
	 * Query result. "object" version.
	 *
	 * @return	array
	 */
	public function result_object()
	{
		if (count($this->result_object) > 0)
		{
			return $this->result_object;
		}
		elseif (count($this->result_array) > 0)
		{
			for ($i = 0, $c = count($this->result_array); $i < $c; $i++)
			{
				$this->result_object[] = (object) $this->result_array[$i];
			}

			return $this->result_object;
		}
		elseif (is_array($this->row_data))
		{
			if (count($this->row_data) === 0)
			{
				return $this->result_object;
			}
			else
			{
				$row_index = count($this->row_data);
				for ($i = 0; $i < $row_index; $i++)
				{
					$this->result_object[$i] = (object) $this->row_data[$i];
				}
			}
		}
		else
		{
			$row_index = 0;
			$this->row_data = array();
		}

		$row = NULL;
		while ($row = $this->_fetch_object())
		{
			$this->row_data[$row_index] = (array) $row;
			$this->result_object[$row_index++] = $row;
		}

		// Un-comment the following line, in case it becomes needed
		// $this->_data_seek();
		return $this->result_object;
	}

	// --------------------------------------------------------------------

	/**
	 * Query result. Custom object version.
	 *
	 * @param	string	class name used to instantiate rows to
	 * @return	array
	 */
	public function custom_result_object($class_name)
	{
		if (array_key_exists($class_name, $this->custom_result_object))
		{
			return $this->custom_result_object[$class_name];
		}

		if ( ! class_exists($class_name) OR $this->result_id === FALSE OR $this->num_rows() === 0)
		{
			return array();
		}

		// add the data to the object
		$result_object = array();
		$data = NULL;

		/* First check if we don't already have the data.
		 * If so - pass by reference, as we don't know how
		 * large it might be and we don't want 1000 row
		 * sets being copied.
		 */
		if (count($this->result_array) > 0)
		{
			$data = &$this->result_array;
		}
		elseif (count($this->result_object) > 0)
		{
			$data = &$this->result_object;
		}

		if ( ! is_null($data))
		{
			for ($i = 0, $c = count($data); $i < $c; $i++)
			{
				$result_object[$i] = new $class_name();
				foreach ($data[$i] as $key => $value)
				{
					$result_object[$i]->$key = $value;
				}
			}
		}
		else
		{
			// No prefetched result set
			if (is_array($this->row_data))
			{
				$row_index = count($this->row_data);
				if ($row_index === 0)
				{
					return array();
				}
				else
				{
					for ($i = 0; $i < $row_index; $i++)
					{
						$result_object[$i] = new $class_name();
						foreach ($this->row_data[$i] as $key => $value)
						{
							$result_object[$i]->$key = $value;
						}
					}
				}
			}
			else
			{
				$row_index = 0;
				$this->row_data = array();
			}

			while ($row = $this->_fetch_assoc())
			{
				$data = new $class_name();
				foreach ($row as $key => $value)
				{
					$data->$key = $value;
				}

				$this->row_data[$row_index] = $row;
				$result_object[$row_index++] = $data;
			}
			// Un-comment the following line, in case it becomes needed
			// $this->_data_seek();
		}

		/* As described for the num_rows() method - there's no easy
		 * way to get the number of rows selected. Our work-around
		 * solution (as in here as well) first checks if result_array
		 * or result_object exist and returns their count. It doesn't
		 * however check for a custom_object_result, so - do it here.
		 */
		if ( ! is_int($this->num_rows))
		{
			$this->num_rows = count($result_object);
		}

		// Cache and return the array
		return $this->custom_result_object[$class_name] = $result_object;
        }

	// --------------------------------------------------------------------

	/* Single row result.
	 *
	 * Acts as a wrapper for row_object(), row_array()
	 * and custom_row_object(). Also used by first_row(), next_row()
	 * and previous_row().
	 *
	 * @param	int	row index
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	mixed	whatever was passed to the second parameter
	 */

	public function row($n = 0, $type = 'object')
	{
		if ($type === 'object') return $this->row_object($n);
		elseif ($type === 'array') return $this->row_array($n);
		else return $this->custom_row_object($n, $type);
	}

	// --------------------------------------------------------------------

	/* Single row result. Array version.
	 *
	 * @param	int	row index
	 * @return	array
	 */

	public function row_array($n = 0)
	{
		// Make sure $n is not a string
		if ( ! is_int($n))
		{
			$n = (int) $n;
		}

		/* If row_data is initialized, it means that we've already tried
		 * (at least) to fetch some data, so ... check if we already have
		 * this row.
		*/
		if (is_array($this->row_data))
		{
			/* If we already have row_data[$n] - return it.
			 *
			 * If we enter the elseif, there's a number of reasons to
			 * return an empty array:
			 *
			 *	- count($this->row_data) === 0 means there are no results
			 *	- num_rows being set, result_array and/or result_object
			 *	  having count() > 0 means that we've already fetched all
			 *	  data and $n is greater than our highest row index available
			 *	- $n < $this->current_row means that if such row existed,
			 *	  we would've already returned it, therefore $n is an
			 *	  invalid index
			 */
			if (isset($this->row_data[$n])) // We already have this row
			{
				$this->current_row = $n;
				return $this->row_data[$n];
			}
			elseif (count($this->row_data) === 0 OR is_int($this->num_rows)
				OR count($this->result_array) > 0 OR count($this->result_object) > 0
				OR $n < $this->current_row)
			{
				// No such row exists
				return array();
			}

			// Get the next row index that would actually need to be fetched
			$current_row = ($this->current_row < count($this->row_data)) ? count($this->row_data) : $this->current_row + 1;
		}
		else
		{
			$current_row = $this->current_row = 0;
			$this->row_data = array();
		}

		/* Fetch more data, if available
		 *
		 * NOTE: Operator precedence is important here, if you change
		 *	 'AND' with '&&' - it WILL BREAK the results, as
		 *	 $row will be assigned the scalar value of both
		 *	 expressions!
		 */
		while ($row = $this->_fetch_assoc() AND $current_row <= $n)
		{
			$this->row_data[$current_row++] = $row;
		}

		// This would mean that there's no (more) data to fetch
		if ( ! is_array($this->row_data) OR ! isset($this->row_data[$n]))
		{
			// Cache what we already have
			if (is_array($this->row_data))
			{
				$this->num_rows = count($this->row_data);
				/* Usually, row_data could have less elements than result_array,
				 * but at this point - they should be exactly the same.
				 */
				$this->result_array = $this->row_data;
			}
			else
			{
				$this->num_rows = 0;
			}

			return array();
		}

		$this->current_row = $n;
		return $this->row_data[$n];
	}

	// --------------------------------------------------------------------

	/* Single row result. Object version.
	 *
	 * @param	int	row index
	 * @return	mixed	object if row found; empty array if not
	 */
	public function row_object($n = 0)
	{
		// Make sure $n is not a string
		if ( ! is_int($n))
		{
			$n = (int) $n;
		}
		/* Logic here is exactly the same as in row_array,
		 * except we have to cast row_data[$n] to an object.
		 *
		 * If we already have result_object though - we can
		 * directly return from it.
		 */
		if (isset($this->result_object[$n]))
		{
			$this->current_row = $n;
			// Set this, if not already done.
			if ( ! is_int($this->num_rows))
			{
				$this->num_rows = count($this->result_object);
			}

			return $this->result_object[$n];
		}

		$row = $this->row_array($n);
		// Cast only if the row exists
		if (count($row) > 0)
		{
			$this->current_row = $n;
			return (object) $row;
		}

		return array();
	}

	// --------------------------------------------------------------------

	/* Single row result. Custom object version.
	 *
	 * @param	int	row index
	 * @param	string	custom class name
	 * @return	mixed	custom object if row found; empty array otherwise
	 */

	public function custom_row_object($n = 0, $class_name)
	{
		// Make sure $n is not a string
		if ( ! is_int($n))
		{
			$n = (int) $n;
		}

		if (array_key_exists($class_name, $this->custom_result_object))
		{
			/* We already have a the whole result set with this class_name,
			 * return the specified row if it exists, and an empty array if
			 * it doesn't.
			 */
			if (isset($this->custom_result_object[$class_name][$n]))
			{
				$this->current_row = $n;
				return $this->custom_result_object[$class_name][$n];
			}
			else
			{
				return array();
			}
		}
		elseif ( ! class_exists($class_name)) // No such class exists
		{
			return array();
		}

		$row = $this->row_array($n);
		// An array would mean that the row doesn't exist
		if (is_array($row))
		{
			return $row;
		}

		// Convert to the desired class and return
		$row_object = new $class_name();
		foreach ($row as $key => $value)
		{
			$row_object->$key = $value;
		}

		$this->current_row = $n;
		return $row_object;
	}

	// --------------------------------------------------------------------

	/* First row result.
	 *
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	mixed	whatever was passed to the second parameter
	 */

	public function first_row($type = 'object')
	{
		return $this->row(0, $type);
	}

	// --------------------------------------------------------------------

	/* Last row result.
	 *
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	mixed	whatever was passed to the second parameter
	 */
	public function last_row($type = 'object')
	{
		$result = &$this->result($type);
		if ( ! isset($this->num_rows))
		{
			$this->num_rows = count($result);
		}
		$this->current_row = $this->num_rows - 1;
		return $result[$this->current_row];
	}

	// --------------------------------------------------------------------

	/* Next row result.
	 *
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	mixed	whatever was passed to the second parameter
	 */
	public function next_row($type = 'object')
	{
		if (is_array($this->row_data))
		{
			$count = count($this->row_data);
			if ($this->current_row > $count OR ($this->current_row === 0 && $count === 0))
			{
				$n = $count;
			}
			else
			{
				$n = $this->current_row + 1;
			}
		}
		else
		{
			$n = 0;
		}

		return $this->row($n, $type);
	}

	// --------------------------------------------------------------------

	/* Previous row result.
	 *
	 * @param	string	('object', 'array' or a custom class name)
	 * @return	mixed	whatever was passed to the second parameter
	 */
	public function previous_row($type = 'object')
	{
		$n = ($this->current_row !== 0) ? $this->current_row - 1 : 0;
		return $this->row($n, $type);
	}

	// --------------------------------------------------------------------

	/**
	 * Data Seek
	 *
	 * Moves the internal pointer to the desired offset. We call
	 * this internally before fetching results to make sure the
	 * result set starts at zero.
	 *
	 * Oracle's PHP extension doesn't have an easy way of doing this
	 * and the only workaround is to (re)execute the statement or cursor
	 * in order to go to the first (zero) index of the result set.
	 * Then, we would need to "dummy" fetch ($n - 1) rows to get to the
	 * right one.
	 *
	 * This is as ridiculous as it sounds and it's the reason why every
	 * other method that is fetching data tries to use an already "cached"
	 * result set. Keeping this just in case it becomes needed at
	 * some point in the future, but it will only work for resetting the
	 * pointer to zero.
	 *
	 * @return	bool
	 */
	protected function _data_seek()
	{
		/* The PHP manual says that if OCI_NO_AUTO_COMMIT mode
		 * is used, and oci_rollback() and/or oci_commit() are
		 * not subsequently called - this will cause an unnecessary
		 * rollback to be triggered at the end of the script execution.
		 *
		 * Therefore we'll try to avoid using that mode flag
		 * if we're not currently in the middle of a transaction.
		 */
		if ($this->commit_mode !== OCI_COMMIT_ON_SUCCESS)
		{
			$result = @oci_execute($this->stmt_id, $this->commit_mode);
		}
		else
		{
			$result = @oci_execute($this->stmt_id);
		}

		if ($result && $this->curs_id)
		{
			if ($this->commit_mode !== OCI_COMMIT_ON_SUCCESS)
			{
				return @oci_execute($this->curs_id, $this->commit_mode);
			}
			else
			{
				return @oci_execute($this->curs_id);
			}
		}

		return $result;
	}

}

/* End of file oci8_result.php */
/* Location: ./system/database/drivers/oci8/oci8_result.php */