[TASK] Cleanup docblocks for MySQLi-results 20/20020/3
authorStefan Neufeind <typo3.neufeind@speedpartner.de>
Thu, 18 Apr 2013 09:56:56 +0000 (11:56 +0200)
committerDmitry Dulepov <dmitry.dulepov@gmail.com>
Mon, 22 Apr 2013 08:11:48 +0000 (10:11 +0200)
Resolves: #47341
Releases: 6.1
Change-Id: I0d6ba8903b98c1eb5ec19978e03ed78f1ef15638
Reviewed-on: https://review.typo3.org/20020
Reviewed-by: Jigal van Hemert
Tested-by: Jigal van Hemert
Reviewed-by: Dmitry Dulepov
Tested-by: Dmitry Dulepov
t3lib/class.t3lib_xml.php
typo3/sysext/backend/Classes/View/PageLayoutView.php
typo3/sysext/core/Classes/DataHandling/DataHandler.php
typo3/sysext/core/Classes/Database/DatabaseConnection.php
typo3/sysext/core/Classes/Database/PreparedStatement.php
typo3/sysext/indexed_search/Classes/Hook/MysqlFulltextIndexHook.php
typo3/sysext/install/Classes/Sql/SchemaMigrator.php

index c7011a4..4418ff7 100644 (file)
@@ -179,7 +179,7 @@ class t3lib_xml {
         * Takes a SQL result for $table and traverses it, adding rows
         *
         * @param string $table Tablename
-        * @param pointer $res SQL resource pointer, should be reset
+        * @param boolean|\mysqli_result|object $res MySQLi result object / DBAL object
         * @return void
         */
        public function renderRecords($table, $res) {
index 4387559..95a2697 100644 (file)
@@ -1556,7 +1556,7 @@ class PageLayoutView extends \TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRe
        /**
         * Traverse the result pointer given, adding each record to array and setting some internal values at the same time.
         *
-        * @param resource $result SQL result pointer for select query.
+        * @param boolean|\mysqli_result|object $result MySQLi result object / DBAL object
         * @param string $table Table name defaulting to tt_content
         * @return array The selected rows returned in this array.
         * @todo Define visibility
index 6ec6803..7334475 100644 (file)
@@ -5256,7 +5256,7 @@ class DataHandler {
         *
         * @param integer $id Page id
         * @param integer $perms Permission integer
-        * @return resource MySQL result object (from exec_SELECTquery())
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object (from exec_SELECTquery())
         * @access private
         * @see doesRecordExist()
         * @todo Define visibility
index 47c1b24..2287d77 100644 (file)
@@ -315,7 +315,7 @@ class DatabaseConnection {
         * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
         * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
         * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
-        * @return resource MySQLi result object / DBAL object
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         * @see exec_SELECTquery()
         */
        public function exec_SELECT_mm_query($select, $local_table, $mm_table, $foreign_table, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '') {
@@ -336,7 +336,7 @@ class DatabaseConnection {
         * Executes a select based on input query parts array
         *
         * @param array $queryParts Query parts array
-        * @return resource MySQLi select result object / DBAL object
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         * @see exec_SELECTquery()
         */
        public function exec_SELECT_queryArray($queryParts) {
@@ -750,7 +750,7 @@ class DatabaseConnection {
         *
         * @param string $query The query to execute
         * @param array $queryComponents The components of the query to execute
-        * @return resource MySQL result object / DBAL object
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         */
        public function exec_PREPAREDquery($query, array $queryComponents) {
                if (!$this->isConnected) {
@@ -1392,7 +1392,7 @@ class DatabaseConnection {
         * mysqli() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
         *
         * @param string $query Query to execute
-        * @return resource Result pointer (MySQLi result object)
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         */
        public function admin_query($query) {
                if (!$this->isConnected) {
@@ -1666,7 +1666,7 @@ class DatabaseConnection {
        /**
         * Checks if record set is valid and writes debugging information into devLog if not.
         *
-        * @param resource|boolean $res MySQLi result object
+        * @param boolean|\mysqli_result|object MySQLi result object / DBAL object
         * @return boolean TRUE if the  record set is valid, FALSE otherwise
         * @todo Define visibility
         */
@@ -1674,7 +1674,7 @@ class DatabaseConnection {
                if ($res !== FALSE) {
                        return TRUE;
                }
-               $msg = 'Invalid database result resource detected';
+               $msg = 'Invalid database result detected';
                $trace = debug_backtrace();
                array_shift($trace);
                $cnt = count($trace);
@@ -1738,7 +1738,7 @@ class DatabaseConnection {
                $explain_tables = array();
                $explain_output = array();
                $res = $this->sql_query('EXPLAIN ' . $query, $this->link);
-               if (is_resource($res)) {
+               if (is_a($res, '\\mysqli_result')) {
                        while ($tempRow = $this->sql_fetch_assoc($res)) {
                                $explain_output[] = $tempRow;
                                $explain_tables[] = $tempRow['table'];
@@ -1758,7 +1758,7 @@ class DatabaseConnection {
                                $isTable = $this->sql_num_rows($tableRes);
                                if ($isTable) {
                                        $res = $this->sql_query('SHOW INDEX FROM ' . $table, $this->link);
-                                       if (is_resource($res)) {
+                                       if (is_a($res, '\\mysqli_result')) {
                                                while ($tempRow = $this->sql_fetch_assoc($res)) {
                                                        $indices_output[] = $tempRow;
                                                }
index ad00274..a75a21a 100644 (file)
@@ -127,9 +127,9 @@ class PreparedStatement {
        protected $defaultFetchMode = self::FETCH_ASSOC;
 
        /**
-        * MySQLi result pointer (of SELECT query) / DBAL object.
+        * MySQLi result object / DBAL object
         *
-        * @var resource
+        * @var boolean|\mysqli_result|object
         */
        protected $resource;
 
index 5d32556..4e6308d 100644 (file)
@@ -48,7 +48,7 @@ class MysqlFulltextIndexHook {
         *
         * @param array $searchWordsArray Search words
         * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
-        * @return resource|false
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         */
        public function getResultRows_SQLpointer($searchWordsArray, $freeIndexUid = -1) {
                // Build the search string, detect which fulltext index to use, and decide whether boolean search is needed or not
@@ -149,7 +149,7 @@ class MysqlFulltextIndexHook {
         *
         * @param array $searchData Array with search string, boolean indicator, and fulltext index reference
         * @param int $freeIndexUid Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content.
-        * @return resource Query result
+        * @return boolean|\mysqli_result|object MySQLi result object / DBAL object
         */
        protected function execFinalQuery_fulltext($searchData, $freeIndexUid = -1) {
                // Setting up methods of filtering results based on page types, access, etc.
index be60a5a..16c04a6 100644 (file)
@@ -677,7 +677,7 @@ class SchemaMigrator {
                                        $res = $GLOBALS['TYPO3_DB']->admin_query($string);
                                        if ($res === FALSE) {
                                                $result[$key] = $GLOBALS['TYPO3_DB']->sql_error();
-                                       } elseif (is_resource($res)) {
+                                       } elseif (is_resource($res) || is_a($res, '\\mysqli_result')) {
                                                $GLOBALS['TYPO3_DB']->sql_free_result($res);
                                        }
                                }