includes/api/ApiClearHasMsg.php

   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 /**
  25  * API module that clears the hasmsg flag for current user
  26  * @ingroup API
  27  */
  28 class ApiClearHasMsg extends ApiBase {
  29         public function execute() {
  30                 $user = $this->getUser();
  31                 $user->setNewtalk( false );
  32                 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
  33         }
  34
  35         public function isWriteMode() {
  36                 return true;
  37         }
  38
  39         public function mustBePosted() {
  40                 return true;
  41         }
  42
  43         protected function getExamplesMessages() {
  44                 return [
  45                         'action=clearhasmsg'
  46                                 => 'apihelp-clearhasmsg-example-1',
  47                 ];
  48         }
  49
  50         public function getHelpUrls() {
  51                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:ClearHasMsg';
  52         }
  53 }