Merge "Fix order of @var parameter in PHP"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Fri, 12 Apr 2019 15:17:23 +0000 (15:17 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 12 Apr 2019 15:17:23 +0000 (15:17 +0000)
19 files changed:
img_auth.php
includes/diff/DifferenceEngine.php
includes/diff/TextSlotDiffRenderer.php
includes/installer/DatabaseUpdater.php
includes/installer/MssqlInstaller.php
includes/installer/MysqlInstaller.php
includes/installer/PostgresInstaller.php
includes/page/ImagePage.php
includes/preferences/DefaultPreferencesFactory.php
includes/widget/search/InterwikiSearchResultSetWidget.php
maintenance/Maintenance.php
maintenance/cleanupSpam.php
maintenance/generateSitemap.php
maintenance/storage/checkStorage.php
tests/phpunit/includes/content/ContentHandlerTest.php
tests/phpunit/includes/content/TextContentHandlerTest.php
tests/phpunit/includes/diff/DifferenceEngineTest.php
tests/phpunit/includes/page/WikiPageDbTestBase.php
tests/phpunit/includes/search/SearchEngineTest.php

index ca69d31..e6b6e1b 100644 (file)
@@ -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 ) );
index e39334f..833bc69 100644 (file)
@@ -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 );
index 001944c..bb965e1 100644 (file)
@@ -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 );
index 54ffa5a..b32be39 100644 (file)
@@ -1227,7 +1227,7 @@ abstract class DatabaseUpdater {
         */
        protected function rebuildLocalisationCache() {
                /**
-                * @var $cl RebuildLocalisationCache
+                * @var RebuildLocalisationCache $cl
                 */
                $cl = $this->maintenance->runChild(
                        RebuildLocalisationCache::class, 'rebuildLocalisationCache.php'
index e462220..6d62c43 100644 (file)
@@ -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' ) );
index e9a2d03..74924d0 100644 (file)
@@ -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;
 
index f9ee319..21b6f39 100644 (file)
@@ -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;
 
index 6c1ac39..86c59ad 100644 (file)
@@ -961,7 +961,7 @@ EOT
                $out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
 
                /**
-                * @var $file File
+                * @var File $file
                 */
                foreach ( $dupes as $file ) {
                        $fromSrc = '';
index c45ab4c..be2bf08 100644 (file)
@@ -1450,7 +1450,7 @@ class DefaultPreferencesFactory implements PreferencesFactory {
                }
 
                /**
-                * @var $htmlForm HTMLForm
+                * @var HTMLForm $htmlForm
                 */
                $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
 
index c0efd24..48c624c 100644 (file)
@@ -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;
index 0d4f14c..1cca26e 100644 (file)
@@ -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;
index 04f278f..e1ea247 100644 (file)
@@ -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(
index dc1de4f..af5373c 100644 (file)
@@ -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 );
index 68184ea..eed8019 100644 (file)
@@ -104,7 +104,7 @@ class CheckStorage {
                        );
                        foreach ( $res as $row ) {
                                /**
-                                * @var $flags int
+                                * @var int $flags
                                 */
                                $flags = $row->old_flags;
                                $id = $row->old_id;
index f42f8b4..4eecd4d 100644 (file)
@@ -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()
index 6d0a3d5..e1281cd 100644 (file)
@@ -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 );
                }
index 4f82ff1..ba31b4f 100644 (file)
@@ -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() );
index 5487556..3a3feee 100644 (file)
@@ -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() ) {
index d86e63d..0c6520e 100644 (file)
@@ -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();