From 14d9e80ba42c471f1c9e92c5cb6808b4723b5945 Mon Sep 17 00:00:00 2001
From: Fomafix <fomafix@googlemail.com>
Date: Sat, 2 Feb 2019 14:39:58 +0100
Subject: [PATCH] Fix order of @var parameter in PHP

Replace

 @var $foo type

by

 @var type $foo

Change-Id: Iec8b90ffea4028a1005daef422b7c4ec38c2715f
---
 img_auth.php                                         |  2 +-
 includes/diff/DifferenceEngine.php                   |  2 +-
 includes/diff/TextSlotDiffRenderer.php               |  2 +-
 includes/installer/DatabaseUpdater.php               |  2 +-
 includes/installer/MssqlInstaller.php                |  4 ++--
 includes/installer/MysqlInstaller.php                |  6 +++---
 includes/installer/PostgresInstaller.php             | 10 +++++-----
 includes/page/ImagePage.php                          |  2 +-
 includes/preferences/DefaultPreferencesFactory.php   |  2 +-
 .../widget/search/InterwikiSearchResultSetWidget.php | 12 ++++++------
 maintenance/Maintenance.php                          |  4 ++--
 maintenance/cleanupSpam.php                          |  4 ++--
 maintenance/generateSitemap.php                      |  2 +-
 maintenance/storage/checkStorage.php                 |  2 +-
 .../phpunit/includes/content/ContentHandlerTest.php  |  8 ++++----
 .../includes/content/TextContentHandlerTest.php      |  4 ++--
 tests/phpunit/includes/diff/DifferenceEngineTest.php |  4 ++--
 tests/phpunit/includes/page/WikiPageDbTestBase.php   |  2 +-
 tests/phpunit/includes/search/SearchEngineTest.php   |  2 +-
 19 files changed, 38 insertions(+), 38 deletions(-)

diff --git a/img_auth.php b/img_auth.php
index ca69d31d53..e6b6e1b67e 100644
--- a/img_auth.php
+++ b/img_auth.php
@@ -148,7 +148,7 @@ function wfImageAuthMain() {
 		}
 
 		// Run hook for extension authorization plugins
