Use precise ApiMain/ApiQuery type hints in all API modules

Which type is used depends on the ApiModuleManager responsible for
the API module. There are two managers, one in ApiMain and one in
ApiQuery. Both contain a list of API modules they instantiate.
Both use $this as the first parameter in the constructors of the
individual modules. There is no other regular way to instantiate the
modules, so we know the type must either be ApiMain or ApiQuery.

The lists don't intersect.

I would have prefered the naming scheme $mainModule for ApiMain
modules and $queryModule for ApiQuery modules but since this
doesn't add much I left the shorter variable names untouched.

Change-Id: Ie6bf19150f1c9b619655a06a8e051412665e54db

includes/api/ApiFormatBase.php

@@ -34,12 +34,11 @@ abstract class ApiFormatBase extends ApiBase {
 	private $mBufferResult = false, $mBuffer, $mDisabled = false;
 
 	/**
-	 * Constructor
 	 * If $format ends with 'fm', pretty-print the output in HTML.
 	 * @param ApiMain $main
 	 * @param string $format Format name
 	 */
-	public function __construct( $main, $format ) {
+	public function __construct( ApiMain $main, $format ) {
 		parent::__construct( $main, $format );
 
 		$this->mIsHtml = ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
@@ -347,7 +346,7 @@ See the <a href='https://www.mediawiki.org/wiki/API'>complete documentation</a>,
  */
 class ApiFormatFeedWrapper extends ApiFormatBase {
 
-	public function __construct( $main ) {
+	public function __construct( ApiMain $main ) {
 		parent::__construct( $main, 'feed' );
 	}
 

includes/api/ApiFormatJson.php

@@ -32,7 +32,7 @@ class ApiFormatJson extends ApiFormatBase {
 
 	private $mIsRaw;
 
-	public function __construct( $main, $format ) {
+	public function __construct( ApiMain $main, $format ) {
 		parent::__construct( $main, $format );
 		$this->mIsRaw = ( $format === 'rawfm' );
 	}

includes/api/ApiFormatRaw.php

@@ -31,11 +31,10 @@
 class ApiFormatRaw extends ApiFormatBase {
 
 	/**
-	 * Constructor
 	 * @param ApiMain $main
-	 * @param ApiFormatBase $errorFallback ApiFormatBase object to fall back on for errors
+	 * @param ApiFormatBase $errorFallback Object to fall back on for errors
 	 */
-	public function __construct( $main, $errorFallback ) {
+	public function __construct( ApiMain $main, ApiFormatBase $errorFallback ) {
 		parent::__construct( $main, 'raw' );
 		$this->mErrorFallback = $errorFallback;
 	}

includes/api/ApiLogin.php

@@ -32,7 +32,7 @@
  */
 class ApiLogin extends ApiBase {
 
-	public function __construct( $main, $action ) {
+	public function __construct( ApiMain $main, $action ) {
 		parent::__construct( $main, $action, 'lg' );
 	}
 

includes/api/ApiModuleManager.php

@@ -33,9 +33,21 @@
  */
 class ApiModuleManager extends ContextSource {
 
+	/**
+	 * @var ApiBase
+	 */
 	private $mParent;
+	/**
+	 * @var ApiBase[]
+	 */
 	private $mInstances = array();
+	/**
+	 * @var null[]
+	 */
 	private $mGroups = array();
+	/**
+	 * @var array[]
+	 */
 	private $mModules = array();
 
 	/**

includes/api/ApiPageSet.php

@@ -98,7 +98,6 @@ class ApiPageSet extends ApiBase {
 	}
 
 	/**
-	 * Constructor
 	 * @param ApiBase $dbSource Module implementing getDB().
 	 *        Allows PageSet to reuse existing db connection from the shared state like ApiQuery.
 	 * @param int $flags Zero or more flags like DISABLE_GENERATORS

includes/api/ApiParamInfo.php

@@ -34,7 +34,7 @@ class ApiParamInfo extends ApiBase {
 	 */
 	protected $queryObj;
 
-	public function __construct( $main, $action ) {
+	public function __construct( ApiMain $main, $action ) {
 		parent::__construct( $main, $action );
 		$this->queryObj = new ApiQuery( $this->getMain(), 'query' );
 	}

includes/api/ApiQuery.php

@@ -125,7 +125,7 @@ class ApiQuery extends ApiBase {
 	 * @param ApiMain $main
 	 * @param string $action
 	 */
-	public function __construct( $main, $action ) {
+	public function __construct( ApiMain $main, $action ) {
 		parent::__construct( $main, $action );
 
 		$this->mModuleMgr = new ApiModuleManager( $this );

includes/api/ApiQueryAllCategories.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ac' );
 	}
 

includes/api/ApiQueryAllImages.php

@@ -34,7 +34,7 @@
 class ApiQueryAllImages extends ApiQueryGeneratorBase {
 	protected $mRepo;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ai' );
 		$this->mRepo = RepoGroup::singleton()->getLocalRepo();
 	}

includes/api/ApiQueryAllLinks.php

@@ -39,7 +39,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
 	private $useIndex = null;
 	private $props = array(), $propHelp = array();
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		switch ( $moduleName ) {
 			case 'alllinks':
 				$prefix = 'al';

includes/api/ApiQueryAllMessages.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryAllMessages extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'am' );
 	}
 

includes/api/ApiQueryAllPages.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryAllPages extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ap' );
 	}
 

includes/api/ApiQueryAllUsers.php

@@ -30,7 +30,7 @@
  * @ingroup API
  */
 class ApiQueryAllUsers extends ApiQueryBase {
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'au' );
 	}
 

includes/api/ApiQueryBacklinks.php

@@ -75,7 +75,7 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
 		)
 	);
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		$settings = $this->backlinksSettings[$moduleName];
 		$prefix = $settings['prefix'];
 		$code = $settings['code'];

includes/api/ApiQueryBase.php

@@ -36,13 +36,13 @@ abstract class ApiQueryBase extends ApiBase {
 	private $mQueryModule, $mDb, $tables, $where, $fields, $options, $join_conds;
 
 	/**
-	 * @param ApiBase $query
+	 * @param ApiQuery $queryModule
 	 * @param string $moduleName
 	 * @param string $paramPrefix
 	 */
-	public function __construct( ApiBase $query, $moduleName, $paramPrefix = '' ) {
-		parent::__construct( $query->getMain(), $moduleName, $paramPrefix );
-		$this->mQueryModule = $query;
+	public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
+		parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
+		$this->mQueryModule = $queryModule;
 		$this->mDb = null;
 		$this->resetQueryParams();
 	}

includes/api/ApiQueryBlocks.php

@@ -36,7 +36,7 @@ class ApiQueryBlocks extends ApiQueryBase {
 	 */
 	protected $usernames;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'bk' );
 	}
 

includes/api/ApiQueryCategories.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryCategories extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'cl' );
 	}
 

includes/api/ApiQueryCategoryInfo.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryCategoryInfo extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ci' );
 	}
 

includes/api/ApiQueryCategoryMembers.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'cm' );
 	}
 

includes/api/ApiQueryContributors.php

@@ -38,7 +38,7 @@ class ApiQueryContributors extends ApiQueryBase {
 	 */
 	const MAX_PAGES = 100;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		// "pc" is short for "page contributors", "co" was already taken by the
 		// GeoData extension's prop=coordinates.
 		parent::__construct( $query, $moduleName, 'pc' );

includes/api/ApiQueryDeletedrevs.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryDeletedrevs extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'dr' );
 	}
 

includes/api/ApiQueryDuplicateFiles.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'df' );
 	}
 

includes/api/ApiQueryExtLinksUsage.php

@@ -29,7 +29,7 @@
  */
 class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'eu' );
 	}
 

