Fix documentation of DatabaseBase::fetchObject() and DatabaseBase::fetchRow()

- DatabaseBase::fetchRows() returns the row as an array, not an object
- Both methods return false if there are no more rows in the result

Change-Id: I328d61b237bb82479d3fcb4c54ee9fd96dc4598f

diff --git a/includes/db/Database.php b/includes/db/Database.php
index bf619a7..05a0ca0 100644 (file)
--- a/includes/db/Database.php
+++ b/includes/db/Database.php
@@ -62,9 +62,10 @@ interface DatabaseType {
         * Fetch the next row from the given result object, in object form.
         * Fields can be retrieved with $row->fieldname, with fields acting like
         * member variables.
+        * If no more rows are available, false is returned.
         *
         * @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc.
-        * @return Row object
+        * @return object|bool
         * @throws DBUnexpectedError Thrown if the database returns an error
         */
        function fetchObject( $res );
@@ -72,9 +73,10 @@ interface DatabaseType {
        /**
         * Fetch the next row from the given result object, in associative array
         * form.  Fields are retrieved with $row['fieldname'].
+        * If no more rows are available, false is returned.
         *
         * @param $res ResultWrapper result object as returned from DatabaseBase::query(), etc.
-        * @return Row object
+        * @return array|bool
         * @throws DBUnexpectedError Thrown if the database returns an error
         */
        function fetchRow( $res );

diff --git a/includes/db/DatabaseIbm_db2.php b/includes/db/DatabaseIbm_db2.php
index 57fc7b9..30bc665 100644 (file)
--- a/includes/db/DatabaseIbm_db2.php
+++ b/includes/db/DatabaseIbm_db2.php
@@ -685,9 +685,10 @@ class DatabaseIbm_db2 extends DatabaseBase {
         * Fetch the next row from the given result object, in object form.
         * Fields can be retrieved with $row->fieldname, with fields acting like
         * member variables.
+        * If no more rows are available, false is returned.
         *
         * @param $res array|ResultWrapper SQL result object as returned from Database::query(), etc.
-        * @return DB2 row object
+        * @return object|bool
         * @throws DBUnexpectedError Thrown if the database returns an error
         */
        public function fetchObject( $res ) {
@@ -707,9 +708,10 @@ class DatabaseIbm_db2 extends DatabaseBase {
        /**
         * Fetch the next row from the given result object, in associative array
         * form. Fields are retrieved with $row['fieldname'].
+        * If no more rows are available, false is returned.
         *
         * @param $res array|ResultWrapper SQL result object as returned from Database::query(), etc.
-        * @return ResultWrapper row object
+        * @return array|bool
         * @throws DBUnexpectedError Thrown if the database returns an error
         */
        public function fetchRow( $res ) {

diff --git a/includes/db/DatabaseMysql.php b/includes/db/DatabaseMysql.php
index 4ac7707..fab0e96 100644 (file)
--- a/includes/db/DatabaseMysql.php
+++ b/includes/db/DatabaseMysql.php
@@ -193,7 +193,7 @@ class DatabaseMysql extends DatabaseBase {
 
        /**
         * @param $res ResultWrapper
-        * @return object|stdClass
+        * @return object|bool
         * @throws DBUnexpectedError
         */
        function fetchObject( $res ) {
@@ -217,7 +217,7 @@ class DatabaseMysql extends DatabaseBase {
 
        /**
         * @param $res ResultWrapper
-        * @return array
+        * @return array|bool
         * @throws DBUnexpectedError
         */
        function fetchRow( $res ) {

diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php
index 9120c28..74bd9b7 100644 (file)
--- a/includes/db/DatabaseSqlite.php
+++ b/includes/db/DatabaseSqlite.php
@@ -127,7 +127,7 @@ class DatabaseSqlite extends DatabaseBase {
                # set error codes only, don't raise exceptions
                if ( $this->mOpened ) {
                        $this->mConn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT );
-                       # Enforce LIKE to be case sensitive, just like MySQL\r
+                       # Enforce LIKE to be case sensitive, just like MySQL
                        $this->query( 'PRAGMA case_sensitive_like = 1' );
                        return true;
                }
@@ -252,7 +252,7 @@ class DatabaseSqlite extends DatabaseBase {
 
        /**
         * @param $res ResultWrapper
-        * @return
+        * @return object|bool
         */
        function fetchObject( $res ) {
                if ( $res instanceof ResultWrapper ) {
@@ -278,7 +278,7 @@ class DatabaseSqlite extends DatabaseBase {
 
        /**
         * @param $res ResultWrapper
-        * @return bool|mixed
+        * @return array|bool
         */
        function fetchRow( $res ) {
                if ( $res instanceof ResultWrapper ) {