-		/** @var $result array */
+		/** @var array $result */
 		$result = null;
 		if ( !Hooks::run( 'ImgAuthBeforeStream', [ &$title, &$path, &$name, &$result ] ) ) {
 			wfForbidden( $result[0], $result[1], array_slice( $result, 2 ) );
diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php
index e39334f3d7..833bc6950d 100644
--- a/includes/diff/DifferenceEngine.php
+++ b/includes/diff/DifferenceEngine.php
@@ -250,7 +250,7 @@ class DifferenceEngine extends ContextSource {
 
 			$slotContents = $this->getSlotContents();
 			$this->slotDiffRenderers = array_map( function ( $contents ) {
-				/** @var $content Content */
+				/** @var Content $content */
 				$content = $contents['new'] ?: $contents['old'];
 				return $content->getContentHandler()->getSlotDiffRenderer( $this->getContext() );
 			}, $slotContents );
diff --git a/includes/diff/TextSlotDiffRenderer.php b/includes/diff/TextSlotDiffRenderer.php
index 001944c5be..bb965e1781 100644
--- a/includes/diff/TextSlotDiffRenderer.php
+++ b/includes/diff/TextSlotDiffRenderer.php
@@ -72,7 +72,7 @@ class TextSlotDiffRenderer extends SlotDiffRenderer {
 	 * @return string
 	 */
 	public static function diff( $oldText, $newText ) {
-		/** @var $slotDiffRenderer TextSlotDiffRenderer */
+		/** @var TextSlotDiffRenderer $slotDiffRenderer */
 		$slotDiffRenderer = ContentHandler::getForModelID( CONTENT_MODEL_TEXT )
 			->getSlotDiffRenderer( RequestContext::getMain() );
 		return $slotDiffRenderer->getTextDiff( $oldText, $newText );
diff --git a/includes/installer/DatabaseUpdater.php b/includes/installer/DatabaseUpdater.php
index 5add0a837e..24f7dc856c 100644
--- a/includes/installer/DatabaseUpdater.php
+++ b/includes/installer/DatabaseUpdater.php
@@ -1224,7 +1224,7 @@ abstract class DatabaseUpdater {
 	 */
 	protected function rebuildLocalisationCache() {
 		/**
-		 * @var $cl RebuildLocalisationCache
+		 * @var RebuildLocalisationCache $cl
 		 */
 		$cl = $this->maintenance->runChild(
 			RebuildLocalisationCache::class, 'rebuildLocalisationCache.php'
diff --git a/includes/installer/MssqlInstaller.php b/includes/installer/MssqlInstaller.php
index e462220785..6d62c439bc 100644
--- a/includes/installer/MssqlInstaller.php
+++ b/includes/installer/MssqlInstaller.php
@@ -187,7 +187,7 @@ class MssqlInstaller extends DatabaseInstaller {
 			return $status;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 
@@ -241,7 +241,7 @@ class MssqlInstaller extends DatabaseInstaller {
 			return;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 		$conn->selectDB( $this->getVar( 'wgDBname' ) );
diff --git a/includes/installer/MysqlInstaller.php b/includes/installer/MysqlInstaller.php
index e9a2d03e2d..74924d0595 100644
--- a/includes/installer/MysqlInstaller.php
+++ b/includes/installer/MysqlInstaller.php
@@ -128,7 +128,7 @@ class MysqlInstaller extends DatabaseInstaller {
 			return $status;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 
@@ -167,7 +167,7 @@ class MysqlInstaller extends DatabaseInstaller {
 			return;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 		$conn->selectDB( $this->getVar( 'wgDBname' ) );
@@ -232,7 +232,7 @@ class MysqlInstaller extends DatabaseInstaller {
 		$status = $this->getConnection();
 
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 
diff --git a/includes/installer/PostgresInstaller.php b/includes/installer/PostgresInstaller.php
index f9ee3197c2..21b6f39720 100644
--- a/includes/installer/PostgresInstaller.php
+++ b/includes/installer/PostgresInstaller.php
@@ -119,7 +119,7 @@ class PostgresInstaller extends DatabaseInstaller {
 			return $status;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 
@@ -190,7 +190,7 @@ class PostgresInstaller extends DatabaseInstaller {
 
 		if ( $status->isOK() ) {
 			/**
-			 * @var $conn Database
+			 * @var Database $conn
 			 */
 			$conn = $status->value;
 			$conn->clearFlag( DBO_TRX );
@@ -242,7 +242,7 @@ class PostgresInstaller extends DatabaseInstaller {
 				$status = $this->openPgConnection( 'create-schema' );
 				if ( $status->isOK() ) {
 					/**
-					 * @var $conn Database
+					 * @var Database $conn
 					 */
 					$conn = $status->value;
 					$safeRole = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
@@ -296,7 +296,7 @@ class PostgresInstaller extends DatabaseInstaller {
 			return false;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 		$superuser = $this->getVar( '_InstallUser' );
@@ -645,7 +645,7 @@ class PostgresInstaller extends DatabaseInstaller {
 			return $status;
 		}
 		/**
-		 * @var $conn Database
+		 * @var Database $conn
 		 */
 		$conn = $status->value;
 
diff --git a/includes/page/ImagePage.php b/includes/page/ImagePage.php
index 6c1ac39bb2..86c59add09 100644
--- a/includes/page/ImagePage.php
+++ b/includes/page/ImagePage.php
@@ -961,7 +961,7 @@ EOT
 		$out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
 
 		/**
-		 * @var $file File
+		 * @var File $file
 		 */
 		foreach ( $dupes as $file ) {
 			$fromSrc = '';
diff --git a/includes/preferences/DefaultPreferencesFactory.php b/includes/preferences/DefaultPreferencesFactory.php
index c45ab4c825..be2bf08660 100644
--- a/includes/preferences/DefaultPreferencesFactory.php
+++ b/includes/preferences/DefaultPreferencesFactory.php
@@ -1450,7 +1450,7 @@ class DefaultPreferencesFactory implements PreferencesFactory {
 		}
 
 		/**
-		 * @var $htmlForm HTMLForm
+		 * @var HTMLForm $htmlForm
 		 */
 		$htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
 
diff --git a/includes/widget/search/InterwikiSearchResultSetWidget.php b/includes/widget/search/InterwikiSearchResultSetWidget.php
index c0efd24a75..48c624c0f7 100644
--- a/includes/widget/search/InterwikiSearchResultSetWidget.php
+++ b/includes/widget/search/InterwikiSearchResultSetWidget.php
@@ -16,17 +16,17 @@ use OOUI;
  * the results are from.
  */
 class InterwikiSearchResultSetWidget implements SearchResultSetWidget {
-	/** @var SpecialSearch */
+	/** @var SpecialSearch $specialSearch */
 	protected $specialSearch;
-	/** @var SearchResultWidget */
+	/** @var SearchResultWidget $resultWidget */
 	protected $resultWidget;
-	/** @var string[]|null */
+	/** @var string[]|null $customCaptions */
 	protected $customCaptions;
-	/** @var LinkRenderer */
+	/** @var LinkRenderer $linkRenderer */
 	protected $linkRenderer;
-	/** @var InterwikiLookup */
+	/** @var InterwikiLookup $iwLookup */
 	protected $iwLookup;
-	/** @var $output */
+	/** @var \OutputPage $output */
 	protected $output;
 	/** @var bool $showMultimedia */
 	protected $showMultimedia;
diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index 0d4f14c812..1cca26e63b 100644
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -717,7 +717,7 @@ abstract class Maintenance {
 		}
 
 		/**
-		 * @var $child Maintenance
+		 * @var Maintenance $child
 		 */
 		$child = new $maintClass();
 		$child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
@@ -1191,7 +1191,7 @@ abstract class Maintenance {
 
 			if ( $wgDBservers ) {
 				/**
-				 * @var $wgDBservers array
+				 * @var array $wgDBservers
 				 */
 				foreach ( $wgDBservers as $i => $server ) {
 					$wgDBservers[$i]['user'] = $wgDBuser;
diff --git a/maintenance/cleanupSpam.php b/maintenance/cleanupSpam.php
index 04f278f389..e1ea247377 100644
--- a/maintenance/cleanupSpam.php
+++ b/maintenance/cleanupSpam.php
@@ -68,7 +68,7 @@ class CleanupSpam extends Maintenance {
 			$this->output( "Finding spam on " . count( $wgLocalDatabases ) . " wikis\n" );
 			$found = false;
 			foreach ( $wgLocalDatabases as $wikiID ) {
-				/** @var $dbr Database */
+				/** @var Database $dbr */
 				$dbr = $this->getDB( DB_REPLICA, [], $wikiID );
 
 				foreach ( $protConds as $conds ) {
@@ -97,7 +97,7 @@ class CleanupSpam extends Maintenance {
 			// Clean up spam on this wiki
 
 			$count = 0;
-			/** @var $dbr Database */
+			/** @var Database $dbr */
 			$dbr = $this->getDB( DB_REPLICA );
 			foreach ( $protConds as $prot => $conds ) {
 				$res = $dbr->select(
diff --git a/maintenance/generateSitemap.php b/maintenance/generateSitemap.php
index dc1de4f480..af5373c2ef 100644
--- a/maintenance/generateSitemap.php
+++ b/maintenance/generateSitemap.php
@@ -230,7 +230,7 @@ class GenerateSitemap extends Maintenance {
 		// Custom priorities
 		if ( $wgSitemapNamespacesPriorities !== false ) {
 			/**
-			 * @var $wgSitemapNamespacesPriorities array
+			 * @var array $wgSitemapNamespacesPriorities
 			 */
 			foreach ( $wgSitemapNamespacesPriorities as $namespace => $priority ) {
 				$float = floatval( $priority );
diff --git a/maintenance/storage/checkStorage.php b/maintenance/storage/checkStorage.php
index 68184ea242..eed8019ec2 100644
--- a/maintenance/storage/checkStorage.php
+++ b/maintenance/storage/checkStorage.php
@@ -104,7 +104,7 @@ class CheckStorage {
 			);
 			foreach ( $res as $row ) {
 				/**
-				 * @var $flags int
+				 * @var int $flags
 				 */
 				$flags = $row->old_flags;
 				$id = $row->old_id;
diff --git a/tests/phpunit/includes/content/ContentHandlerTest.php b/tests/phpunit/includes/content/ContentHandlerTest.php
index f42f8b49f9..4eecd4dac1 100644
--- a/tests/phpunit/includes/content/ContentHandlerTest.php
+++ b/tests/phpunit/includes/content/ContentHandlerTest.php
@@ -519,7 +519,7 @@ class ContentHandlerTest extends MediaWikiTestCase {
 		$customContentHandler->expects( $this->any() )
 			->method( 'createDifferenceEngine' )
 			->willReturn( $customDifferenceEngine );
-		/** @var $customContentHandler ContentHandler */
+		/** @var ContentHandler $customContentHandler */
 		$slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext::getMain() );
 		$this->assertInstanceOf( DifferenceEngineSlotDiffRenderer::class, $slotDiffRenderer );
 		$this->assertSame(
@@ -553,7 +553,7 @@ class ContentHandlerTest extends MediaWikiTestCase {
 		$customContentHandler2->expects( $this->any() )
 			->method( 'getSlotDiffRendererInternal' )
 			->willReturn( $customSlotDiffRenderer );
-		/** @var $customContentHandler2 ContentHandler */
+		/** @var ContentHandler $customContentHandler2 */
 		$slotDiffRenderer = $customContentHandler2->getSlotDiffRenderer( RequestContext::getMain() );
 		$this->assertSame( $customSlotDiffRenderer, $slotDiffRenderer );
 	}
@@ -577,7 +577,7 @@ class ContentHandlerTest extends MediaWikiTestCase {
 		$customContentHandler->expects( $this->any() )
 			->method( 'createDifferenceEngine' )
 			->willReturn( $customDifferenceEngine );
-		/** @var $customContentHandler ContentHandler */
+		/** @var ContentHandler $customContentHandler */
 
 		$customSlotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer::class )
 			->disableOriginalConstructor()
@@ -592,7 +592,7 @@ class ContentHandlerTest extends MediaWikiTestCase {
 		$customContentHandler2->expects( $this->any() )
 			->method( 'getSlotDiffRendererInternal' )
 			->willReturn( $customSlotDiffRenderer );
-		/** @var $customContentHandler2 ContentHandler */
+		/** @var ContentHandler $customContentHandler2 */
 
 		$customSlotDiffRenderer2 = $this->getMockBuilder( SlotDiffRenderer::class )
 			->disableOriginalConstructor()
diff --git a/tests/phpunit/includes/content/TextContentHandlerTest.php b/tests/phpunit/includes/content/TextContentHandlerTest.php
index 6d0a3d5ce8..e1281cd0a4 100644
--- a/tests/phpunit/includes/content/TextContentHandlerTest.php
+++ b/tests/phpunit/includes/content/TextContentHandlerTest.php
@@ -37,14 +37,14 @@ class TextContentHandlerTest extends MediaWikiLangTestCase {
 			} );
 
 		/**
-		 * @var $mockEngine SearchEngine
+		 * @var SearchEngine $mockEngine
 		 */
 		$fields = $handler->getFieldsForSearchIndex( $mockEngine );
 		$mappedFields = [];
 		foreach ( $fields as $name => $field ) {
 			$this->assertInstanceOf( SearchIndexField::class, $field );
 			/**
-			 * @var $field SearchIndexField
+			 * @var SearchIndexField $field
 			 */
 			$mappedFields[$name] = $field->getMapping( $mockEngine );
 		}
diff --git a/tests/phpunit/includes/diff/DifferenceEngineTest.php b/tests/phpunit/includes/diff/DifferenceEngineTest.php
index 4f82ff170f..ba31b4ffd5 100644
--- a/tests/phpunit/includes/diff/DifferenceEngineTest.php
+++ b/tests/phpunit/includes/diff/DifferenceEngineTest.php
@@ -313,14 +313,14 @@ class DifferenceEngineTest extends MediaWikiTestCase {
 		$customContentHandler->expects( $this->any() )
 			->method( 'createDifferenceEngine' )
 			->willReturn( $customDifferenceEngine );
-		/** @var $customContentHandler ContentHandler */
+		/** @var ContentHandler $customContentHandler */
 		$customContent = $this->getMockBuilder( Content::class )
 			->setMethods( [ 'getContentHandler' ] )
 			->getMockForAbstractClass();
 		$customContent->expects( $this->any() )
 			->method( 'getContentHandler' )
 			->willReturn( $customContentHandler );
-		/** @var $customContent Content */
+		/** @var Content $customContent */
 		$customContent2 = clone $customContent;
 
 		$slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext::getMain() );
diff --git a/tests/phpunit/includes/page/WikiPageDbTestBase.php b/tests/phpunit/includes/page/WikiPageDbTestBase.php
index ac5fef9389..fbe0356d04 100644
--- a/tests/phpunit/includes/page/WikiPageDbTestBase.php
+++ b/tests/phpunit/includes/page/WikiPageDbTestBase.php
@@ -71,7 +71,7 @@ abstract class WikiPageDbTestBase extends MediaWikiLangTestCase {
 
 	protected function tearDown() {
 		foreach ( $this->pagesToDelete as $p ) {
-			/* @var $p WikiPage */
+			/* @var WikiPage $p */
 
 			try {
 				if ( $p->exists() ) {
diff --git a/tests/phpunit/includes/search/SearchEngineTest.php b/tests/phpunit/includes/search/SearchEngineTest.php
index d86e63d666..0c6520eed5 100644
--- a/tests/phpunit/includes/search/SearchEngineTest.php
+++ b/tests/phpunit/includes/search/SearchEngineTest.php
@@ -271,7 +271,7 @@ class SearchEngineTest extends MediaWikiLangTestCase {
 	 */
 	public function testSearchIndexFields() {
 		/**
-		 * @var $mockEngine SearchEngine
+		 * @var SearchEngine $mockEngine
 		 */
 		$mockEngine = $this->getMockBuilder( SearchEngine::class )
 			->setMethods( [ 'makeSearchFieldMapping' ] )->getMock();
-- 
2.20.1