Page MenuHomeWickedGov Phorge
Files F4092488

ApiQueryWikiSets.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiQueryWikiSets.php
View Options

<?php
/**
* Created on Sep 06, 2012
*
* CentralAuth extension
*
* Copyright (C) 2012 Jan Luca Naumann jan AT toolserver DOT org
*
* 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
*/
namespace MediaWiki\Extension\CentralAuth\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiQuery;
use MediaWiki\Api\ApiQueryBase;
use MediaWiki\Extension\CentralAuth\CentralAuthWikiListService;
use MediaWiki\Extension\CentralAuth\WikiSet;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
/**
* Query module to list the wiki sets
*
* @ingroup API
* @ingroup Extensions
*/
class ApiQueryWikiSets extends ApiQueryBase {
private CentralAuthWikiListService $wikiListService;
public function __construct(
ApiQuery $query,
string $moduleName,
CentralAuthWikiListService $wikiListService
) {
parent::__construct( $query, $moduleName, 'ws' );
$this->wikiListService = $wikiListService;
}
public function execute() {
$params = $this->extractRequestParams();
$prop = array_flip( (array)$params['prop'] );
$from = $params['from'] ?? null;
$APIResult = $this->getResult();
$data = [];
$wikiList = $this->wikiListService->getWikiList();
foreach (
WikiSet::getAllWikiSets( $from, $params['limit'], $params['orderbyname'] ) as $wikiSet
) {
$entry = [];
$entry['id'] = $wikiSet->getId();
$entry['name'] = $wikiSet->getName();
if ( isset( $prop['type'] ) ) {
$entry['type'] = $wikiSet->getType();
}
if ( isset( $prop['wikisincluded'] ) ) {
$entry['wikisincluded'] = $wikiSet->getWikis();
if ( count( $entry['wikisincluded'] ) ) {
$APIResult->setIndexedTagName( $entry['wikisincluded'], 'wiki' );
}
}
if ( isset( $prop['wikisnotincluded'] ) ) {
$entry['wikisnotincluded'] = array_diff(
$wikiList, $wikiSet->getWikis() );
if ( count( $entry['wikisnotincluded'] ) ) {
$APIResult->setIndexedTagName( $entry['wikisnotincluded'], 'wiki' );
}
}
$data[] = $entry;
}
$APIResult->setIndexedTagName( $data, 'wikiset' );
$APIResult->addValue( 'query', $this->getModuleName(), $data );
}
/** @inheritDoc */
public function getCacheMode( $params ) {
return 'public';
}
/** @inheritDoc */
public function getAllowedParams() {
return [
'from' => null,
'prop' => [
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_TYPE => [
'type',
'wikisincluded',
'wikisnotincluded'
],
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
],
'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
],
'orderbyname' => [
ParamValidator::PARAM_DEFAULT => false,
ParamValidator::PARAM_TYPE => 'boolean'
]
];
}
/** @inheritDoc */
protected function getExamplesMessages() {
return [
'action=query&list=wikisets'
=> 'apihelp-query+wikisets-example-1',
'action=query&list=wikisets&wsprop=type&wslimit=200'
=> 'apihelp-query+wikisets-example-2',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 18 2026, 12:15 (4 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
48/54/0cef8bbcaa20f0116c53567b49fa
Default Alt Text
ApiQueryWikiSets.php (3 KB)

Event Timeline