Page MenuHomeWickedGov Phorge
Files F1428383

ApiQueryTags.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ApiQueryTags.php
View Options

<?php
/**
* Copyright © 2009
*
* 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\Api;
use ChangeTags;
use MediaWiki\ChangeTags\ChangeTagsStore;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
/**
* Query module to enumerate change tags.
*
* @ingroup API
*/
class ApiQueryTags extends ApiQueryBase {
private ChangeTagsStore $changeTagsStore;
public function __construct( ApiQuery $query, string $moduleName, ChangeTagsStore $changeTagsStore ) {
parent::__construct( $query, $moduleName, 'tg' );
$this->changeTagsStore = $changeTagsStore;
}
public function execute() {
$params = $this->extractRequestParams();
$prop = array_fill_keys( $params['prop'], true );
$fld_displayname = isset( $prop['displayname'] );
$fld_description = isset( $prop['description'] );
$fld_hitcount = isset( $prop['hitcount'] );
$fld_defined = isset( $prop['defined'] );
$fld_source = isset( $prop['source'] );
$fld_active = isset( $prop['active'] );
$limit = $params['limit'];
$result = $this->getResult();
$softwareDefinedTags = array_fill_keys( $this->changeTagsStore->listSoftwareDefinedTags(), 0 );
$explicitlyDefinedTags = array_fill_keys( $this->changeTagsStore->listExplicitlyDefinedTags(), 0 );
$softwareActivatedTags = array_fill_keys( $this->changeTagsStore->listSoftwareActivatedTags(), 0 );
$tagHitcounts = array_merge(
$softwareDefinedTags,
$explicitlyDefinedTags,
$this->changeTagsStore->tagUsageStatistics()
);
$tags = array_keys( $tagHitcounts );
# Fetch defined tags that aren't past the continuation
if ( $params['continue'] !== null ) {
$cont = $params['continue'];
$tags = array_filter( $tags, static function ( $v ) use ( $cont ) {
return $v >= $cont;
} );
}
# Now make sure the array is sorted for proper continuation
sort( $tags );
$count = 0;
foreach ( $tags as $tagName ) {
if ( ++$count > $limit ) {
$this->setContinueEnumParameter( 'continue', $tagName );
break;
}
$tag = [];
$tag['name'] = $tagName;
if ( $fld_displayname ) {
$tag['displayname'] = ChangeTags::tagDescription( $tagName, $this );
}
if ( $fld_description ) {
$msg = $this->msg( "tag-$tagName-description" );
$tag['description'] = $msg->exists() ? $msg->text() : '';
}
if ( $fld_hitcount ) {
$tag['hitcount'] = (int)$tagHitcounts[$tagName];
}
$isSoftware = isset( $softwareDefinedTags[$tagName] );
$isExplicit = isset( $explicitlyDefinedTags[$tagName] );
if ( $fld_defined ) {
$tag['defined'] = $isSoftware || $isExplicit;
}
if ( $fld_source ) {
$tag['source'] = [];
if ( $isSoftware ) {
$tag['source'][] = 'software';
// @TODO: remove backwards compatibility entry (T247552)
$tag['source'][] = 'extension';
}
if ( $isExplicit ) {
$tag['source'][] = 'manual';
}
}
if ( $fld_active ) {
$tag['active'] = $isExplicit || isset( $softwareActivatedTags[$tagName] );
}
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $tag );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $tagName );
break;
}
}
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'tag' );
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return [
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'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
],
'prop' => [
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_TYPE => [
'displayname',
'description',
'hitcount',
'defined',
'source',
'active',
],
ParamValidator::PARAM_ISMULTI => true,
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
]
];
}
protected function getExamplesMessages() {
return [
'action=query&list=tags&tgprop=displayname|description|hitcount|defined'
=> 'apihelp-query+tags-example-simple',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tags';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiQueryTags::class, 'ApiQueryTags' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 16:09 (13 h, 52 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
96/1f/0e91b3c900c067c12348dfd5e84c
Default Alt Text
ApiQueryTags.php (5 KB)

Event Timeline