Add PHPDoc documentation to all API query module constructors
Change-Id: I2bc140576efc891bb9b6e50e44041d5bb022ac8f
This commit is contained in:
parent
f4a77a5760
commit
08cf4c49df
27 changed files with 113 additions and 0 deletions
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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();
|
||||
|
|
|
|||
|
|
@ -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':
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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'];
|
||||
|
|
|
|||
|
|
@ -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'] );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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(
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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' );
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue