blob: 1d0272f9d87cb56b358f49342a594a56057c47ea [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Alex Bilbie84445d02011-03-10 16:43:39 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Alex Bilbie84445d02011-03-10 16:43:39 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev0e8968a2012-01-26 02:04:37 +02008 *
Andrey Andreevcce6bd12018-01-09 11:32:02 +02009 * Copyright (c) 2014 - 2018, British Columbia Institute of Technology
Andrey Andreev0e8968a2012-01-26 02:04:37 +020010 *
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
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreevcce6bd12018-01-09 11:32:02 +020032 * @copyright Copyright (c) 2014 - 2018, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 2.0.3
Alex Bilbie84445d02011-03-10 16:43:39 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Alex Bilbie84445d02011-03-10 16:43:39 +000039
Alex Bilbie84445d02011-03-10 16:43:39 +000040/**
Alex Bilbie01ab0042011-03-18 19:24:30 +000041 * SQLSRV Result Class
Alex Bilbie84445d02011-03-10 16:43:39 +000042 *
43 * This class extends the parent result class: CI_DB_result
44 *
45 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Andrey Andreevbd202c92016-01-11 12:50:18 +020047 * @link https://codeigniter.com/user_guide/database/
Alex Bilbie84445d02011-03-10 16:43:39 +000048 */
Alex Bilbie01ab0042011-03-18 19:24:30 +000049class CI_DB_sqlsrv_result extends CI_DB_result {
Alex Bilbie84445d02011-03-10 16:43:39 +000050
51 /**
Andrey Andreevba8bf562014-01-21 19:04:18 +020052 * Scrollable flag
53 *
54 * @var mixed
55 */
56 public $scrollable;
57
58 // --------------------------------------------------------------------
59
60 /**
61 * Constructor
62 *
63 * @param object $driver_object
64 * @return void
65 */
66 public function __construct(&$driver_object)
67 {
68 parent::__construct($driver_object);
69
70 $this->scrollable = $driver_object->scrollable;
71 }
72
73 // --------------------------------------------------------------------
74
75 /**
Alex Bilbie84445d02011-03-10 16:43:39 +000076 * Number of rows in the result set
77 *
Andrey Andreev0e8968a2012-01-26 02:04:37 +020078 * @return int
Alex Bilbie84445d02011-03-10 16:43:39 +000079 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +020080 public function num_rows()
Alex Bilbie84445d02011-03-10 16:43:39 +000081 {
Andrey Andreevba8bf562014-01-21 19:04:18 +020082 // sqlsrv_num_rows() doesn't work with the FORWARD and DYNAMIC cursors (FALSE is the same as FORWARD)
83 if ( ! in_array($this->scrollable, array(FALSE, SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_DYNAMIC), TRUE))
84 {
85 return parent::num_rows();
86 }
87
Andrey Andreevc7db6bb2012-07-05 15:11:20 +030088 return is_int($this->num_rows)
89 ? $this->num_rows
Andrey Andreevba8bf562014-01-21 19:04:18 +020090 : $this->num_rows = sqlsrv_num_rows($this->result_id);
Alex Bilbie84445d02011-03-10 16:43:39 +000091 }
92
93 // --------------------------------------------------------------------
94
95 /**
96 * Number of fields in the result set
97 *
Andrey Andreev0e8968a2012-01-26 02:04:37 +020098 * @return int
Alex Bilbie84445d02011-03-10 16:43:39 +000099 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200100 public function num_fields()
Alex Bilbie84445d02011-03-10 16:43:39 +0000101 {
Alex Bilbie079069c2011-03-10 19:36:58 +0000102 return @sqlsrv_num_fields($this->result_id);
Alex Bilbie84445d02011-03-10 16:43:39 +0000103 }
104
105 // --------------------------------------------------------------------
106
107 /**
108 * Fetch Field Names
109 *
110 * Generates an array of column names
111 *
Alex Bilbie84445d02011-03-10 16:43:39 +0000112 * @return array
113 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200114 public function list_fields()
Alex Bilbie84445d02011-03-10 16:43:39 +0000115 {
116 $field_names = array();
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200117 foreach (sqlsrv_field_metadata($this->result_id) as $offset => $field)
Alex Bilbie84445d02011-03-10 16:43:39 +0000118 {
Alex Bilbie3a43c7a2011-03-18 19:48:04 +0000119 $field_names[] = $field['Name'];
Alex Bilbie84445d02011-03-10 16:43:39 +0000120 }
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200121
Alex Bilbie84445d02011-03-10 16:43:39 +0000122 return $field_names;
123 }
124
125 // --------------------------------------------------------------------
126
127 /**
128 * Field data
129 *
130 * Generates an array of objects containing field meta-data
131 *
Alex Bilbie84445d02011-03-10 16:43:39 +0000132 * @return array
133 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200134 public function field_data()
Alex Bilbie84445d02011-03-10 16:43:39 +0000135 {
136 $retval = array();
Andrey Andreevf1e1b772012-11-16 01:27:00 +0200137 foreach (sqlsrv_field_metadata($this->result_id) as $i => $field)
Alex Bilbie84445d02011-03-10 16:43:39 +0000138 {
Andrey Andreevf1e1b772012-11-16 01:27:00 +0200139 $retval[$i] = new stdClass();
140 $retval[$i]->name = $field['Name'];
141 $retval[$i]->type = $field['Type'];
142 $retval[$i]->max_length = $field['Size'];
Alex Bilbie84445d02011-03-10 16:43:39 +0000143 }
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200144
Alex Bilbie84445d02011-03-10 16:43:39 +0000145 return $retval;
146 }
147
148 // --------------------------------------------------------------------
149
150 /**
151 * Free the result
152 *
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200153 * @return void
Alex Bilbie84445d02011-03-10 16:43:39 +0000154 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200155 public function free_result()
Alex Bilbie84445d02011-03-10 16:43:39 +0000156 {
157 if (is_resource($this->result_id))
158 {
Alex Bilbie079069c2011-03-10 19:36:58 +0000159 sqlsrv_free_stmt($this->result_id);
Alex Bilbie84445d02011-03-10 16:43:39 +0000160 $this->result_id = FALSE;
161 }
162 }
163
164 // --------------------------------------------------------------------
165
166 /**
Alex Bilbie84445d02011-03-10 16:43:39 +0000167 * Result - associative array
168 *
169 * Returns the result set as an array
170 *
Alex Bilbie84445d02011-03-10 16:43:39 +0000171 * @return array
172 */
Andrey Andreev0e8968a2012-01-26 02:04:37 +0200173 protected function _fetch_assoc()
Alex Bilbie84445d02011-03-10 16:43:39 +0000174 {
Alex Bilbie079069c2011-03-10 19:36:58 +0000175 return sqlsrv_fetch_array($this->result_id, SQLSRV_FETCH_ASSOC);
Alex Bilbie84445d02011-03-10 16:43:39 +0000176 }
177
178 // --------------------------------------------------------------------
179
180 /**
181 * Result - object
182 *
183 * Returns the result set as an object
184 *
Andrey Andreev8463b912012-11-02 02:16:28 +0200185 * @param string $class_name
Alex Bilbie84445d02011-03-10 16:43:39 +0000186 * @return object
187 */
Andrey Andreev9a4f3562012-07-06 11:57:37 +0300188 protected function _fetch_object($class_name = 'stdClass')
Alex Bilbie84445d02011-03-10 16:43:39 +0000189 {
Andrey Andreev9a4f3562012-07-06 11:57:37 +0300190 return sqlsrv_fetch_object($this->result_id, $class_name);
Alex Bilbie84445d02011-03-10 16:43:39 +0000191 }
192
193}