mediawiki-extensions-AbuseF.../includes/api/ApiAbuseFilterUnblockAutopromote.php
Thiemo Kreuz 7047dba1f1 Update a few unspecific PHPDoc comments
Change-Id: I363d7f854c550654c5d4345f381e3731de6f2d3c
2020-12-03 09:50:09 +01:00

89 lines
2 KiB
PHP

<?php
use MediaWiki\Extension\AbuseFilter\AbuseFilterServices;
class ApiAbuseFilterUnblockAutopromote extends ApiBase {
/**
* @inheritDoc
*/
public function execute() {
$this->checkUserRightsAny( 'abusefilter-modify' );
$params = $this->extractRequestParams();
$target = User::newFromName( $params['user'] );
if ( $target === false ) {
$encParamName = $this->encodeParamName( 'user' );
$this->dieWithError(
[ 'apierror-baduser', $encParamName, wfEscapeWikiText( $params['user'] ) ],
"baduser_{$encParamName}"
);
}
$block = $this->getUser()->getBlock();
if ( $block && $block->isSitewide() ) {
$this->dieBlocked( $block );
}
$msg = $this->msg( 'abusefilter-tools-restoreautopromote' )->inContentLanguage()->text();
$blockAutopromoteStore = AbuseFilterServices::getBlockAutopromoteStore();
$res = $blockAutopromoteStore->unblockAutopromote( $target, $this->getUser(), $msg );
if ( $res === false ) {
$this->dieWithError( [ 'abusefilter-reautoconfirm-none', $target->getName() ], 'notsuspended' );
}
$finalResult = [ 'user' => $params['user'] ];
$this->getResult()->addValue( null, $this->getModuleName(), $finalResult );
}
/**
* @see ApiBase::mustBePosted()
* @return bool
*/
public function mustBePosted() {
return true;
}
/**
* @see ApiBase::isWriteMode()
* @return bool
*/
public function isWriteMode() {
return true;
}
/**
* @see ApiBase::getAllowedParams()
* @return array
*/
public function getAllowedParams() {
return [
'user' => [
ApiBase::PARAM_TYPE => 'user',
ApiBase::PARAM_REQUIRED => true
],
'token' => null,
];
}
/**
* @see ApiBase::needsToken()
* @return string
*/
public function needsToken() {
return 'csrf';
}
/**
* @see ApiBase::getExamplesMessages()
* @return array
*/
protected function getExamplesMessages() {
return [
'action=abusefilterunblockautopromote&user=Example&token=123ABC'
=> 'apihelp-abusefilterunblockautopromote-example-1',
];
}
}