From d1d179dfa62fe25d75674b2821c47b217509e5d0 Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Mon, 1 Jul 2019 22:30:14 +0200 Subject: [PATCH] Adjust type hints in file related classes Change-Id: I3811e0d9a3297293bc52c1a98f3e8fdb5a3d0e85 --- includes/filerepo/FileRepo.php | 14 +++++++------- includes/filerepo/ForeignAPIRepo.php | 2 +- includes/filerepo/file/LocalFile.php | 3 ++- includes/page/ImagePage.php | 4 ++-- includes/page/WikiFilePage.php | 6 +++--- 5 files changed, 15 insertions(+), 14 deletions(-) diff --git a/includes/filerepo/FileRepo.php b/includes/filerepo/FileRepo.php index 51cef81029..cbbffe4512 100644 --- a/includes/filerepo/FileRepo.php +++ b/includes/filerepo/FileRepo.php @@ -121,13 +121,13 @@ class FileRepo { /** @var bool Whether all zones should be private (e.g. private wiki repo) */ protected $isPrivate; - /** @var array callable Override these in the base class */ + /** @var callable Override these in the base class */ protected $fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ]; - /** @var array callable|bool Override these in the base class */ + /** @var callable|false Override these in the base class */ protected $oldFileFactory = false; - /** @var array callable|bool Override these in the base class */ + /** @var callable|false Override these in the base class */ protected $fileFactoryKey = false; - /** @var array callable|bool Override these in the base class */ + /** @var callable|false Override these in the base class */ protected $oldFileFactoryKey = false; /** @var string URL of where to proxy thumb.php requests to. @@ -230,7 +230,7 @@ class FileRepo { /** * Check if a single zone or list of zones is defined for usage * - * @param array $doZones Only do a particular zones + * @param string[]|string $doZones Only do a particular zones * @throws MWException * @return Status */ @@ -734,7 +734,7 @@ class FileRepo { /** * Make an url to this repo * - * @param string $query Query string to append + * @param string|string[] $query Query string to append * @param string $entry Entry point; defaults to index * @return string|bool False on failure */ @@ -1739,7 +1739,7 @@ class FileRepo { /** * Create a new good result * - * @param null|string $value + * @param null|mixed $value * @return Status */ public function newGood( $value = null ) { diff --git a/includes/filerepo/ForeignAPIRepo.php b/includes/filerepo/ForeignAPIRepo.php index 2c6f29632f..8ff8143c2b 100644 --- a/includes/filerepo/ForeignAPIRepo.php +++ b/includes/filerepo/ForeignAPIRepo.php @@ -184,7 +184,7 @@ class ForeignAPIRepo extends FileRepo { /** * @param array $query - * @return string + * @return array|null */ function fetchImageQuery( $query ) { global $wgLanguageCode; diff --git a/includes/filerepo/file/LocalFile.php b/includes/filerepo/file/LocalFile.php index d7d6bf78d8..54fc251f4b 100644 --- a/includes/filerepo/file/LocalFile.php +++ b/includes/filerepo/file/LocalFile.php @@ -25,6 +25,7 @@ use Wikimedia\AtEase\AtEase; use MediaWiki\Logger\LoggerFactory; use Wikimedia\Rdbms\Database; use Wikimedia\Rdbms\IDatabase; +use Wikimedia\Rdbms\IResultWrapper; use MediaWiki\MediaWikiServices; /** @@ -99,7 +100,7 @@ class LocalFile extends File { /** @var int Number of line to return by nextHistoryLine() (constructor) */ private $historyLine; - /** @var int Result of the query for the file's history (nextHistoryLine) */ + /** @var IResultWrapper|null Result of the query for the file's history (nextHistoryLine) */ private $historyRes; /** @var string Major MIME type */ diff --git a/includes/page/ImagePage.php b/includes/page/ImagePage.php index 12cfe831f5..16b83d1f50 100644 --- a/includes/page/ImagePage.php +++ b/includes/page/ImagePage.php @@ -29,7 +29,7 @@ use Wikimedia\Rdbms\ResultWrapper; * @ingroup Media */ class ImagePage extends Article { - /** @var File */ + /** @var File|false */ private $displayImg; /** @var FileRepo */ @@ -801,7 +801,7 @@ EOT } /** - * @param string $target + * @param string|string[] $target * @param int $limit * @return ResultWrapper */ diff --git a/includes/page/WikiFilePage.php b/includes/page/WikiFilePage.php index 013dd75384..acd506ba79 100644 --- a/includes/page/WikiFilePage.php +++ b/includes/page/WikiFilePage.php @@ -29,13 +29,13 @@ use Wikimedia\Rdbms\FakeResultWrapper; * @ingroup Media */ class WikiFilePage extends WikiPage { - /** @var File */ + /** @var File|false */ protected $mFile = false; - /** @var LocalRepo */ + /** @var LocalRepo|null */ protected $mRepo = null; /** @var bool */ protected $mFileLoaded = false; - /** @var array */ + /** @var array|null */ protected $mDupes = null; public function __construct( $title ) { -- 2.20.1