Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
41.67% |
5 / 12 |
|
50.00% |
3 / 6 |
CRAP | |
0.00% |
0 / 1 |
| ApiClearHasMsg | |
45.45% |
5 / 11 |
|
50.00% |
3 / 6 |
11.84 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| execute | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| isWriteMode | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| mustBePosted | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getExamplesMessages | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| getHelpUrls | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Copyright © 2014 Petr Bena (benapetr@gmail.com) |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License along |
| 17 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 18 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 19 | * http://www.gnu.org/copyleft/gpl.html |
| 20 | * |
| 21 | * @file |
| 22 | */ |
| 23 | |
| 24 | namespace MediaWiki\Api; |
| 25 | |
| 26 | use MediaWiki\User\TalkPageNotificationManager; |
| 27 | |
| 28 | /** |
| 29 | * API module that clears the hasmsg flag for current user |
| 30 | * @ingroup API |
| 31 | */ |
| 32 | class ApiClearHasMsg extends ApiBase { |
| 33 | |
| 34 | private TalkPageNotificationManager $talkPageNotificationManager; |
| 35 | |
| 36 | public function __construct( |
| 37 | ApiMain $main, |
| 38 | string $action, |
| 39 | TalkPageNotificationManager $talkPageNotificationManager |
| 40 | ) { |
| 41 | parent::__construct( $main, $action ); |
| 42 | $this->talkPageNotificationManager = $talkPageNotificationManager; |
| 43 | } |
| 44 | |
| 45 | public function execute() { |
| 46 | $this->talkPageNotificationManager->removeUserHasNewMessages( $this->getUser() ); |
| 47 | |
| 48 | $this->getResult()->addValue( null, $this->getModuleName(), 'success' ); |
| 49 | } |
| 50 | |
| 51 | public function isWriteMode() { |
| 52 | return true; |
| 53 | } |
| 54 | |
| 55 | public function mustBePosted() { |
| 56 | return true; |
| 57 | } |
| 58 | |
| 59 | protected function getExamplesMessages() { |
| 60 | return [ |
| 61 | 'action=clearhasmsg' |
| 62 | => 'apihelp-clearhasmsg-example-1', |
| 63 | ]; |
| 64 | } |
| 65 | |
| 66 | public function getHelpUrls() { |
| 67 | return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:ClearHasMsg'; |
| 68 | } |
| 69 | } |
| 70 | |
| 71 | /** @deprecated class alias since 1.43 */ |
| 72 | class_alias( ApiClearHasMsg::class, 'ApiClearHasMsg' ); |