jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/371762 )
Change subject: Remove unused API class ApiNewsletterManage ...................................................................... Remove unused API class ApiNewsletterManage We use ContentHandler (default page edit) API now Bug: T173282 Change-Id: Ie986f66f755927d4978edabcab2aba2ee39f5f57 --- M extension.json M i18n/en.json M i18n/qqq.json D includes/api/ApiNewsletterManage.php 4 files changed, 1 insertion(+), 103 deletions(-) Approvals: Legoktm: Looks good to me, approved jenkins-bot: Verified diff --git a/extension.json b/extension.json index 6d6e59a..c84eddb 100644 --- a/extension.json +++ b/extension.json @@ -41,8 +41,7 @@ "Newsletter": "SpecialNewsletter" }, "APIModules": { - "newslettersubscribe": "ApiNewsletterSubscribe", - "newslettermanage": "ApiNewsletterManage" + "newslettersubscribe": "ApiNewsletterSubscribe" }, "MessagesDirs": { "Newsletter": [ @@ -83,7 +82,6 @@ "SpecialNewsletters": "includes/specials/SpecialNewsletters.php", "SpecialNewsletterCreate": "includes/specials/SpecialNewsletterCreate.php", "NewsletterTablePager": "includes/specials/pagers/NewsletterTablePager.php", - "ApiNewsletterManage": "includes/api/ApiNewsletterManage.php", "ApiNewsletterSubscribe": "includes/api/ApiNewsletterSubscribe.php", "NewsletterContent": "includes/content/NewsletterContent.php", "NewsletterContentHandler": "includes/content/NewsletterContentHandler.php", diff --git a/i18n/en.json b/i18n/en.json index c12678a..4c20de3 100644 --- a/i18n/en.json +++ b/i18n/en.json @@ -173,6 +173,5 @@ "newsletter-api-error-notfound": "Newsletter does not exist", "newsletter-api-error-nopermissions": "You do not have permission to manage newsletters.", "newsletter-api-error-invalidpublisher-registered": "Publisher is not a registered user.", - "newsletter-api-error-managefailure": "Manage action: $1 failed.", "newsletter-api-error-subscribe-notloggedin": "You must be logged-in to subscribe to newsletters." } diff --git a/i18n/qqq.json b/i18n/qqq.json index d8e47e8..acfff15 100644 --- a/i18n/qqq.json +++ b/i18n/qqq.json @@ -180,6 +180,5 @@ "newsletter-api-error-notfound": "Error message to be displayed in the API when a newsletter is not found.", "newsletter-api-error-nopermissions": "Error message to be displayed in the API when the requesting user does not have the required permissions.", "newsletter-api-error-invalidpublisher-registered": "Error message to be displayed in the API when a given publisher is not a registered account.", - "newsletter-api-error-managefailure": "Error message to be displayed in the API when the requested manage action has failed.", "newsletter-api-error-subscribe-notloggedin": "Error message to be displayed in the API when a request is made to subscribe to a newsletter by an anonymous user.." } diff --git a/includes/api/ApiNewsletterManage.php b/includes/api/ApiNewsletterManage.php deleted file mode 100644 index 2e680a5..0000000 --- a/includes/api/ApiNewsletterManage.php +++ /dev/null @@ -1,98 +0,0 @@ -<?php - -/** - * API to manage newsletters - * - * @license GNU GPL v2+ - * @author Tina Johnson - */ -class ApiNewsletterManage extends ApiBase { - - public function execute() { - $user = $this->getUser(); - - $params = $this->extractRequestParams(); - $newsletter = Newsletter::newFromID( $params['id'] ); - - if ( !$newsletter ) { - $this->dieWithError( 'newsletter-api-error-notfound', 'notfound' ); - } - - if ( !$newsletter->canManage( $user ) ) { - $this->dieWithError( 'newsletter-api-error-nopermissions', 'nopermissions' ); - } - - $publisher = User::newFromId( $params['publisher'] ); - if ( !$publisher || $publisher->getId() === 0 ) { - $this->dieWithError( 'newsletter-api-error-invalidpublisher-registered', 'invalidpublisher' ); - } - - $store = NewsletterStore::getDefaultInstance(); - - $success = false; - $action = $params['do']; - if ( $action === 'addpublisher' ) { - $success = $store->addPublisher( $newsletter, $publisher ); - } elseif ( $action === 'removepublisher' ) { - $success = $store->removePublisher( $newsletter, $publisher ); - } - - if ( !$success ) { - $this->dieWithError( - new Message( 'newsletter-api-error-managefailure', [ $action ] ), - 'managefailure' - ); - } - - // Success - $this->getResult()->addValue( null, $this->getModuleName(), - [ - 'id' => $newsletter->getId(), - 'name' => $newsletter->getName(), - ] - ); - } - - public function getAllowedParams() { - return [ - 'id' => [ - ApiBase::PARAM_TYPE => 'integer', - ApiBase::PARAM_REQUIRED => true, - ], - 'do' => [ - ApiBase::PARAM_TYPE => [ 'addpublisher', 'removepublisher' ], - ApiBase::PARAM_REQUIRED => true, - ], - 'publisher' => [ - ApiBase::PARAM_TYPE => 'string', - ApiBase::PARAM_REQUIRED => true, - ], - ]; - } - - /** - * @see ApiBase::getExamplesMessages() - * @return array - */ - protected function getExamplesMessages() { - return [ - 'action=newslettermanage&id=1&do=addpublisher&publisher=3' - => 'apihelp-newslettermanage-example-1', - 'action=newslettermanage&id=2&do=removepublisher&publisher=5' - => 'apihelp-newslettermanage-example-2', - ]; - } - - public function isWriteMode() { - return true; - } - - public function needsToken() { - return 'csrf'; - } - - public function mustBePosted() { - return true; - } - -} -- To view, visit https://gerrit.wikimedia.org/r/371762 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ie986f66f755927d4978edabcab2aba2ee39f5f57 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Newsletter Gerrit-Branch: master Gerrit-Owner: 01tonythomas <01tonytho...@gmail.com> Gerrit-Reviewer: Addshore <addshorew...@gmail.com> Gerrit-Reviewer: Brian Wolff <bawolff...@gmail.com> Gerrit-Reviewer: Legoktm <lego...@member.fsf.org> Gerrit-Reviewer: Siebrand <siebr...@kitano.nl> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits