fix: [SQLSRV] _getResult() return object for preparedQuery class (#6718)

* fix: _getResult() return object for preparedQuery class in sqlsrv

Author: michalsn

system/Database/SQLSRV/PreparedQuery.php

@@ -27,13 +27,6 @@ class PreparedQuery extends BasePreparedQuery
      */
     protected $parameters = [];
 
-    /**
-     * The result boolean from a sqlsrv_execute.
-     *
-     * @var bool
-     */
-    protected $result;
-
     /**
      * Prepares the query against the database, and saves the connection
      * info necessary to execute the query later.
@@ -68,7 +61,7 @@ public function _prepare(string $sql, array $options = [])
 
     /**
      * Takes a new set of data and runs it against the currently
-     * prepared query. Upon success, will return a Results object.
+     * prepared query.
      */
     public function _execute(array $data): bool
     {
@@ -80,19 +73,17 @@ public function _execute(array $data): bool
             $this->parameters[$key] = $value;
         }
 
-        $this->result = sqlsrv_execute($this->statement);
-
-        return (bool) $this->result;
+        return sqlsrv_execute($this->statement);
     }
 
     /**
-     * Returns the result object for the prepared query.
+     * Returns the statement resource for the prepared query or false when preparing failed.
      *
      * @return mixed
      */
     public function _getResult()
     {
-        return $this->result;
+        return $this->statement;
     }
 
     /**

tests/system/Database/Live/PreparedQueryTest.php

@@ -13,6 +13,7 @@
 
 use CodeIgniter\Database\BasePreparedQuery;
 use CodeIgniter\Database\Query;
+use CodeIgniter\Database\ResultInterface;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\DatabaseTestTrait;
 use Tests\Support\Database\Seeds\CITestSeeder;
@@ -134,4 +135,18 @@ public function testExecuteRunsQueryAndReturnsManualResultObject()
         $this->seeInDatabase($this->db->DBPrefix . 'user', ['name' => 'foo', 'email' => 'foo@example.com']);
         $this->seeInDatabase($this->db->DBPrefix . 'user', ['name' => 'bar', 'email' => 'bar@example.com']);
     }
+
+    public function testExecuteSelectQueryAndCheckTypeAndResult()
+    {
+        $this->query = $this->db->prepare(static fn ($db) => $db->table('user')->select('name, email, country')->where([
+            'name' => 'foo',
+        ])->get());
+
+        $result = $this->query->execute('Derek Jones');
+
+        $this->assertInstanceOf(ResultInterface::class, $result);
+
+        $expectedRow = ['name' => 'Derek Jones', 'email' => 'derek@world.com', 'country' => 'US'];
+        $this->assertSame($expectedRow, $result->getRowArray());
+    }
 }

user_guide_src/source/changelogs/v4.2.8.rst

@@ -38,5 +38,6 @@ Bugs Fixed
 
 - Fixed a bug when the ``CodeIgniter\HTTP\IncomingRequest::getPostGet()`` and ``CodeIgniter\HTTP\IncomingRequest::getGetPost()`` methods didn't return values from the other stream when ``index`` was set to ``null``.
 - Fixed a bug when ``binds`` weren't cleaned properly when calling ``CodeIgniter\Database\Postgre::replace()`` multiple times in the context.
+- Fixed a bug when the ``CodeIgniter\Database\SQLSRV\PreparedQuery::_getResult()`` was returning the bool value instead of the resource.
 
 See the repo's `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_ for a complete list of bugs fixed.