blob: f6aee356f883067835202b085c192ea8fa90b2f1 [file] [log] [blame]
Andrey Andreev78ef5a52012-03-20 14:43:34 +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 Andreev78ef5a52012-03-20 14:43:34 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev78ef5a52012-03-20 14:43:34 +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 Andreevef795ac2012-03-01 15:15:31 +020044 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +000045 */
Andrey Andreevef795ac2012-03-01 15:15:31 +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))
49 {
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 {
56 $this->num_rows = count($this->result_array());
57 }
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
64 /**
65 * Number of fields in the result set
66 *
Andrey Andreev41e46a92012-03-01 14:58:17 +020067 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +000068 */
Andrey Andreev41e46a92012-03-01 14:58:17 +020069 public function num_fields()
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
71 return @odbc_num_fields($this->result_id);
72 }
73
74 // --------------------------------------------------------------------
75
76 /**
77 * Fetch Field Names
78 *
79 * Generates an array of column names
80 *
Derek Allard2067d1a2008-11-13 22:59:24 +000081 * @return array
82 */
Andrey Andreev41e46a92012-03-01 14:58:17 +020083 public function list_fields()
Derek Allard2067d1a2008-11-13 22:59:24 +000084 {
85 $field_names = array();
Andrey Andreev41e46a92012-03-01 14:58:17 +020086 $num_fields = $this->num_fields();
87
88 if ($num_fields > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +000089 {
Andrey Andreev41e46a92012-03-01 14:58:17 +020090 for ($i = 1; $i <= $num_fields; $i++)
91 {
92 $field_names[] = odbc_field_name($this->result_id, $i);
93 }
Derek Allard2067d1a2008-11-13 22:59:24 +000094 }
Barry Mienydd671972010-10-04 16:33:58 +020095
Derek Allard2067d1a2008-11-13 22:59:24 +000096 return $field_names;
97 }
98
99 // --------------------------------------------------------------------
100
101 /**
102 * Field data
103 *
104 * Generates an array of objects containing field meta-data
105 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000106 * @return array
107 */
Andrey Andreev41e46a92012-03-01 14:58:17 +0200108 public function field_data()
Derek Allard2067d1a2008-11-13 22:59:24 +0000109 {
110 $retval = array();
Andrey Andreev41e46a92012-03-01 14:58:17 +0200111 for ($i = 0, $odbc_index = 1, $c = $this->num_fields(); $i < $c; $i++, $odbc_index++)
Derek Allard2067d1a2008-11-13 22:59:24 +0000112 {
Andrey Andreev41e46a92012-03-01 14:58:17 +0200113 $retval[$i] = new stdClass();
114 $retval[$i]->name = odbc_field_name($this->result_id, $odbc_index);
115 $retval[$i]->type = odbc_field_type($this->result_id, $odbc_index);
116 $retval[$i]->max_length = odbc_field_len($this->result_id, $odbc_index);
117 $retval[$i]->primary_key = 0;
118 $retval[$i]->default = '';
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 }
Barry Mienydd671972010-10-04 16:33:58 +0200120
Derek Allard2067d1a2008-11-13 22:59:24 +0000121 return $retval;
122 }
123
124 // --------------------------------------------------------------------
125
126 /**
127 * Free the result
128 *
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200129 * @return void
Barry Mienydd671972010-10-04 16:33:58 +0200130 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200131 public function free_result()
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 {
133 if (is_resource($this->result_id))
134 {
135 odbc_free_result($this->result_id);
136 $this->result_id = FALSE;
137 }
138 }
139
140 // --------------------------------------------------------------------
141
142 /**
143 * Data Seek
144 *
Derek Jones37f4b9c2011-07-01 17:56:50 -0500145 * Moves the internal pointer to the desired offset. We call
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 * this internally before fetching results to make sure the
147 * result set starts at zero
148 *
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200149 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200151 protected function _data_seek($n = 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000152 {
153 return FALSE;
154 }
155
156 // --------------------------------------------------------------------
157
158 /**
159 * Result - associative array
160 *
161 * Returns the result set as an array
162 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000163 * @return array
164 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200165 protected function _fetch_assoc()
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 {
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200167 if (function_exists('odbc_fetch_array'))
Derek Allard2067d1a2008-11-13 22:59:24 +0000168 {
169 return odbc_fetch_array($this->result_id);
170 }
171 else
172 {
173 return $this->_odbc_fetch_array($this->result_id);
174 }
175 }
176
177 // --------------------------------------------------------------------
178
179 /**
180 * Result - object
181 *
182 * Returns the result set as an object
183 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000184 * @return object
185 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200186 protected function _fetch_object()
Derek Allard2067d1a2008-11-13 22:59:24 +0000187 {
188 if (function_exists('odbc_fetch_object'))
189 {
190 return odbc_fetch_object($this->result_id);
191 }
192 else
193 {
194 return $this->_odbc_fetch_object($this->result_id);
195 }
196 }
197
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200198 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000199
200 /**
201 * Result - object
202 *
203 * subsititutes the odbc_fetch_object function when
204 * not available (odbc_fetch_object requires unixODBC)
205 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 * @return object
207 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200208 protected function _odbc_fetch_object(& $odbc_result)
209 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000210 $rs = array();
Pascal Kriete8761ef52011-02-14 13:13:52 -0500211 $rs_obj = FALSE;
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200212 if (odbc_fetch_into($odbc_result, $rs))
213 {
214 foreach ($rs as $k => $v)
215 {
216 $field_name = odbc_field_name($odbc_result, $k+1);
Derek Allard2067d1a2008-11-13 22:59:24 +0000217 $rs_obj->$field_name = $v;
218 }
219 }
220 return $rs_obj;
221 }
222
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200223 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000224
225 /**
226 * Result - array
227 *
228 * subsititutes the odbc_fetch_array function when
229 * not available (odbc_fetch_array requires unixODBC)
230 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000231 * @return array
232 */
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200233 protected function _odbc_fetch_array(& $odbc_result)
234 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000235 $rs = array();
Pascal Kriete8761ef52011-02-14 13:13:52 -0500236 $rs_assoc = FALSE;
Andrey Andreev78ef5a52012-03-20 14:43:34 +0200237 if (odbc_fetch_into($odbc_result, $rs))
238 {
239 $rs_assoc = array();
240 foreach ($rs as $k => $v)
241 {
242 $field_name = odbc_field_name($odbc_result, $k+1);
Derek Allard2067d1a2008-11-13 22:59:24 +0000243 $rs_assoc[$field_name] = $v;
244 }
245 }
246 return $rs_assoc;
247 }
248
Andrey Andreevcc5af532012-03-05 14:02:15 +0200249 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +0000250
Andrey Andreevcc5af532012-03-05 14:02:15 +0200251 /**
252 * Query result. Array version.
253 *
254 * @return array
255 */
256 public function result_array()
257 {
258 if (count($this->result_array) > 0)
259 {
260 return $this->result_array;
261 }
262 elseif (($c = count($this->result_object)) > 0)
263 {
264 for ($i = 0; $i < $c; $i++)
265 {
266 $this->result_array[$i] = (array) $this->result_object[$i];
267 }
268 }
269 elseif ($this->result_id === FALSE)
270 {
271 return array();
272 }
273 else
274 {
275 while ($row = $this->_fetch_assoc())
276 {
277 $this->result_array[] = $row;
278 }
279 }
280
281 return $this->result_array;
282 }
283
Andrey Andreev9c68c312012-03-06 10:34:58 +0200284 // --------------------------------------------------------------------
285
286 /**
287 * Query result. Object version.
288 *
289 * @return array
290 */
291 public function result_object()
292 {
293 if (count($this->result_object) > 0)
294 {
295 return $this->result_object;
296 }
297 elseif (($c = count($this->result_array)) > 0)
298 {
299 for ($i = 0; $i < $c; $i++)
300 {
301 $this->result_object[$i] = (object) $this->result_array[$i];
302 }
303 }
304 elseif ($this->result_id === FALSE)
305 {
306 return array();
307 }
308 else
309 {
310 while ($row = $this->_fetch_object())
311 {
312 $this->result_object[] = $row;
313 }
314 }
315
316 return $this->result_object;
317 }
318
Andrey Andreevcc5af532012-03-05 14:02:15 +0200319}
Derek Allard2067d1a2008-11-13 22:59:24 +0000320
321/* End of file odbc_result.php */
Andrey Andreev41e46a92012-03-01 14:58:17 +0200322/* Location: ./system/database/drivers/odbc/odbc_result.php */