From 2c87b59f35cff478ce82cc63d46a56ed33072a62 Mon Sep 17 00:00:00 2001
From: Aaron Schulz <aschulz@wikimedia.org>
Date: Thu, 29 Aug 2019 16:03:43 -0700
Subject: [PATCH] filerepo: Use @method LocalRepo::newFile() to document the
 return type

This avoids PhpStorm IDE warnings

Change-Id: I521aa1b1243ceabd40e7da18bf73ab95af7039cc
---
 includes/filerepo/LocalRepo.php                      | 1 +
 includes/filerepo/file/LocalFileMoveBatch.php        | 2 --
 includes/import/ImportableUploadRevisionImporter.php | 1 -
 includes/revisiondelete/RevDelFileList.php           | 2 --
 maintenance/deleteArchivedFiles.php                  | 2 --
 maintenance/importImages.php                         | 1 -
 6 files changed, 1 insertion(+), 8 deletions(-)

diff --git a/includes/filerepo/LocalRepo.php b/includes/filerepo/LocalRepo.php
index 8e3355c8c6..84c0a614d2 100644
--- a/includes/filerepo/LocalRepo.php
+++ b/includes/filerepo/LocalRepo.php
@@ -32,6 +32,7 @@ use Wikimedia\Rdbms\IDatabase;
  * in the wiki's own database. This is the most commonly used repository class.
  *
  * @ingroup FileRepo
+ * @method LocalFile|null newFile( $title, $time = false )
  */
 class LocalRepo extends FileRepo {
 	/** @var callable */
diff --git a/includes/filerepo/file/LocalFileMoveBatch.php b/includes/filerepo/file/LocalFileMoveBatch.php
index 137119d2bc..21980b90eb 100644
--- a/includes/filerepo/file/LocalFileMoveBatch.php
+++ b/includes/filerepo/file/LocalFileMoveBatch.php
@@ -126,10 +126,8 @@ class LocalFileMoveBatch {
 	public function execute() {
 		$repo = $this->file->repo;
 		$status = $repo->newGood();
-		/** @var LocalFile $destFile */
 		$destFile = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()
 			->newFile( $this->target );
-		'@phan-var LocalFile $destFile';
 
 		$this->file->lock();
 		$destFile->lock(); // quickly fail if destination is not available
diff --git a/includes/import/ImportableUploadRevisionImporter.php b/includes/import/ImportableUploadRevisionImporter.php
index e5f4b5748a..4be13b0a2c 100644
--- a/includes/import/ImportableUploadRevisionImporter.php
+++ b/includes/import/ImportableUploadRevisionImporter.php
@@ -114,7 +114,6 @@ class ImportableUploadRevisionImporter implements UploadRevisionImporter {
 				$user
 			);
 		} else {
-			'@phan-var LocalFile $file';
 			$flags = 0;
 			$status = $file->upload(
 				$source,
diff --git a/includes/revisiondelete/RevDelFileList.php b/includes/revisiondelete/RevDelFileList.php
index 334dccfcfe..ca7bc040d0 100644
--- a/includes/revisiondelete/RevDelFileList.php
+++ b/includes/revisiondelete/RevDelFileList.php
@@ -110,10 +110,8 @@ class RevDelFileList extends RevDelList {
 	}
 
 	public function doPostCommitUpdates( array $visibilityChangeMap ) {
-		/** @var LocalFile $file */
 		$file = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()
 			->newFile( $this->title );
-		'@phan-var LocalFile $file';
 		$file->purgeCache();
 		$file->purgeDescription();
 
diff --git a/maintenance/deleteArchivedFiles.php b/maintenance/deleteArchivedFiles.php
index 7b2ef17a31..cb95b68027 100644
--- a/maintenance/deleteArchivedFiles.php
+++ b/maintenance/deleteArchivedFiles.php
@@ -66,9 +66,7 @@ class DeleteArchivedFiles extends Maintenance {
 				continue;
 			}
 
-			/** @var LocalFile $file */
 			$file = $repo->newFile( $row->fa_name );
-			'@phan-var LocalFile $file';
 			try {
 				$file->lock();
 			} catch ( LocalFileLockError $e ) {
diff --git a/maintenance/importImages.php b/maintenance/importImages.php
index 7f8e16a6b1..4065978e89 100644
--- a/maintenance/importImages.php
+++ b/maintenance/importImages.php
@@ -332,7 +332,6 @@ class ImportImages extends Maintenance {
 
 				if ( $this->hasOption( 'dry' ) ) {
 					$this->output( "done.\n" );
-					// @phan-suppress-next-line PhanUndeclaredMethod
 				} elseif ( $image->recordUpload2(
 					$archive->value,
 					$summary,
-- 
2.20.1