mediawiki-extensions-Discus.../includes/ApiDiscussionToolsSubscribe.php
Bartosz Dziewoński e72f58ca78 Remove some redundant PHPDoc comments
Inspired by this Wikitech-l discussion:
https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/thread/NWXPNHRNLEVXHSWX33H473OAWQP6CDOA/

To keep this simple for now, I am only removing redundant PHPDoc
comments on constructors, and only when all the documentation for
parameters completely duplicates type hints.

More could be done, but that can happen later when we have better
tooling. Redundant comments on constructors that take a dozen services
are by far the most annoying for me and I want them gone now.

Change-Id: I86cbf7d6e48035cfa06f780c8fb1b02e68709a0c
2022-11-29 18:47:18 +00:00

112 lines
2.2 KiB
PHP

<?php
namespace MediaWiki\Extension\DiscussionTools;
use ApiBase;
use ApiMain;
use Title;
use Wikimedia\ParamValidator\ParamValidator;
class ApiDiscussionToolsSubscribe extends ApiBase {
private SubscriptionStore $subscriptionStore;
public function __construct(
ApiMain $main,
string $name,
SubscriptionStore $subscriptionStore
) {
parent::__construct( $main, $name );
$this->subscriptionStore = $subscriptionStore;
}
/**
* @inheritDoc
*/
public function execute() {
$user = $this->getUser();
if ( !$user->isRegistered() ) {
$this->dieWithError( 'apierror-mustbeloggedin-generic', 'notloggedin' );
}
$params = $this->extractRequestParams();
$title = Title::newFromText( $params['page'] );
$result = null;
if ( !$title ) {
$this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['page'] ) ] );
}
$commentName = $params['commentname'];
$subscribe = $params['subscribe'];
if ( $subscribe ) {
$success = $this->subscriptionStore->addSubscriptionForUser(
$user,
$title,
$commentName
);
if ( !$success ) {
$this->dieWithError( 'apierror-discussiontools-subscription-failed-add', 'subscription-failed' );
}
} else {
$success = $this->subscriptionStore->removeSubscriptionForUser(
$user,
$commentName
);
if ( !$success ) {
$this->dieWithError( 'apierror-discussiontools-subscription-failed-remove', 'subscription-failed' );
}
}
$result = [
'page' => $title,
'commentname' => $commentName,
'subscribe' => $subscribe,
];
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
/**
* @inheritDoc
*/
public function getAllowedParams() {
return [
'page' => [
ParamValidator::PARAM_REQUIRED => true,
],
'token' => [
ParamValidator::PARAM_REQUIRED => true,
],
'commentname' => [
ParamValidator::PARAM_REQUIRED => true,
],
'subscribe' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_REQUIRED => true,
],
];
}
/**
* @inheritDoc
*/
public function needsToken() {
return 'csrf';
}
/**
* @inheritDoc
*/
public function isInternal() {
return true;
}
/**
* @inheritDoc
*/
public function isWriteMode() {
return true;
}
}