blob: 36473fc7e4b275c2f4b43e9c0dca63511b34dbc3 [file] [log] [blame]
Andrey Andreevb76029d2012-01-26 15:13:19 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreevb76029d2012-01-26 15:13:19 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevb76029d2012-01-26 15:13:19 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * ODBC Result Class
30 *
31 * This class extends the parent result class: CI_DB_result
32 *
33 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/database/
36 */
37class CI_DB_odbc_result extends CI_DB_result {
Barry Mienydd671972010-10-04 16:33:58 +020038
Andrey Andreevef795ac2012-03-01 15:15:31 +020039 public $num_rows;
40
Derek Allard2067d1a2008-11-13 22:59:24 +000041 /**
42 * Number of rows in the result set
43 *
Andrey Andreevb76029d2012-01-26 15:13:19 +020044 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +000045 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020046 public function num_rows()
Derek Allard2067d1a2008-11-13 22:59:24 +000047 {
Andrey Andreevef795ac2012-03-01 15:15:31 +020048 if (is_int($this->num_rows))
Andrey Andreev78b24bf2012-02-29 16:43:57 +020049 {
50 return $this->num_rows;
51 }
52
53 // Work-around for ODBC subdrivers that don't support num_rows()
54 if (($this->num_rows = @odbc_num_rows($this->result_id)) === -1)
55 {
Andrey Andreevef795ac2012-03-01 15:15:31 +020056 $this->num_rows = count($this->result_array());
Andrey Andreev78b24bf2012-02-29 16:43:57 +020057 }
58
59 return $this->num_rows;
Derek Allard2067d1a2008-11-13 22:59:24 +000060 }
Barry Mienydd671972010-10-04 16:33:58 +020061
Derek Allard2067d1a2008-11-13 22:59:24 +000062 /**
63 * Number of fields in the result set
64 *
Andrey Andreevb76029d2012-01-26 15:13:19 +020065 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +000066 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020067 public function num_fields()
Derek Allard2067d1a2008-11-13 22:59:24 +000068 {
69 return @odbc_num_fields($this->result_id);
70 }
71
72 // --------------------------------------------------------------------
73
74 /**
75 * Fetch Field Names
76 *
77 * Generates an array of column names
78 *
Derek Allard2067d1a2008-11-13 22:59:24 +000079 * @return array
80 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020081 public function list_fields()
Derek Allard2067d1a2008-11-13 22:59:24 +000082 {
83 $field_names = array();
Andrey Andreevbb8a6832012-02-14 12:17:13 +020084 $num_fields = $this->num_fields();
Andrey Andreev41e46a92012-03-01 14:58:17 +020085
Andrey Andreevbb8a6832012-02-14 12:17:13 +020086 if ($num_fields > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +000087 {
Andrey Andreevbb8a6832012-02-14 12:17:13 +020088 for ($i = 1; $i <= $num_fields; $i++)
89 {
Andrey Andreev41e46a92012-03-01 14:58:17 +020090 $field_names[] = odbc_field_name($this->result_id, $i);
Andrey Andreevbb8a6832012-02-14 12:17:13 +020091 }
Derek Allard2067d1a2008-11-13 22:59:24 +000092 }
Barry Mienydd671972010-10-04 16:33:58 +020093
Derek Allard2067d1a2008-11-13 22:59:24 +000094 return $field_names;
95 }
96
97 // --------------------------------------------------------------------
98
99 /**
100 * Field data
101 *
102 * Generates an array of objects containing field meta-data
103 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000104 * @return array
105 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200106 public function field_data()
Derek Allard2067d1a2008-11-13 22:59:24 +0000107 {
108 $retval = array();
Andrey Andreevbb8a6832012-02-14 12:17:13 +0200109 for ($i = 0, $odbc_index = 1, $c = $this->num_fields(); $i < $c; $i++, $odbc_index++)
Derek Allard2067d1a2008-11-13 22:59:24 +0000110 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200111 $retval[$i] = new stdClass();
Andrey Andreevbb8a6832012-02-14 12:17:13 +0200112 $retval[$i]->name = odbc_field_name($this->result_id, $odbc_index);
113 $retval[$i]->type = odbc_field_type($this->result_id, $odbc_index);
114 $retval[$i]->max_length = odbc_field_len($this->result_id, $odbc_index);
Andrey Andreevb76029d2012-01-26 15:13:19 +0200115 $retval[$i]->primary_key = 0;
116 $retval[$i]->default = '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 }
Barry Mienydd671972010-10-04 16:33:58 +0200118
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 return $retval;
120 }
121
122 // --------------------------------------------------------------------
123
124 /**
125 * Free the result
126 *
Andrey Andreevb76029d2012-01-26 15:13:19 +0200127 * @return void
Barry Mienydd671972010-10-04 16:33:58 +0200128 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200129 public function free_result()
Derek Allard2067d1a2008-11-13 22:59:24 +0000130 {
131 if (is_resource($this->result_id))
132 {
133 odbc_free_result($this->result_id);
134 $this->result_id = FALSE;
135 }
136 }
137
138 // --------------------------------------------------------------------
139
140 /**
141 * Data Seek
142 *
Andrey Andreevb76029d2012-01-26 15:13:19 +0200143 * Moves the internal pointer to the desired offset. We call
Derek Allard2067d1a2008-11-13 22:59:24 +0000144 * this internally before fetching results to make sure the
145 * result set starts at zero
146 *
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200147 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000148 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200149 protected function _data_seek($n = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200151 // Not supported
Derek Allard2067d1a2008-11-13 22:59:24 +0000152 return FALSE;
153 }
154
155 // --------------------------------------------------------------------
156
157 /**
158 * Result - associative array
159 *
160 * Returns the result set as an array
161 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000162 * @return array
163 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200164 protected function _fetch_assoc()
Derek Allard2067d1a2008-11-13 22:59:24 +0000165 {
Andrey Andreev7e934892012-02-12 03:29:06 +0200166 return function_exists('odbc_fetch_array')
Andrey Andreevb76029d2012-01-26 15:13:19 +0200167 ? odbc_fetch_array($this->result_id)
168 : $this->_odbc_fetch_array($this->result_id);
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 }
170
171 // --------------------------------------------------------------------
172
173 /**
174 * Result - object
175 *
176 * Returns the result set as an object
177 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 * @return object
179 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200180 protected function _fetch_object()
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200182 return function_exists('odbc_fetch_object')
183 ? odbc_fetch_object($this->result_id)
184 : $this->_odbc_fetch_object($this->result_id);
Derek Allard2067d1a2008-11-13 22:59:24 +0000185 }
186
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200187 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000188
189 /**
190 * Result - object
191 *
192 * subsititutes the odbc_fetch_object function when
193 * not available (odbc_fetch_object requires unixODBC)
194 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000195 * @return object
196 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200197 protected function _odbc_fetch_object(& $odbc_result)
Andrey Andreevb76029d2012-01-26 15:13:19 +0200198 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000199 $rs = array();
Andrey Andreevb76029d2012-01-26 15:13:19 +0200200 if ( ! odbc_fetch_into($odbc_result, $rs))
201 {
202 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000203 }
Andrey Andreevb76029d2012-01-26 15:13:19 +0200204
205 $rs_obj = new stdClass();
206 foreach ($rs as $k => $v)
207 {
Andrey Andreevd0b256f2012-02-13 12:20:11 +0200208 $field_name = odbc_field_name($odbc_result, $k+1);
Andrey Andreevb76029d2012-01-26 15:13:19 +0200209 $rs_obj->$field_name = $v;
210 }
211
Derek Allard2067d1a2008-11-13 22:59:24 +0000212 return $rs_obj;
213 }
214
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200215 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000216
217 /**
218 * Result - array
219 *
220 * subsititutes the odbc_fetch_array function when
221 * not available (odbc_fetch_array requires unixODBC)
222 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000223 * @return array
224 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200225 protected function _odbc_fetch_array(& $odbc_result)
Andrey Andreevb76029d2012-01-26 15:13:19 +0200226 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000227 $rs = array();
Andrey Andreevb76029d2012-01-26 15:13:19 +0200228 if ( ! odbc_fetch_into($odbc_result, $rs))
229 {
230 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000231 }
Andrey Andreevb76029d2012-01-26 15:13:19 +0200232
233 $rs_assoc = array();
234 foreach ($rs as $k => $v)
235 {
Andrey Andreevd0b256f2012-02-13 12:20:11 +0200236 $field_name = odbc_field_name($odbc_result, $k+1);
Andrey Andreevb76029d2012-01-26 15:13:19 +0200237 $rs_assoc[$field_name] = $v;
238 }
239
Derek Allard2067d1a2008-11-13 22:59:24 +0000240 return $rs_assoc;
241 }
242
Andrey Andreevcc5af532012-03-05 14:02:15 +0200243 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000244
Andrey Andreevcc5af532012-03-05 14:02:15 +0200245 /**
246 * Query result. Array version.
247 *
248 * @return array
249 */
250 public function result_array()
251 {
252 if (count($this->result_array) > 0)
253 {
254 return $this->result_array;
255 }
256 elseif (($c = count($this->result_object)) > 0)
257 {
258 for ($i = 0; $i < $c; $i++)
259 {
260 $this->result_array[$i] = (array) $this->result_object[$i];
261 }
262 }
263 elseif ($this->result_id === FALSE)
264 {
265 return array();
266 }
267 else
268 {
269 while ($row = $this->_fetch_assoc())
270 {
271 $this->result_array[] = $row;
272 }
273 }
274
275 return $this->result_array;
276 }
277
Andrey Andreev9c68c312012-03-06 10:34:58 +0200278 // --------------------------------------------------------------------
279
280 /**
281 * Query result. Object version.
282 *
283 * @return array
284 */
285 public function result_object()
286 {
287 if (count($this->result_object) > 0)
288 {
289 return $this->result_object;
290 }
291 elseif (($c = count($this->result_array)) > 0)
292 {
293 for ($i = 0; $i < $c; $i++)
294 {
295 $this->result_object[$i] = (object) $this->result_array[$i];
296 }
297 }
298 elseif ($this->result_id === FALSE)
299 {
300 return array();
301 }
302 else
303 {
304 while ($row = $this->_fetch_object())
305 {
306 $this->result_object[] = $row;
307 }
308 }
309
310 return $this->result_object;
311 }
312
Derek Allard2067d1a2008-11-13 22:59:24 +0000313}
314
Derek Allard2067d1a2008-11-13 22:59:24 +0000315/* End of file odbc_result.php */
Andrey Andreev19aee032012-03-20 15:31:42 +0200316/* Location: ./system/database/drivers/odbc/odbc_result.php */