includes/api/ApiQueryExternalLinks.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryExternalLinks extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'el' );
 	}
 

includes/api/ApiQueryFileRepoInfo.php

@@ -29,7 +29,7 @@
  */
 class ApiQueryFileRepoInfo extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'fri' );
 	}
 

includes/api/ApiQueryFilearchive.php

@@ -33,7 +33,7 @@
  */
 class ApiQueryFilearchive extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'fa' );
 	}
 

includes/api/ApiQueryIWBacklinks.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'iwbl' );
 	}
 

includes/api/ApiQueryIWLinks.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryIWLinks extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'iw' );
 	}
 

includes/api/ApiQueryImageInfo.php

@@ -33,7 +33,7 @@ class ApiQueryImageInfo extends ApiQueryBase {
 	const TRANSFORM_LIMIT = 50;
 	private static $transformCount = 0;
 
-	public function __construct( $query, $moduleName, $prefix = 'ii' ) {
+	public function __construct( ApiQuery $query, $moduleName, $prefix = 'ii' ) {
 		// We allow a subclass to override the prefix, to create a related API
 		// module. Some other parts of MediaWiki construct this with a null
 		// $prefix, which used to be ignored when this only took two arguments

includes/api/ApiQueryImages.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryImages extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'im' );
 	}
 

includes/api/ApiQueryInfo.php

@@ -48,7 +48,7 @@ class ApiQueryInfo extends ApiQueryBase {
 
 	private $tokenFunctions;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'in' );
 	}
 

includes/api/ApiQueryLangBacklinks.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'lbl' );
 	}
 

includes/api/ApiQueryLangLinks.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryLangLinks extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'll' );
 	}
 

includes/api/ApiQueryLinks.php

@@ -36,7 +36,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 
 	private $table, $prefix, $description, $helpUrl;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		switch ( $moduleName ) {
 			case self::LINKS:
 				$this->table = 'pagelinks';

includes/api/ApiQueryLogEvents.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryLogEvents extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'le' );
 	}
 

