includes/actions/UnwatchAction.php

   1 <?php
   2 /**
   3  * Performs the unwatch actions on a page
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  18  *
  19  * @file
  20  * @ingroup Actions
  21  */
  22
  23 use MediaWiki\Context\IContextSource;
  24 use MediaWiki\HTMLForm\HTMLForm;
  25 use MediaWiki\Watchlist\WatchedItemStore;
  26 use MediaWiki\Watchlist\WatchlistManager;
  27
  28 /**
  29  * Page removal from a user's watchlist
  30  *
  31  * @ingroup Actions
  32  */
  33 class UnwatchAction extends WatchAction {
  34
  35         private WatchlistManager $watchlistManager;
  36
  37         /**
  38          * @param Article $article
  39          * @param IContextSource $context
  40          * @param WatchlistManager $watchlistManager
  41          * @param WatchedItemStore $watchedItemStore
  42          */
  43         public function __construct(
  44                 Article $article,
  45                 IContextSource $context,
  46                 WatchlistManager $watchlistManager,
  47                 WatchedItemStore $watchedItemStore
  48         ) {
  49                 parent::__construct( $article, $context, $watchlistManager, $watchedItemStore );
  50                 $this->watchlistManager = $watchlistManager;
  51         }
  52
  53         public function getName() {
  54                 return 'unwatch';
  55         }
  56
  57         public function onSubmit( $data ) {
  58                 $this->watchlistManager->removeWatch(
  59                         $this->getAuthority(),
  60                         $this->getTitle()
  61                 );
  62
  63                 return true;
  64         }
  65
  66         protected function getFormFields() {
  67                 return [
  68                         'intro' => [
  69                                 'type' => 'info',
  70                                 'raw' => true,
  71                                 'default' => $this->msg( 'confirm-unwatch-top' )->parse()
  72                         ]
  73                 ];
  74         }
  75
  76         protected function alterForm( HTMLForm $form ) {
  77                 parent::alterForm( $form );
  78                 $form->setWrapperLegendMsg( 'removewatch' );
  79                 $form->setSubmitTextMsg( 'confirm-unwatch-button' );
  80         }
  81
  82         public function onSuccess() {
  83                 $msgKey = $this->getTitle()->isTalkPage() ? 'removedwatchtext-talk' : 'removedwatchtext';
  84                 $this->getOutput()->addWikiMsg( $msgKey, $this->getTitle()->getPrefixedText() );
  85         }
  86
  87         public function doesWrites() {
  88                 return true;
  89         }
  90 }