Page MenuHomeWickedGov Phorge
Files F4152600

ApiQueryLintErrors.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ApiQueryLintErrors.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Linter;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiQuery;
use MediaWiki\Api\ApiQueryBase;
use MediaWiki\Api\ApiResult;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
class ApiQueryLintErrors extends ApiQueryBase {
private CategoryManager $categoryManager;
/**
* @param ApiQuery $queryModule
* @param string $moduleName
* @param CategoryManager $categoryManager
*/
public function __construct(
ApiQuery $queryModule,
string $moduleName,
CategoryManager $categoryManager
) {
parent::__construct( $queryModule, $moduleName, 'lnt' );
$this->categoryManager = $categoryManager;
}
public function execute() {
$params = $this->extractRequestParams();
$this->requireMaxOneParameter( $params, 'pageid', 'title' );
$this->requireMaxOneParameter( $params, 'namespace', 'title' );
$useIndex = true;
$categories = $params['categories'];
if ( !$categories ) {
$categories = $this->categoryManager->getVisibleCategories();
}
if ( count( $categories ) > 1 ) {
$useIndex = false;
}
$this->addTables( 'linter' );
$this->addWhereFld( 'linter_cat', array_values( $this->categoryManager->getCategoryIds(
$categories
) ) );
$db = $this->getDB();
if ( $params['from'] !== null ) {
$this->addWhere( $db->expr( "linter_id", '>=', $params['from'] ) );
}
if ( $params['pageid'] !== null ) {
// This can be an array or a single pageid
$this->addWhereFld( 'linter_page', $params['pageid'] );
$useIndex = false;
}
if ( $params['namespace'] !== null ) {
$this->addWhereFld( 'page_namespace', $params['namespace'] );
$useIndex = false;
}
if ( $params['title'] !== null ) {
$title = $this->getTitleFromTitleOrPageId( [ 'title' => $params['title'] ] );
$this->addWhereFld( 'page_namespace', $title->getNamespace() );
$this->addWhereFld( 'page_title', $title->getDBkey() );
$useIndex = false;
}
$this->addTables( 'page' );
$this->addJoinConds( [ 'page' => [ 'INNER JOIN', 'page_id=linter_page' ] ] );
$this->addFields( [
'linter_id', 'linter_cat', 'linter_params',
'linter_start', 'linter_end',
'page_namespace', 'page_title',
] );
if ( $useIndex ) {
// T200517#10236299: Force the use of the category index
$this->addOption( 'USE INDEX', [ 'linter' => 'linter_cat_page_position' ] );
}
// Be explicit about ORDER BY
$this->addOption( 'ORDER BY', 'linter_id' );
// Add +1 to limit to know if there's another row for continuation
$this->addOption( 'LIMIT', $params['limit'] + 1 );
$rows = $this->select( __METHOD__ );
$result = $this->getResult();
$count = 0;
foreach ( $rows as $row ) {
$lintError = Database::makeLintError( $this->categoryManager, $row );
if ( !$lintError ) {
continue;
}
$count++;
if ( $count > $params['limit'] ) {
$this->setContinueEnumParameter( 'from', $lintError->lintId );
break;
}
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
$data = [
'pageid' => $title->getArticleID(),
'ns' => $title->getNamespace(),
'title' => $title->getPrefixedText(),
'lintId' => $lintError->lintId,
'category' => $lintError->category,
'location' => $lintError->location,
'templateInfo' => $lintError->templateInfo,
'params' => $lintError->getExtraParams(),
];
// template info and params are an object
$data['params'][ApiResult::META_TYPE] = 'assoc';
$data['templateInfo'][ApiResult::META_TYPE] = 'assoc';
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $data );
if ( !$fit ) {
$this->setContinueEnumParameter( 'from', $lintError->lintId );
break;
}
}
}
/** @inheritDoc */
public function getAllowedParams() {
$visibleCats = $this->categoryManager->getVisibleCategories();
$invisibleCats = $this->categoryManager->getinvisibleCategories();
$categories = array_merge( $visibleCats, $invisibleCats );
return [
'categories' => [
ParamValidator::PARAM_TYPE => $categories,
ParamValidator::PARAM_ISMULTI => true,
// Default is to show all categories
ParamValidator::PARAM_DEFAULT => implode( '|', $visibleCats ),
],
'limit' => [
ParamValidator::PARAM_DEFAULT => 10,
ParamValidator::PARAM_TYPE => 'limit',
IntegerDef::PARAM_MIN => 1,
IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
],
'namespace' => [
ParamValidator::PARAM_TYPE => 'namespace',
ParamValidator::PARAM_ISMULTI => true,
],
'pageid' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_ISMULTI => true,
],
'title' => [
ParamValidator::PARAM_TYPE => 'string',
],
'from' => [
ParamValidator::PARAM_TYPE => 'integer',
],
];
}
/** @inheritDoc */
public function getExamplesMessages() {
return [
'action=query&list=linterrors&lntcategories=obsolete-tag' =>
'apihelp-query+linterrors-example-1',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:25 (7 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
f4/83/ed1ba1ad4846dac5dae129d9c903
Default Alt Text
ApiQueryLintErrors.php (5 KB)

Event Timeline