[TASK] Update phpdoc @return of exec_SELECTgetSingleRow() 89/31489/2
authorMarkus Klein <klein.t3@mfc-linz.at>
Tue, 8 Jul 2014 08:12:21 +0000 (10:12 +0200)
committerMarkus Klein <klein.t3@mfc-linz.at>
Tue, 8 Jul 2014 08:21:39 +0000 (10:21 +0200)
DatabaseConnection::exec_SELECTgetSingleRow() may return FALSE if no row
is found. This is not reflected in the phpdoc for the return value.

This patch adds the necessary information to the doc header.

Resolves: #60172
Releases: 6.3, 6.2
Change-Id: Ia07868c2a1e8fad5b1d53d89ff0a959c2bcf9e3a
Reviewed-on: https://review.typo3.org/31489
Reviewed-by: Thomas Löffler
Reviewed-by: Wouter Wolters
Tested-by: Wouter Wolters
Reviewed-by: Sascha Egerer
Reviewed-by: Marcin Sągol
Tested-by: Marcin Sągol
Reviewed-by: Markus Klein
Tested-by: Markus Klein

index 8060ba1..ee2e8ed 100644 (file)
@@ -384,7 +384,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 boolean $numIndex If set, the result will be fetched with sql_fetch_row, otherwise sql_fetch_assoc will be used.
-        * @return array Single row or NULL if it fails.
+        * @return array|FALSE|NULL Single row, FALSE on empty result, NULL on error
        public function exec_SELECTgetSingleRow($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $numIndex = FALSE) {
                $res = $this->exec_SELECTquery($select_fields, $from_table, $where_clause, $groupBy, $orderBy, '1');