Page MenuHomeWickedGov Phorge
Files F5957605

ApiQueryGlobalGroups.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiQueryGlobalGroups.php
View Options

<?php
/**
* Created on Sep 20, 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\ApiQuery;
use MediaWiki\Api\ApiQueryBase;
use MediaWiki\Extension\CentralAuth\CentralAuthDatabaseManager;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Query module to list all global groups
*
* @ingroup API
* @ingroup Extensions
*/
class ApiQueryGlobalGroups extends ApiQueryBase {
private CentralAuthDatabaseManager $databaseManager;
public function __construct(
ApiQuery $query,
string $moduleName,
CentralAuthDatabaseManager $databaseManager
) {
parent::__construct( $query, $moduleName, 'ggp' );
$this->databaseManager = $databaseManager;
}
public function execute() {
$params = $this->extractRequestParams();
$prop = array_flip( (array)$params['prop'] );
$APIResult = $this->getResult();
$data = [];
$dbr = $this->databaseManager->getCentralReplicaDB();
$qb = $dbr->newSelectQueryBuilder()
->select( 'ggp_group' )
->distinct()
->from( 'global_group_permissions' )
->caller( __METHOD__ );
if ( isset( $prop['rights'] ) ) {
$qb->select( 'ggp_permission' );
}
$result = $qb->fetchResultSet();
$globalGroups = [];
foreach ( $result as $row ) {
if ( !isset( $globalGroups[$row->ggp_group] ) ) {
$globalGroups[$row->ggp_group] = [ 'rights' => [] ];
}
if ( isset( $prop['rights'] ) ) {
$globalGroups[$row->ggp_group]['rights'][] = $row->ggp_permission;
}
}
foreach ( $globalGroups as $name => $value ) {
$entry = [ 'name' => $name ];
if ( isset( $prop['rights'] ) && count( $value['rights'] ) ) {
$entry['rights'] = $value['rights'];
$APIResult->setIndexedTagName( $entry['rights'], 'right' );
}
$data[] = $entry;
}
$APIResult->setIndexedTagName( $data, 'globalgroup' );
$APIResult->addValue( 'query', $this->getModuleName(), $data );
}
/** @inheritDoc */
public function getCacheMode( $params ) {
return 'public';
}
/** @inheritDoc */
public function getAllowedParams() {
return [
'prop' => [
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_TYPE => [
'rights',
]
]
];
}
/** @inheritDoc */
protected function getExamplesMessages() {
return [
'action=query&list=globalgroups'
=> 'apihelp-query+globalgroups-example-1',
'action=query&list=globalgroups&ggpprop=rights'
=> 'apihelp-query+globalgroups-example-2',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 05:13 (2 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
23/2e/f28d89e0d5f4a48a3764c227d92b
Default Alt Text
ApiQueryGlobalGroups.php (3 KB)

Event Timeline