Add PHPDoc documentation to all API query module constructors

Change-Id: I2bc140576efc891bb9b6e50e44041d5bb022ac8f
This commit is contained in:
Thiemo Kreuz 2020-10-27 18:25:24 +01:00 committed by Thiemo Kreuz (WMDE)
parent f4a77a5760
commit 08cf4c49df
27 changed files with 113 additions and 0 deletions

View file

@ -28,6 +28,10 @@
*/
class ApiQueryAllCategories extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ac' );
}

View file

@ -35,6 +35,10 @@ use MediaWiki\Storage\NameTableAccessException;
*/
class ApiQueryAllDeletedRevisions extends ApiQueryRevisionsBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'adr' );
}

View file

@ -34,8 +34,16 @@ use Wikimedia\Rdbms\IDatabase;
* @ingroup API
*/
class ApiQueryAllImages extends ApiQueryGeneratorBase {
/**
* @var LocalRepo
*/
protected $mRepo;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ai' );
$this->mRepo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();

View file

@ -36,6 +36,10 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
private $useIndex = null;
private $props = [];
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
switch ( $moduleName ) {
case 'alllinks':

View file

@ -28,6 +28,10 @@ use MediaWiki\MediaWikiServices;
*/
class ApiQueryAllPages extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ap' );
}

View file

@ -32,6 +32,10 @@ use MediaWiki\Revision\RevisionRecord;
*/
class ApiQueryAllRevisions extends ApiQueryRevisionsBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'arv' );
}

View file

@ -80,6 +80,10 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
]
];
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
$settings = $this->backlinksSettings[$moduleName];
$prefix = $settings['prefix'];

View file

@ -75,6 +75,10 @@ class ApiQueryBacklinksprop extends ApiQueryGeneratorBase {
],
];
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, self::$settings[$moduleName]['code'] );
}

View file

@ -27,6 +27,10 @@
*/
class ApiQueryCategories extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'cl' );
}

View file

@ -27,6 +27,10 @@
*/
class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'cm' );
}

View file

@ -35,6 +35,10 @@ use MediaWiki\Storage\NameTableAccessException;
*/
class ApiQueryDeletedRevisions extends ApiQueryRevisionsBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'drv' );
}

View file

@ -29,6 +29,10 @@ use MediaWiki\MediaWikiServices;
*/
class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'df' );
}

View file

@ -25,6 +25,10 @@
*/
class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'eu' );
}

View file

@ -29,6 +29,10 @@
*/
class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'iwbl' );
}

View file

@ -28,6 +28,10 @@
*/
class ApiQueryImages extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'im' );
}

View file

@ -29,6 +29,10 @@
*/
class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'lbl' );
}

View file

@ -34,6 +34,10 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
private $table, $prefix, $titlesParam, $helpUrl;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
switch ( $moduleName ) {
case self::LINKS:

View file

@ -29,6 +29,10 @@
*/
class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'pwp' );
}

View file

@ -29,6 +29,10 @@ class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
/** @var array list of api allowed params */
private $allowedParams;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ps' );
}

View file

@ -27,6 +27,10 @@
*/
class ApiQueryProtectedTitles extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'pt' );
}

View file

@ -40,6 +40,10 @@ class ApiQueryQueryPage extends ApiQueryGeneratorBase {
*/
private $specialPageFactory;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'qp' );
$this->queryPages = array_values( array_diff(

View file

@ -27,6 +27,11 @@
* @ingroup API
*/
class ApiQueryRandom extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'rn' );
}

View file

@ -33,6 +33,10 @@ use MediaWiki\Storage\NameTableAccessException;
*/
class ApiQueryRecentChanges extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'rc' );
}

View file

@ -37,6 +37,10 @@ class ApiQueryRevisions extends ApiQueryRevisionsBase {
private $token = null;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'rv' );
}

View file

@ -31,6 +31,10 @@ class ApiQuerySearch extends ApiQueryGeneratorBase {
/** @var array list of api allowed params */
private $allowedParams;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'sr' );
}

View file

@ -35,6 +35,10 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
/** @var CommentStore */
private $commentStore;
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'wl' );
}

View file

@ -31,6 +31,10 @@ use MediaWiki\ParamValidator\TypeDef\UserDef;
*/
class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {
/**
* @param ApiQuery $query
* @param string $moduleName
*/
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'wr' );
}