UnwatchAction.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Actions;
 
use MediaWiki\Context\IContextSource;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Page\Article;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\Watchlist\WatchedItemStore;
use MediaWiki\Watchlist\WatchlistLabelStore;
use MediaWiki\Watchlist\WatchlistManager;
 
class UnwatchAction extends WatchAction {
 
    public function __construct(
        Article $article,
        IContextSource $context,
        private readonly WatchlistManager $watchlistManager,
        WatchedItemStore $watchedItemStore,
        WatchlistLabelStore $watchlistLabelStore,
        UserOptionsLookup $userOptionsLookup,
    ) {
        parent::__construct( $article, $context, $watchlistManager, $watchedItemStore, $watchlistLabelStore,
            $userOptionsLookup );
    }
 
    public function getName() {
        return 'unwatch';
    }
 
    public function onSubmit( $data ) {
        $this->watchlistManager->removeWatch(
            $this->getAuthority(),
            $this->getTitle()
        );
 
        return true;
    }
 
    protected function getFormFields() {
        return [
            'intro' => [
                'type' => 'info',
                'raw' => true,
                'default' => $this->msg( 'confirm-unwatch-top' )->parse()
            ]
        ];
    }
 
    protected function alterForm( HTMLForm $form ) {
        parent::alterForm( $form );
        $form->setWrapperLegendMsg( 'removewatch' );
        $form->setSubmitTextMsg( 'confirm-unwatch-button' );
    }
 
    public function onSuccess() {
        $msgKey = $this->getTitle()->isTalkPage() ? 'removedwatchtext-talk' : 'removedwatchtext';
        $this->getOutput()->addWikiMsg( $msgKey, $this->getTitle()->getPrefixedText() );
    }
 
    public function doesWrites() {
        return true;
    }
}
 
class_alias( UnwatchAction::class, 'UnwatchAction' );