1 files changed, 52 insertions, 19 deletions

diff --git a/includes/db/DatabaseUtility.php b/includes/db/DatabaseUtility.php
index de58bab6..c1e80d33 100644
--- a/includes/db/DatabaseUtility.php
+++ b/includes/db/DatabaseUtility.php
@@ -51,7 +51,8 @@ class DBObject {
  * This allows us to distinguish a blob from a normal string and an array of strings
  */
 class Blob {
-	private $mData;
+	/** @var string */
+	protected $mData;
 
 	function __construct( $data ) {
 		$this->mData = $data;
@@ -97,13 +98,23 @@ interface Field {
  * @ingroup Database
  */
 class ResultWrapper implements Iterator {
-	var $db, $result, $pos = 0, $currentRow = null;
+	/** @var resource */
+	public $result;
+
+	/** @var DatabaseBase */
+	protected $db;
+
+	/** @var int */
+	protected $pos = 0;
+
+	/** @var object|null */
+	protected $currentRow = null;
 
 	/**
 	 * Create a new result object from a result resource and a Database object
 	 *
 	 * @param DatabaseBase $database
-	 * @param resource $result
+	 * @param resource|ResultWrapper $result
 	 */
 	function __construct( $database, $result ) {
 		$this->db = $database;
@@ -118,7 +129,7 @@ class ResultWrapper implements Iterator {
 	/**
 	 * Get the number of rows in a result object
 	 *
-	 * @return integer
+	 * @return int
 	 */
 	function numRows() {
 		return $this->db->numRows( $this );
@@ -129,7 +140,7 @@ class ResultWrapper implements Iterator {
 	 * Fields can be retrieved with $row->fieldname, with fields acting like
 	 * member variables.
 	 *
-	 * @return object
+	 * @return stdClass
 	 * @throws DBUnexpectedError Thrown if the database returns an error
 	 */
 	function fetchObject() {
@@ -140,7 +151,7 @@ class ResultWrapper implements Iterator {
 	 * Fetch the next row from the given result object, in associative array
 	 * form. Fields are retrieved with $row['fieldname'].
 	 *
-	 * @return Array
+	 * @return array
 	 * @throws DBUnexpectedError Thrown if the database returns an error
 	 */
 	function fetchRow() {
@@ -160,14 +171,14 @@ class ResultWrapper implements Iterator {
 	 * Change the position of the cursor in a result object.
 	 * See mysql_data_seek()
 	 *
-	 * @param $row integer
+	 * @param int $row
 	 */
 	function seek( $row ) {
 		$this->db->dataSeek( $this, $row );
 	}
 
-	/*********************
-	 * Iterator functions
+	/*
+	 * ======= Iterator functions =======
 	 * Note that using these in combination with the non-iterator functions
 	 * above may cause rows to be skipped or repeated.
 	 */
@@ -181,12 +192,13 @@ class ResultWrapper implements Iterator {
 	}
 
 	/**
-	 * @return int
+	 * @return stdClass|array|bool
 	 */
 	function current() {
 		if ( is_null( $this->currentRow ) ) {
 			$this->next();
 		}
+
 		return $this->currentRow;
 	}
 
@@ -198,11 +210,12 @@ class ResultWrapper implements Iterator {
 	}
 
 	/**
-	 * @return int
+	 * @return stdClass
 	 */
 	function next() {
 		$this->pos++;
 		$this->currentRow = $this->fetchObject();
+
 		return $this->currentRow;
 	}
 
@@ -219,10 +232,17 @@ class ResultWrapper implements Iterator {
  * doesn't go anywhere near an actual database.
  */
 class FakeResultWrapper extends ResultWrapper {
-	var $result = array();
-	var $db = null; // And it's going to stay that way :D
-	var $pos = 0;
-	var $currentRow = null;
+	/** @var array */
+	public $result = array();
+
+	/** @var null And it's going to stay that way :D */
+	protected $db = null;
+
+	/** @var int */
+	protected $pos = 0;
+
+	/** @var array|stdClass|bool */
+	protected $currentRow = null;
 
 	function __construct( $array ) {
 		$this->result = $array;
@@ -235,6 +255,9 @@ class FakeResultWrapper extends ResultWrapper {
 		return count( $this->result );
 	}
 
+	/**
+	 * @return array|bool
+	 */
 	function fetchRow() {
 		if ( $this->pos < count( $this->result ) ) {
 			$this->currentRow = $this->result[$this->pos];
@@ -256,7 +279,10 @@ class FakeResultWrapper extends ResultWrapper {
 	function free() {
 	}
 
-	// Callers want to be able to access fields with $this->fieldName
+	/**
+	 * Callers want to be able to access fields with $this->fieldName
+	 * @return bool|stdClass
+	 */
 	function fetchObject() {
 		$this->fetchRow();
 		if ( $this->currentRow ) {
@@ -271,16 +297,21 @@ class FakeResultWrapper extends ResultWrapper {
 		$this->currentRow = null;
 	}
 
+	/**
+	 * @return bool|stdClass
+	 */
 	function next() {
 		return $this->fetchObject();
 	}
 }
 
 /**
- * Used by DatabaseBase::buildLike() to represent characters that have special meaning in SQL LIKE clauses
- * and thus need no escaping. Don't instantiate it manually, use DatabaseBase::anyChar() and anyString() instead.
+ * Used by DatabaseBase::buildLike() to represent characters that have special
+ * meaning in SQL LIKE clauses and thus need no escaping. Don't instantiate it
+ * manually, use DatabaseBase::anyChar() and anyString() instead.
  */
 class LikeMatch {
+	/** @var string */
 	private $str;
 
 	/**
@@ -295,7 +326,7 @@ class LikeMatch {
 	/**
 	 * Return the original stored string.
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function toString() {
 		return $this->str;
@@ -304,6 +335,8 @@ class LikeMatch {
 
 /**
  * An object representing a master or slave position in a replicated setup.
+ *
+ * The implementation details of this opaque type are up to the database subclass.
  */
 interface DBMasterPos {
 }