wikimedia / mediawiki

includes/db/DatabaseMysqlBase.php

Doc Comments +10 added lines, -4 removed lines

@@ -228,7 +228,7 @@ 
 
 	/**
 	 * @param ResultWrapper|resource $res
-	 * @return stdClass|bool
+	 * @return stdClass
 	 * @throws DBUnexpectedError
 	 */
 	function fetchObject( $res ) {
@@ -363,7 +363,7 @@ 
 	/**
 	 * Get the name of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -386,7 +386,7 @@ 
 	/**
 	 * Get the type of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -408,7 +408,7 @@ 
 	/**
 	 * Move internal result pointer
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $row
 	 * @return bool
 	 */
@@ -941,6 +941,9 @@ 
 		return ( $row->lockstatus == 1 );
 	}
 
+	/**
+	 * @param string $lockName
+	 */
 	private function makeLockName( $lockName ) {
 		// http://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
 		// Newer version enforce a 64 char length limit.
@@ -1296,6 +1299,9 @@ 
 		$is_pk, $is_unique, $is_multiple, $is_key, $type, $binary,
 		$is_numeric, $is_blob, $is_unsigned, $is_zerofill;
 
+	/**
+	 * @param stdClass $info
+	 */
 	function __construct( $info ) {
 		$this->name = $info->name;
 		$this->tablename = $info->table;

includes/db/DatabaseOracle.php

Doc Comments +20 added lines, -5 removed lines

@@ -85,6 +85,9 @@ 
 		unset( $this->db );
 	}
 
+	/**
+	 * @param integer $row
+	 */
 	public function seek( $row ) {
 		$this->cursor = min( $row, $this->nrows );
 	}
@@ -356,12 +359,15 @@ 
 	/**
 	 * Closes a database connection, if it is open
 	 * Returns success, true if already closed
-	 * @return bool
+	 * @return boolean|null
 	 */
 	protected function closeConnection() {
 		return oci_close( $this->mConn );
 	}
 
+	/**
+	 * @return integer|null
+	 */
 	function execFlags() {
 		return $this->mTrxLevel ? OCI_NO_AUTO_COMMIT : OCI_COMMIT_ON_SUCCESS;
 	}
@@ -484,7 +490,7 @@ 
 
 	/**
 	 * This must be called after nextSequenceVal
-	 * @return null|int
+	 * @return integer
 	 */
 	function insertId() {
 		return $this->mInsertId;
@@ -571,6 +577,9 @@ 
 		return $retVal;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	private function fieldBindStatement( $table, $col, &$val, $includeCol = false ) {
 		$col_info = $this->fieldInfoMulti( $table, $col );
 		$col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
@@ -610,7 +619,7 @@ 
 	 * @param string $table
 	 * @param array $row
 	 * @param string $fname
-	 * @return bool
+	 * @return boolean|null
 	 * @throws DBUnexpectedError
 	 */
 	private function insertOneRow( $table, $row, $fname ) {
@@ -812,6 +821,9 @@ 
 		return strtoupper( parent::tableName( $name, $format ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function tableNameInternal( $name ) {
 		$name = $this->tableName( $name );
 
@@ -1269,6 +1281,9 @@ 
 		return "'" . $this->strencode( $s ) . "'";
 	}
 
+	/**
+	 * @param string $s
+	 */
 	public function addIdentifierQuotes( $s ) {
 		if ( !$this->getFlag( DBO_DDLMODE ) ) {
 			$s = '/*Q*/' . $s;
@@ -1332,7 +1347,7 @@ 
 	 *
 	 * @param array $options An associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		$preLimitTail = $postLimitTail = '';
@@ -1406,7 +1421,7 @@ 
 	 * @param array $conds
 	 * @param string $fname
 	 * @param array $options
-	 * @return bool
+	 * @return boolean|null
 	 * @throws DBUnexpectedError
 	 */
 	function update( $table, $values, $conds, $fname = __METHOD__, $options = array() ) {

includes/db/DatabasePostgres.php

Doc Comments +18 added lines, -2 removed lines

@@ -168,6 +168,11 @@ 
 		}
 	}
 
+	/**
+	 * @param string $keyword
+	 * @param string $msg_ok
+	 * @param string $msg_failed
+	 */
 	protected function query( $keyword, $msg_ok, $msg_failed ) {
 		if ( $this->dbw->doQuery( $keyword . " " . $this->id ) !== false ) {
 		} else {
@@ -259,6 +264,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function hasConstraint( $name ) {
 		$sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
 			"WHERE c.connamespace = n.oid AND conname = '" .
@@ -550,7 +558,7 @@ 
 	 * Return the result of the last call to nextSequenceValue();
 	 * This must be called after nextSequenceValue().
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	function insertId() {
 		return $this->mInsertId;
@@ -1310,6 +1318,10 @@ 
 		return $this->relationExists( $sequence, 'S', $schema );
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $trigger
+	 */
 	function triggerExists( $table, $trigger ) {
 		$q = <<<SQL
 	SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -1333,6 +1345,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			array(
@@ -1475,7 +1491,7 @@ 
 	 *
 	 * @param array $options An associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		$preLimitTail = $postLimitTail = '';

includes/db/DatabaseSqlite.php

Doc Comments +4 added lines, -1 removed lines

@@ -551,7 +551,7 @@ 
 	 * Filter the options used in SELECT statements
 	 *
 	 * @param array $options
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		foreach ( $options as $k => $v ) {
@@ -1048,6 +1048,9 @@ 
 class SQLiteField implements Field {
 	private $info, $tableName;
 
+	/**
+	 * @param string $tableName
+	 */
 	function __construct( $info, $tableName ) {
 		$this->info = $info;
 		$this->tableName = $tableName;

includes/db/DatabaseUtility.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
 	/** @var string */
 	protected $mData;
 
+	/**
+	 * @param string $data
+	 */
 	function __construct( $data ) {
 		$this->mData = $data;
 	}

includes/db/DBConnRef.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function __call( $name, array $arguments ) {
 		if ( $this->conn === null ) {
 			list( $db, $groups, $wiki ) = $this->params;

includes/db/loadbalancer/LoadBalancer.php

Doc Comments +4 added lines, -4 removed lines

@@ -230,7 +230,7 @@ 
 	 * @param string|bool $group Query group, or false for the generic reader
 	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @throws MWException
-	 * @return bool|int|string
+	 * @return string
 	 */
 	public function getReaderIndex( $group = false, $wiki = false ) {
 		global $wgDBtype;
@@ -435,7 +435,7 @@ 
 	 * Returns false if there is no connection open
 	 *
 	 * @param int $i
-	 * @return DatabaseBase|bool False on failure
+	 * @return DatabaseBase|null False on failure
 	 */
 	public function getAnyOpenConnection( $i ) {
 		foreach ( $this->mConns as $conns ) {
@@ -968,7 +968,7 @@ 
 
 	/**
 	 * Get the current master position for chronology control purposes
-	 * @return mixed
+	 * @return DBMasterPos
 	 */
 	public function getMasterPos() {
 		# If this entire request was served from a slave without opening a connection to the
@@ -1266,7 +1266,7 @@ 
 	/**
 	 * Call a function with each open connection object
 	 * @param callable $callback
-	 * @param array $params
+	 * @param string[] $params
 	 */
 	public function forEachOpenConnection( $callback, array $params = array() ) {
 		foreach ( $this->mConns as $conns2 ) {

includes/deferred/CdnCacheUpdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	/**
 	 * Create an update object from an array of Title objects, or a TitleArray object
 	 *
-	 * @param Traversable|array $titles
+	 * @param TitleArrayFromResult|null $titles
 	 * @param string[] $urlArr
 	 * @return CdnCacheUpdate
 	 */

includes/deferred/SearchUpdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * @param int $id Page id to update
 	 * @param Title|string $title Title of page to update
-	 * @param Content|string|bool $c Content of the page to update. Default: false.
+	 * @param Content|null $c Content of the page to update. Default: false.
 	 *  If a Content object, text will be gotten from it. String is for back-compat.
 	 *  Passing false tells the backend to just update the title, not the content
 	 */