Page MenuHomeWickedGov Phorge
Files F4057147

ApiDeleteGlobalAccount.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiDeleteGlobalAccount.php
View Options

<?php
/**
* Created on Oct 21, 2012
*
* CentralAuth extension
*
* Copyright (C) 2012 Alex Monk (krenair@gmail.com)
*
* 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\Extension\CentralAuth\User\CentralAuthUser;
use Wikimedia\ParamValidator\ParamValidator;
/**
* API module to delete a global account.
*
* @ingroup API
* @ingroup Extensions
*/
class ApiDeleteGlobalAccount extends ApiBase {
public function execute() {
// Heavily based on code from SpecialCentralAuth::doSubmit
$this->checkUserRightsAny( 'centralauth-unmerge' );
$params = $this->extractRequestParams();
$globalUser = CentralAuthUser::getPrimaryInstanceByName( $params['user'] );
if ( !$globalUser->exists() ||
( $globalUser->isSuppressed() && !$this->getAuthority()->isAllowed( 'centralauth-suppress' ) )
) {
$this->dieWithError( [ 'nosuchusershort', wfEscapeWikitext( $globalUser->getName() ) ] );
}
$status = $globalUser->adminDelete( $params['reason'], $this->getUser() );
if ( $status->isGood() ) {
$this->getResult()->addValue( null, $this->getModuleName(), [
'user' => $globalUser->getName(),
'reason' => $params['reason']
] );
} else {
$error = $this->getErrorFormatter()->arrayFromStatus( $status );
$this->getResult()->addValue( 'error', null, $error );
}
}
/** @inheritDoc */
public function getAllowedParams() {
return [
'user' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
],
'reason' => [
ParamValidator::PARAM_TYPE => 'string',
],
];
}
/** @inheritDoc */
protected function getExamplesMessages() {
return [
'action=deleteglobalaccount&user=Example&reason=Because+I+can'
=> 'apihelp-deleteglobalaccount-example-1',
];
}
/** @inheritDoc */
public function mustBePosted() {
return true;
}
/** @inheritDoc */
public function isWriteMode() {
return true;
}
/** @inheritDoc */
public function needsToken() {
return 'deleteglobalaccount';
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 03:52 (12 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
4f/c3/1c5c0ae3810793e5cb8e67228a2e
Default Alt Text
ApiDeleteGlobalAccount.php (2 KB)

Event Timeline