mediawiki-extensions-Linter/includes/ApiQueryLinterStats.php
Kunal Mehta 35a2ba9a6c Add API meta=linterstats module
This module just exposes the number of lint errors in each category for
tools that want to collect statistics and stuff. It's currently under a
'totals' key to give us more flexibility if we want to add other
information in the future.

Change-Id: Iad5136a6a5989ce5bcb1a00a4f82f49a397e0170
2017-06-06 10:02:49 -07:00

53 lines
1.5 KiB
PHP

<?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 ApiQuery;
use ApiQueryBase;
use ApiResult;
use MediaWiki\MediaWikiServices;
class ApiQueryLinterStats extends ApiQueryBase {
public function __construct( ApiQuery $queryModule ) {
parent::__construct( $queryModule, 'linterstats', 'ls' );
}
/**
* Add totals to output
*/
public function execute() {
$totalsLookup = new TotalsLookup(
new CategoryManager(),
MediaWikiServices::getInstance()->getMainWANObjectCache()
);
$totals = $totalsLookup->getTotals();
ApiResult::setArrayType( $totals, 'assoc' );
$this->getResult()->addValue( [ 'query', 'linterstats' ], 'totals', $totals );
}
public function getExamplesMessages() {
return [
'action=query&meta=linterstats' =>
'apihelp-query+linterstats-example-1',
];
}
}