includes/api/ApiQueryPagePropNames.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryPagePropNames extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ppn' );
 	}
 

includes/api/ApiQueryPageProps.php

@@ -33,7 +33,7 @@ class ApiQueryPageProps extends ApiQueryBase {
 
 	private $params;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'pp' );
 	}
 

includes/api/ApiQueryPagesWithProp.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'pwp' );
 	}
 

includes/api/ApiQueryProtectedTitles.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryProtectedTitles extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'pt' );
 	}
 

includes/api/ApiQueryQueryPage.php

@@ -32,7 +32,7 @@
 class ApiQueryQueryPage extends ApiQueryGeneratorBase {
 	private $qpMap;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'qp' );
 		// Build mapping from special page names to QueryPage classes
 		global $wgAPIUselessQueryPages;

includes/api/ApiQueryRandom.php

@@ -33,7 +33,7 @@
 class ApiQueryRandom extends ApiQueryGeneratorBase {
 	private $pageIDs;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'rn' );
 	}
 

includes/api/ApiQueryRecentChanges.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryRecentChanges extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'rc' );
 	}
 

includes/api/ApiQueryRedirects.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryRedirects extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'rd' );
 	}
 

includes/api/ApiQueryRevisions.php

@@ -37,7 +37,7 @@ class ApiQueryRevisions extends ApiQueryBase {
 	private $diffto, $difftotext, $expandTemplates, $generateXML, $section,
 		$token, $parseContent, $contentFormat;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'rv' );
 	}
 

includes/api/ApiQuerySearch.php

@@ -39,7 +39,7 @@ class ApiQuerySearch extends ApiQueryGeneratorBase {
 	 */
 	const BACKEND_NULL_PARAM = 'database-backed';
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'sr' );
 	}
 

includes/api/ApiQuerySiteinfo.php

@@ -31,7 +31,7 @@
  */
 class ApiQuerySiteinfo extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'si' );
 	}
 

includes/api/ApiQueryStashImageInfo.php

@@ -27,7 +27,7 @@
  */
 class ApiQueryStashImageInfo extends ApiQueryImageInfo {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'sii' );
 	}
 

includes/api/ApiQueryTags.php

@@ -40,7 +40,7 @@ class ApiQueryTags extends ApiQueryBase {
 	private $fld_displayname = false, $fld_description = false,
 		$fld_hitcount = false;
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'tg' );
 	}
 

includes/api/ApiQueryUserContributions.php

@@ -31,7 +31,7 @@
  */
 class ApiQueryContributions extends ApiQueryBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'uc' );
 	}
 

includes/api/ApiQueryUserInfo.php

@@ -33,7 +33,7 @@ class ApiQueryUserInfo extends ApiQueryBase {
 
 	private $prop = array();
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ui' );
 	}
 

includes/api/ApiQueryUsers.php

@@ -50,7 +50,7 @@ class ApiQueryUsers extends ApiQueryBase {
 		'gender',
 	);
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'us' );
 	}
 

includes/api/ApiQueryWatchlist.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'wl' );
 	}
 

includes/api/ApiQueryWatchlistRaw.php

@@ -32,7 +32,7 @@
  */
 class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'wr' );
 	}
 

includes/api/ApiResult.php

@@ -59,10 +59,9 @@ class ApiResult extends ApiBase {
 	private $mData, $mIsRawMode, $mSize, $mCheckingSize;
 
 	/**
-	 * Constructor
 	 * @param ApiMain $main
 	 */
-	public function __construct( $main ) {
+	public function __construct( ApiMain $main ) {
 		parent::__construct( $main, 'result' );
 		$this->mIsRawMode = false;
 		$this->mCheckingSize = true;

includes/api/ApiRsd.php

@@ -160,7 +160,7 @@ class ApiRsd extends ApiBase {
 }
 
 class ApiFormatXmlRsd extends ApiFormatXml {
-	public function __construct( $main, $format ) {
+	public function __construct( ApiMain $main, $format ) {
 		parent::__construct( $main, $format );
 		$this->setRootElement( 'rsd' );
 	}

tests/phpunit/includes/api/PrefixUniquenessTest.php

@@ -14,8 +14,8 @@ class PrefixUniquenessTest extends MediaWikiTestCase {
 		$prefixes = array();
 
 		foreach ( $modules as $name => $class ) {
-			/** @var ApiMain $module */
-			$module = new $class( $main, $name );
+			/** @var ApiQueryBase $module */
+			$module = new $class( $query, $name );
 			$prefix = $module->getModulePrefix();
 			if ( isset( $prefixes[$prefix] ) ) {
 				$this->fail( "Module prefix '{$prefix}' is shared between {$class} and {$prefixes[$prefix]}" );