Always put type information before variable name for @var tags
authorKunal Mehta <legoktm@member.fsf.org>
Mon, 4 Sep 2017 18:05:26 +0000 (11:05 -0700)
committerKunal Mehta <legoktm@member.fsf.org>
Mon, 4 Sep 2017 18:06:51 +0000 (11:06 -0700)
Like other tags, @var should have the type information before the
variable name.

<https://docs.phpdoc.org/references/phpdoc/tags/var.html>

Change-Id: I9eca6957b1990fa8cc687103dc02ee38af5f9086

34 files changed:
includes/actions/CreditsAction.php
includes/actions/InfoAction.php
includes/api/ApiEditPage.php
includes/api/ApiQuery.php
includes/api/ApiQueryBacklinks.php
includes/api/ApiQueryCategoryInfo.php
includes/api/ApiQueryDuplicateFiles.php
includes/api/ApiQueryImageInfo.php
includes/api/ApiQueryInfo.php
includes/api/ApiQueryQueryPage.php
includes/api/ApiQueryRevisions.php
includes/api/ApiSetNotificationTimestamp.php
includes/api/ApiUpload.php
includes/changes/EnhancedChangesList.php
includes/deferred/DeferredUpdates.php
includes/filerepo/file/File.php
includes/filerepo/file/LocalFile.php
includes/installer/MssqlInstaller.php
includes/installer/MysqlInstaller.php
includes/installer/PostgresInstaller.php
includes/libs/filebackend/SwiftFileBackend.php
includes/libs/rdbms/ChronologyProtector.php
includes/libs/rdbms/database/DatabaseMysqli.php
includes/libs/rdbms/database/resultwrapper/FakeResultWrapper.php
includes/libs/rdbms/loadbalancer/LoadBalancer.php
includes/libs/stats/SamplingStatsdClient.php
includes/media/TransformationalImageHandler.php
includes/page/WikiPage.php
includes/rcfeed/FormattedRCFeed.php
includes/revisiondelete/RevDelArchivedFileItem.php
includes/revisiondelete/RevDelList.php
includes/specialpage/AuthManagerSpecialPage.php
includes/specials/pagers/BlockListPager.php
includes/specials/pagers/ProtectedPagesPager.php

