From: Umherirrender Date: Mon, 3 Jun 2019 17:39:57 +0000 (+0200) Subject: Adjust type hints in database related classes X-Git-Tag: 1.34.0-rc.0~1485^2 X-Git-Url: http://git.cyclocoop.org/?a=commitdiff_plain;h=348a784f486b84a12296bf42324b975a151f1e6b;p=lhc%2Fweb%2Fwiklou.git Adjust type hints in database related classes Change from ResultWrapper to IResultWrapper Change from mysqli_result to resource Changed mixed to return hint of interface Document that fieldInfo returns bool Change-Id: I5572fd41e0e11a2bc2eb116d0c82327499ecc518 --- diff --git a/includes/db/DatabaseOracle.php b/includes/db/DatabaseOracle.php index f4753d67e6..5df7aef620 100644 --- a/includes/db/DatabaseOracle.php +++ b/includes/db/DatabaseOracle.php @@ -26,6 +26,7 @@ use Wikimedia\Rdbms\Database; use Wikimedia\Rdbms\DatabaseDomain; use Wikimedia\Rdbms\Blob; use Wikimedia\Rdbms\ResultWrapper; +use Wikimedia\Rdbms\IResultWrapper; use Wikimedia\Rdbms\DBConnectionError; use Wikimedia\Rdbms\DBUnexpectedError; use Wikimedia\Rdbms\DBExpectedError; @@ -250,7 +251,7 @@ class DatabaseOracle extends Database { /** * Frees resources associated with the LOB descriptor - * @param ResultWrapper|ORAResult $res + * @param IResultWrapper|ORAResult $res */ function freeResult( $res ) { if ( $res instanceof ResultWrapper ) { @@ -261,8 +262,8 @@ class DatabaseOracle extends Database { } /** - * @param ResultWrapper|ORAResult $res - * @return mixed + * @param IResultWrapper|ORAResult $res + * @return stdClass|bool */ function fetchObject( $res ) { if ( $res instanceof ResultWrapper ) { @@ -273,8 +274,8 @@ class DatabaseOracle extends Database { } /** - * @param ResultWrapper|ORAResult $res - * @return mixed + * @param IResultWrapper|ORAResult $res + * @return stdClass|bool */ function fetchRow( $res ) { if ( $res instanceof ResultWrapper ) { @@ -285,7 +286,7 @@ class DatabaseOracle extends Database { } /** - * @param ResultWrapper|ORAResult $res + * @param IResultWrapper|ORAResult $res * @return int */ function numRows( $res ) { @@ -297,7 +298,7 @@ class DatabaseOracle extends Database { } /** - * @param ResultWrapper|ORAResult $res + * @param IResultWrapper|ORAResult $res * @return int */ function numFields( $res ) { diff --git a/includes/libs/rdbms/database/Database.php b/includes/libs/rdbms/database/Database.php index de9ea552a7..fe23a384a4 100644 --- a/includes/libs/rdbms/database/Database.php +++ b/includes/libs/rdbms/database/Database.php @@ -1284,7 +1284,7 @@ abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAware * @param string $commentedSql SQL query with debugging/trace comment * @param bool $isEffectiveWrite Whether the query is a (non-temporary table) write * @param string $fname Name of the calling function - * @return bool|ResultWrapper True for a successful write query, ResultWrapper + * @return bool|IResultWrapper True for a successful write query, ResultWrapper * object for a successful read query, or false on failure */ private function attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname ) { @@ -4112,8 +4112,8 @@ abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAware * a wrapper. Nowadays, raw database objects are never exposed to external * callers, so this is unnecessary in external code. * - * @param bool|ResultWrapper|resource $result - * @return bool|ResultWrapper + * @param bool|IResultWrapper|resource $result + * @return bool|IResultWrapper */ protected function resultObject( $result ) { if ( !$result ) { @@ -4603,7 +4603,7 @@ abstract class Database implements IDatabase, IMaintainableDatabase, LoggerAware * Delete a table * @param string $tableName * @param string $fName - * @return bool|ResultWrapper + * @return bool|IResultWrapper * @since 1.18 */ public function dropTable( $tableName, $fName = __METHOD__ ) { diff --git a/includes/libs/rdbms/database/DatabaseMssql.php b/includes/libs/rdbms/database/DatabaseMssql.php index 6d266ae3ba..a532ec2810 100644 --- a/includes/libs/rdbms/database/DatabaseMssql.php +++ b/includes/libs/rdbms/database/DatabaseMssql.php @@ -1358,7 +1358,7 @@ class DatabaseMssql extends Database { * Delete a table * @param string $tableName * @param string $fName - * @return bool|ResultWrapper + * @return bool|IResultWrapper * @since 1.18 */ public function dropTable( $tableName, $fName = __METHOD__ ) { diff --git a/includes/libs/rdbms/database/DatabaseMysqlBase.php b/includes/libs/rdbms/database/DatabaseMysqlBase.php index 36c947f6eb..6d28717abf 100644 --- a/includes/libs/rdbms/database/DatabaseMysqlBase.php +++ b/includes/libs/rdbms/database/DatabaseMysqlBase.php @@ -277,7 +277,7 @@ abstract class DatabaseMysqlBase extends Database { abstract protected function mysqlSetCharset( $charset ); /** - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @throws DBUnexpectedError */ public function freeResult( $res ) { @@ -301,7 +301,7 @@ abstract class DatabaseMysqlBase extends Database { abstract protected function mysqlFreeResult( $res ); /** - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @return stdClass|bool * @throws DBUnexpectedError */ @@ -374,7 +374,7 @@ abstract class DatabaseMysqlBase extends Database { /** * @throws DBUnexpectedError - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @return int */ function numRows( $res ) { @@ -402,7 +402,7 @@ abstract class DatabaseMysqlBase extends Database { abstract protected function mysqlNumRows( $res ); /** - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @return int */ public function numFields( $res ) { @@ -422,7 +422,7 @@ abstract class DatabaseMysqlBase extends Database { abstract protected function mysqlNumFields( $res ); /** - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $n * @return string */ @@ -437,7 +437,7 @@ abstract class DatabaseMysqlBase extends Database { /** * Get the name of the specified field in a result * - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $n * @return string */ @@ -445,7 +445,7 @@ abstract class DatabaseMysqlBase extends Database { /** * mysql_field_type() wrapper - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $n * @return string */ @@ -460,14 +460,14 @@ abstract class DatabaseMysqlBase extends Database { /** * Get the type of the specified field in a result * - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $n * @return string */ abstract protected function mysqlFieldType( $res, $n ); /** - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $row * @return bool */ @@ -482,7 +482,7 @@ abstract class DatabaseMysqlBase extends Database { /** * Move internal result pointer * - * @param ResultWrapper|resource $res + * @param IResultWrapper|resource $res * @param int $row * @return bool */ @@ -1490,7 +1490,7 @@ abstract class DatabaseMysqlBase extends Database { /** * @param string $tableName * @param string $fName - * @return bool|ResultWrapper + * @return bool|IResultWrapper */ public function dropTable( $tableName, $fName = __METHOD__ ) { if ( !$this->tableExists( $tableName, $fName ) ) { diff --git a/includes/libs/rdbms/database/DatabaseSqlite.php b/includes/libs/rdbms/database/DatabaseSqlite.php index c9942a5906..8e1b06d6e6 100644 --- a/includes/libs/rdbms/database/DatabaseSqlite.php +++ b/includes/libs/rdbms/database/DatabaseSqlite.php @@ -303,7 +303,7 @@ class DatabaseSqlite extends Database { * @param bool|string $file Database file name. If omitted, will be generated * using $name and configured data directory * @param string $fname Calling function name - * @return ResultWrapper + * @return IResultWrapper */ function attachDatabase( $name, $file = false, $fname = __METHOD__ ) { if ( !$file ) { @@ -330,7 +330,7 @@ class DatabaseSqlite extends Database { * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result * * @param string $sql - * @return bool|ResultWrapper + * @return bool|IResultWrapper */ protected function doQuery( $sql ) { $res = $this->getBindingHandle()->query( $sql ); @@ -346,7 +346,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper|mixed $res + * @param IResultWrapper|mixed $res */ function freeResult( $res ) { if ( $res instanceof ResultWrapper ) { @@ -357,7 +357,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper|array $res + * @param IResultWrapper|array $res * @return stdClass|bool */ function fetchObject( $res ) { @@ -384,7 +384,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper|mixed $res + * @param IResultWrapper|mixed $res * @return array|bool */ function fetchRow( $res ) { @@ -406,7 +406,7 @@ class DatabaseSqlite extends Database { /** * The PDO::Statement class implements the array interface so count() will work * - * @param ResultWrapper|array|false $res + * @param IResultWrapper|array|false $res * @return int */ function numRows( $res ) { @@ -417,7 +417,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper $res + * @param IResultWrapper $res * @return int */ function numFields( $res ) { @@ -432,7 +432,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper $res + * @param IResultWrapper $res * @param int $n * @return bool */ @@ -474,7 +474,7 @@ class DatabaseSqlite extends Database { } /** - * @param ResultWrapper|array $res + * @param IResultWrapper|array $res * @param int $row */ function dataSeek( $res, $row ) { @@ -990,7 +990,7 @@ class DatabaseSqlite extends Database { * @param string $newName * @param bool $temporary * @param string $fname - * @return bool|ResultWrapper + * @return bool|IResultWrapper * @throws RuntimeException */ function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ ) { @@ -1086,7 +1086,7 @@ class DatabaseSqlite extends Database { * * @param string $tableName * @param string $fName - * @return bool|ResultWrapper + * @return bool|IResultWrapper * @throws DBReadOnlyError */ public function dropTable( $tableName, $fName = __METHOD__ ) { diff --git a/includes/libs/rdbms/database/IDatabase.php b/includes/libs/rdbms/database/IDatabase.php index 333bd81643..90e30fa08e 100644 --- a/includes/libs/rdbms/database/IDatabase.php +++ b/includes/libs/rdbms/database/IDatabase.php @@ -217,7 +217,7 @@ interface IDatabase { * the LB info array is set to that parameter. If it is called with two * parameters, the member with the given name is set to the given value. * - * @param string $name + * @param array|string $name * @param array|null $value */ public function setLBInfo( $name, $value = null ); diff --git a/includes/libs/rdbms/database/IMaintainableDatabase.php b/includes/libs/rdbms/database/IMaintainableDatabase.php index 5706435dc5..28e94a0680 100644 --- a/includes/libs/rdbms/database/IMaintainableDatabase.php +++ b/includes/libs/rdbms/database/IMaintainableDatabase.php @@ -150,7 +150,7 @@ interface IMaintainableDatabase extends IDatabase { * Delete a table * @param string $tableName * @param string $fName - * @return bool|ResultWrapper + * @return bool|IResultWrapper */ public function dropTable( $tableName, $fName = __METHOD__ ); @@ -303,7 +303,7 @@ interface IMaintainableDatabase extends IDatabase { * @param string $table Table name * @param string $field Field name * - * @return Field + * @return false|Field */ public function fieldInfo( $table, $field ); }