ApiClearHasMsg.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Api;
 
use MediaWiki\User\TalkPageNotificationManager;
 
class ApiClearHasMsg extends ApiBase {
 
    public function __construct(
        ApiMain $main,
        string $action,
        private readonly TalkPageNotificationManager $talkPageNotificationManager,
    ) {
        parent::__construct( $main, $action );
    }
 
    public function execute() {
        $this->talkPageNotificationManager->removeUserHasNewMessages( $this->getUser() );
 
        $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function mustBePosted() {
        return true;
    }
 
    protected function getExamplesMessages() {
        return [
            'action=clearhasmsg'
                => 'apihelp-clearhasmsg-example-1',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:ClearHasMsg';
    }
}
 
class_alias( ApiClearHasMsg::class, 'ApiClearHasMsg' );