index 021f426..7025477 100644 (file)
@@ -131,7 +131,7 @@ class CreditsAction extends FormlessAction {
                $anon_ips = [];
 
                # Sift for real versus user names
-               /** @var $user User */
+               /** @var User $user */
                foreach ( $contributors as $user ) {
                        $cnt--;
                        if ( $user->isLoggedIn() ) {
index 68dda37..d3ba0aa 100644 (file)
@@ -848,7 +848,7 @@ class InfoAction extends FormlessAction {
                $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 
                # Sift for real versus user names
-               /** @var $user User */
+               /** @var User $user */
                foreach ( $contributors as $user ) {
                        $page = $user->isAnon()
                                ? SpecialPage::getTitleFor( 'Contributions', $user->getName() )
index 2245195..4360b4d 100644 (file)
@@ -62,7 +62,7 @@ class ApiEditPage extends ApiBase {
 
                                $redirValues = [];
 
-                               /** @var $newTitle Title */
+                               /** @var Title $newTitle */
                                foreach ( $titles as $id => $newTitle ) {
                                        if ( !isset( $titles[$id - 1] ) ) {
                                                $titles[$id - 1] = $oldTitle;
@@ -359,7 +359,7 @@ class ApiEditPage extends ApiBase {
                $articleContext->setWikiPage( $pageObj );
                $articleContext->setUser( $this->getUser() );
 
-               /** @var $articleObject Article */
+               /** @var Article $articleObject */
                $articleObject = Article::newFromWikiPage( $pageObj, $articleContext );
 
                $ep = new EditPage( $articleObject );
index e6f3fc4..987bb99 100644 (file)
@@ -245,7 +245,7 @@ class ApiQuery extends ApiBase {
                $cacheMode = $this->mPageSet->getCacheMode();
 
                // Execute all unfinished modules
-               /** @var $module ApiQueryBase */
+               /** @var ApiQueryBase $module */
                foreach ( $modules as $module ) {
                        $params = $module->extractRequestParams();
                        $cacheMode = $this->mergeCacheMode(
@@ -381,7 +381,7 @@ class ApiQuery extends ApiBase {
                        ];
                }
                // Report special pages
-               /** @var $title Title */
+               /** @var Title $title */
                foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
                        $vals = [];
                        ApiQueryBase::addTitleInfo( $vals, $title );
@@ -434,7 +434,7 @@ class ApiQuery extends ApiBase {
                $titles = $pageSet->getGoodTitles();
                if ( count( $titles ) ) {
                        $user = $this->getUser();
-                       /** @var $title Title */
+                       /** @var Title $title */
                        foreach ( $titles as $title ) {
                                if ( $title->userCan( 'read', $user ) ) {
                                        $exportTitles[] = $title;
index 56cbaac..54be254 100644 (file)
@@ -228,7 +228,7 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $titleWhere = [];
                $allRedirNs = [];
                $allRedirDBkey = [];
-               /** @var $t Title */
+               /** @var Title $t */
                foreach ( $this->redirTitles as $t ) {
                        $redirNs = $t->getNamespace();
                        $redirDBkey = $t->getDBkey();
index 2a3bf38..25e9b27 100644 (file)
@@ -47,7 +47,7 @@ class ApiQueryCategoryInfo extends ApiQueryBase {
                $titles = $this->getPageSet()->getGoodAndMissingTitles();
                $cattitles = [];
                foreach ( $categories as $c ) {
-                       /** @var $t Title */
+                       /** @var Title $t */
                        $t = $titles[$c];
                        $cattitles[$c] = $t->getDBkey();
                }
index 2ebd6de..0eaeaec 100644 (file)
@@ -91,7 +91,7 @@ class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
 
                $sha1s = [];
                foreach ( $files as $file ) {
-                       /** @var $file File */
+                       /** @var File $file */
                        $sha1s[$file->getName()] = $file->getSha1();
                }
 
@@ -114,7 +114,7 @@ class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
                        if ( $params['dir'] == 'descending' ) {
                                $dupFiles = array_reverse( $dupFiles );
                        }
-                       /** @var $dupFile File */
+                       /** @var File $dupFile */
                        foreach ( $dupFiles as $dupFile ) {
                                $dupName = $dupFile->getName();
                                if ( $image == $dupName && $dupFile->isLocal() ) {
index 7b0080e..b1df982 100644 (file)
@@ -124,7 +124,7 @@ class ApiQueryImageInfo extends ApiQueryBase {
                                        }
                                }
 
-                               /** @var $img File */
+                               /** @var File $img */
                                $img = $images[$title];
 
                                if ( self::getTransformCount() >= self::TRANSFORM_LIMIT ) {
@@ -199,7 +199,7 @@ class ApiQueryImageInfo extends ApiQueryBase {
                                // Get one more to facilitate query-continue functionality
                                $count = ( $gotOne ? 1 : 0 );
                                $oldies = $img->getHistory( $params['limit'] - $count + 1, $start, $params['end'] );
-                               /** @var $oldie File */
+                               /** @var File $oldie */
                                foreach ( $oldies as $oldie ) {
                                        if ( ++$count > $params['limit'] ) {
                                                // We've reached the extra one which shows that there are
index ecdebd4..bff1978 100644 (file)
@@ -372,7 +372,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        $this->getDisplayTitle();
                }
 
-               /** @var $title Title */
+               /** @var Title $title */
                foreach ( $this->everything as $pageid => $title ) {
                        $pageInfo = $this->extractPageInfo( $pageid, $title );
                        $fit = $pageInfo !== null && $result->addValue( [
@@ -548,7 +548,7 @@ class ApiQueryInfo extends ApiQueryBase {
 
                        $res = $this->select( __METHOD__ );
                        foreach ( $res as $row ) {
-                               /** @var $title Title */
+                               /** @var Title $title */
                                $title = $this->titles[$row->pr_page];
                                $a = [
                                        'type' => $row->pr_type,
@@ -688,7 +688,7 @@ class ApiQueryInfo extends ApiQueryBase {
        private function getTSIDs() {
                $getTitles = $this->talkids = $this->subjectids = [];
 
-               /** @var $t Title */
+               /** @var Title $t */
                foreach ( $this->everything as $t ) {
                        if ( MWNamespace::isTalk( $t->getNamespace() ) ) {
                                if ( $this->fld_subjectid ) {
index caa5f05..46c2265 100644 (file)
@@ -59,7 +59,7 @@ class ApiQueryQueryPage extends ApiQueryGeneratorBase {
                $params = $this->extractRequestParams();
                $result = $this->getResult();
 
-               /** @var $qp QueryPage */
+               /** @var QueryPage $qp */
                $qp = new $this->qpMap[$params['page']]();
                if ( !$qp->userCanExecute( $this->getUser() ) ) {
                        $this->dieWithError( 'apierror-specialpage-cantexecute' );
@@ -129,7 +129,7 @@ class ApiQueryQueryPage extends ApiQueryGeneratorBase {
        }
 
        public function getCacheMode( $params ) {
-               /** @var $qp QueryPage */
+               /** @var QueryPage $qp */
                $qp = new $this->qpMap[$params['page']]();
                if ( $qp->getRestriction() != '' ) {
                        return 'private';
index a4f0315..2dfa42a 100644 (file)
@@ -166,7 +166,7 @@ class ApiQueryRevisions extends ApiQueryRevisionsBase {
                        // For each page we will request, the user must have read rights for that page
                        $user = $this->getUser();
                        $status = Status::newGood();
-                       /** @var $title Title */
+                       /** @var Title $title */
                        foreach ( $pageSet->getGoodTitles() as $title ) {
                                if ( !$title->userCan( 'read', $user ) ) {
                                        $status->fatal( ApiMessage::create(
index 663416e..b6a0a78 100644 (file)
@@ -150,7 +150,7 @@ class ApiSetNotificationTimestamp extends ApiBase {
                                );
 
                                // Now, put the valid titles into the result
-                               /** @var $title Title */
+                               /** @var Title $title */
                                foreach ( $pageSet->getTitles() as $title ) {
                                        $ns = $title->getNamespace();
                                        $dbkey = $title->getDBkey();
index a283b5a..cfe1968 100644 (file)
@@ -71,7 +71,7 @@ class ApiUpload extends ApiBase {
                $this->checkPermissions( $user );
 
                // Fetch the file (usually a no-op)
-               /** @var $status Status */
+               /** @var Status $status */
                $status = $this->mUpload->fetchFile();
                if ( !$status->isGood() ) {
                        $this->dieStatus( $status );
@@ -772,7 +772,7 @@ class ApiUpload extends ApiBase {
                        $this->mParams['text'] = $this->mParams['comment'];
                }
 
-               /** @var $file LocalFile */
+               /** @var LocalFile $file */
                $file = $this->mUpload->getLocalFile();
 
                // For preferences mode, we want to watch if 'watchdefault' is set,
@@ -829,7 +829,7 @@ class ApiUpload extends ApiBase {
                        $result['result'] = 'Poll';
                        $result['stage'] = 'queued';
                } else {
-                       /** @var $status Status */
+                       /** @var Status $status */
                        $status = $this->mUpload->performUpload( $this->mParams['comment'],
                                $this->mParams['text'], $watch, $this->getUser(), $this->mParams['tags'] );
 
index 21a811e..8e24efe 100644 (file)
@@ -515,7 +515,7 @@ class EnhancedChangesList extends ChangesList {
 
                $sinceLast = 0;
                $unvisitedOldid = null;
-               /** @var $rcObj RCCacheEntry */
+               /** @var RCCacheEntry $rcObj */
                foreach ( $block as $rcObj ) {
                        // Same logic as below inside main foreach
                        if ( $rcObj->watched && $rcObj->mAttribs['rc_timestamp'] >= $rcObj->watched ) {
@@ -537,7 +537,7 @@ class EnhancedChangesList extends ChangesList {
 
                # Total change link
                $links = [];
-               /** @var $block0 RecentChange */
+               /** @var RecentChange $block0 */
                $block0 = $block[0];
                $last = $block[count( $block ) - 1];
                if ( !$allLogs ) {
index 40069f3..e8e250b 100644 (file)
@@ -149,7 +149,7 @@ class DeferredUpdates {
                if ( $update instanceof MergeableUpdate ) {
                        $class = get_class( $update ); // fully-qualified class
                        if ( isset( $queue[$class] ) ) {
-                               /** @var $existingUpdate MergeableUpdate */
+                               /** @var MergeableUpdate $existingUpdate */
                                $existingUpdate = $queue[$class];
                                $existingUpdate->merge( $update );
                        } else {
index 4ea0973..32f4504 100644 (file)
@@ -1147,7 +1147,7 @@ abstract class File implements IDBAccessObject {
                if ( !$thumb ) { // bad params?
                        $thumb = false;
                } elseif ( $thumb->isError() ) { // transform error
-                       /** @var $thumb MediaTransformError */
+                       /** @var MediaTransformError $thumb */
                        $this->lastError = $thumb->toText();
                        // Ignore errors if requested
                        if ( $wgIgnoreImageErrors && !( $flags & self::RENDER_NOW ) ) {
index 904c932..9af0c6d 100644 (file)
@@ -1556,7 +1556,7 @@ class LocalFile extends File {
                                                );
 
                                                if ( isset( $status->value['revision'] ) ) {
-                                                       /** @var $rev Revision */
+                                                       /** @var Revision $rev */
                                                        $rev = $status->value['revision'];
                                                        // Associate new page revision id
                                                        $logEntry->setAssociatedRevId( $rev->getId() );
@@ -1564,7 +1564,7 @@ class LocalFile extends File {
                                                // This relies on the resetArticleID() call in WikiPage::insertOn(),
                                                // which is triggered on $descTitle by doEditContent() above.
                                                if ( isset( $status->value['revision'] ) ) {
-                                                       /** @var $rev Revision */
+                                                       /** @var Revision $rev */
                                                        $rev = $status->value['revision'];
                                                        $updateLogPage = $rev->getPage();
                                                }
index 43d3574..d01f954 100644 (file)
@@ -266,7 +266,7 @@ class MssqlInstaller extends DatabaseInstaller {
                if ( !$status->isOK() ) {
                        return false;
                }
-               /** @var $conn Database */
+               /** @var Database $conn */
                $conn = $status->value;
 
                // We need the server-level ALTER ANY LOGIN permission to create new accounts
index 0250b6f..dc63899 100644 (file)
@@ -275,7 +275,7 @@ class MysqlInstaller extends DatabaseInstaller {
                if ( !$status->isOK() ) {
                        return false;
                }
-               /** @var $conn Database */
+               /** @var Database $conn */
                $conn = $status->value;
 
                // Get current account name
index b501cb3..1a3fb10 100644 (file)
@@ -594,7 +594,7 @@ class PostgresInstaller extends DatabaseInstaller {
                        return $status;
                }
 
-               /** @var $conn DatabasePostgres */
+               /** @var DatabasePostgres $conn */
                $conn = $status->value;
 
                if ( $conn->tableExists( 'archive' ) ) {
index eb72edc..de5a103 100644 (file)
@@ -1250,7 +1250,7 @@ class SwiftFileBackend extends FileBackendStore {
         * @return StatusValue[]
         */
        protected function doExecuteOpHandlesInternal( array $fileOpHandles ) {
-               /** @var $statuses StatusValue[] */
+               /** @var StatusValue[] $statuses */
                $statuses = [];
 
                $auth = $this->getAuthentication();
index f002d3e..8121654 100644 (file)
@@ -315,7 +315,7 @@ class ChronologyProtector implements LoggerAwareInterface {
         * @return array
         */
        private static function mergePositions( $curValue, array $shutdownPositions ) {
-               /** @var $curPositions DBMasterPos[] */
+               /** @var DBMasterPos[] $curPositions */
                if ( $curValue === false ) {
                        $curPositions = $shutdownPositions;
                } else {
index b925e2c..4c3cbdd 100644 (file)
@@ -34,7 +34,7 @@ use IP;
  * @see Database
  */
 class DatabaseMysqli extends DatabaseMysqlBase {
-       /** @var $mConn mysqli */
+       /** @var mysqli $mConn */
 
        /**
         * @param string $sql
index 493cde8..12e59b5 100644 (file)
@@ -9,7 +9,7 @@ use stdClass;
  * doesn't go anywhere near an actual database.
  */
 class FakeResultWrapper extends ResultWrapper {
-       /** @var $result stdClass[] */
+       /** @var stdClass[] $result */
 
        /**
         * @param stdClass[] $rows
index 36de39e..8393e2b 100644 (file)
@@ -384,9 +384,9 @@ class LoadBalancer implements ILoadBalancer {
                        throw new InvalidArgumentException( "Empty server array given to LoadBalancer" );
                }
 
-               /** @var $i int|bool Index of selected server */
+               /** @var int|bool $i Index of selected server */
                $i = false;
-               /** @var $laggedReplicaMode bool Whether server is considered lagged */
+               /** @var bool $laggedReplicaMode Whether server is considered lagged */
                $laggedReplicaMode = false;
 
                // Quickly look through the available servers for a server that meets criteria...
@@ -538,7 +538,7 @@ class LoadBalancer implements ILoadBalancer {
        public function getAnyOpenConnection( $i ) {
                foreach ( $this->mConns as $connsByServer ) {
                        if ( !empty( $connsByServer[$i] ) ) {
-                               /** @var $serverConns IDatabase[] */
+                               /** @var IDatabase[] $serverConns */
                                $serverConns = $connsByServer[$i];
 
                                return reset( $serverConns );
index 1da9468..6494c26 100644 (file)
@@ -56,7 +56,7 @@ class SamplingStatsdClient extends StatsdClient {
                }
                if ( $samplingRates ) {
                        array_walk( $data, function ( $item ) use ( $samplingRates ) {
-                               /** @var $item StatsdData */
+                               /** @var StatsdData $item */
                                foreach ( $samplingRates as $pattern => $rate ) {
                                        if ( fnmatch( $pattern, $item->getKey(), FNM_NOESCAPE ) ) {
                                                $item->setSampleRate( $item->getSampleRate() * $rate );
index 32208cc..de438da 100644 (file)
@@ -221,7 +221,7 @@ abstract class TransformationalImageHandler extends ImageHandler {
                }
 
                # Try a hook. Called "Bitmap" for historical reasons.
-               /** @var $mto MediaTransformOutput */
+               /** @var MediaTransformOutput $mto */
                $mto = null;
                Hooks::run( 'BitmapHandlerTransform', [ $this, $image, &$scalerParams, &$mto ] );
                if ( !is_null( $mto ) ) {
index 5a0670c..21c298e 100644 (file)
@@ -1657,7 +1657,7 @@ class WikiPage implements Page, IDBAccessObject {
                // Convenience variables
                $now = wfTimestampNow();
                $oldid = $meta['oldId'];
-               /** @var $oldContent Content|null */
+               /** @var Content|null $oldContent */
                $oldContent = $meta['oldContent'];
                $newsize = $content->getSize();
 
index 48a9f94..afe900d 100644 (file)
@@ -52,7 +52,7 @@ abstract class FormattedRCFeed extends RCFeed {
         */
        public function notify( RecentChange $rc, $actionComment = null ) {
                $params = $this->params;
-               /** @var $formatter RCFeedFormatter */
+               /** @var RCFeedFormatter $formatter */
                $formatter = is_object( $params['formatter'] ) ? $params['formatter'] : new $params['formatter'];
 
                $line = $formatter->getLine( $params, $rc, $actionComment );
index 32d4891..b098422 100644 (file)
@@ -23,8 +23,8 @@
  * Item class for a filearchive table row
  */
 class RevDelArchivedFileItem extends RevDelFileItem {
-       /** @var $list RevDelArchivedFileList */
-       /** @var $file ArchivedFile */
+       /** @var RevDelArchivedFileList $list */
+       /** @var ArchivedFile $file */
        /** @var LocalFile */
        protected $lockFile;
 
index a2c58e6..011c7b0 100644 (file)
@@ -83,7 +83,7 @@ abstract class RevDelList extends RevisionListBase {
        public function areAnySuppressed() {
                $bit = $this->getSuppressBit();
 
-               /** @var $item RevDelItem */
+               /** @var RevDelItem $item */
                foreach ( $this as $item ) {
                        if ( $item->getBits() & $bit ) {
                                return true;
@@ -151,7 +151,7 @@ abstract class RevDelList extends RevisionListBase {
                // passed to doPostCommitUpdates().
                $visibilityChangeMap = [];
 
-               /** @var $item RevDelItem */
+               /** @var RevDelItem $item */
                foreach ( $this as $item ) {
                        unset( $missing[$item->getId()] );
 
@@ -294,7 +294,7 @@ abstract class RevDelList extends RevisionListBase {
 
        final protected function acquireItemLocks() {
                $status = Status::newGood();
-               /** @var $item RevDelItem */
+               /** @var RevDelItem $item */
                foreach ( $this as $item ) {
                        $status->merge( $item->lock() );
                }
@@ -304,7 +304,7 @@ abstract class RevDelList extends RevisionListBase {
 
        final protected function releaseItemLocks() {
                $status = Status::newGood();
-               /** @var $item RevDelItem */
+               /** @var RevDelItem $item */
                foreach ( $this as $item ) {
                        $status->merge( $item->unlock() );
                }
index 500c2e9..0cdc55f 100644 (file)
@@ -688,7 +688,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage {
 
                        if ( isset( $singleFieldInfo['options'] ) ) {
                                $descriptor['options'] = array_flip( array_map( function ( $message ) {
-                                       /** @var $message Message */
+                                       /** @var Message $message */
                                        return $message->parse();
                                }, $singleFieldInfo['options'] ) );
                        }
index 2206be8..924fd06 100644 (file)
@@ -79,7 +79,7 @@ class BlockListPager extends TablePager {
                        }
                }
 
-               /** @var $row object */
+               /** @var object $row */
                $row = $this->mCurrentRow;
 
                $language = $this->getLanguage();
index 20b44d2..1587abc 100644 (file)
@@ -120,7 +120,7 @@ class ProtectedPagesPager extends TablePager {
         * @throws MWException
         */
        function formatValue( $field, $value ) {
-               /** @var $row object */
+               /** @var object $row */
                $row = $this->mCurrentRow;
 
                switch ( $field ) {