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 /**
  24  * Page removal from a user's watchlist
  25  *
  26  * @ingroup Actions
  27  */
  28 class UnwatchAction extends WatchAction {
  29
  30         public function getName() {
  31                 return 'unwatch';
  32         }
  33
  34         protected function getDescription() {
  35                 return $this->msg( 'removewatch' )->escaped();
  36         }
  37
  38         public function onSubmit( $data ) {
  39                 self::doUnwatch( $this->getTitle(), $this->getUser() );
  40
  41                 return true;
  42         }
  43
  44         protected function alterForm( HTMLForm $form ) {
  45                 $form->setSubmitTextMsg( 'confirm-unwatch-button' );
  46         }
  47
  48         protected function preText() {
  49                 return $this->msg( 'confirm-unwatch-top' )->parse();
  50         }
  51
  52         public function onSuccess() {
  53                 $msgKey = $this->getTitle()->isTalkPage() ? 'removedwatchtext-talk' : 'removedwatchtext';
  54                 $this->getOutput()->addWikiMsg( $msgKey, $this->getTitle()->getPrefixedText() );
  55         }
  56
  57         public function doesWrites() {
  58                 return true;
  59         }
  60 }