includes/api/ApiClearHasMsg.php

   1 <?php
   2
   3 /**
   4  * Created on August 26, 2014
   5  *
   6  * Copyright © 2014 Petr Bena (benapetr@gmail.com)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * API module that clears the hasmsg flag for current user
  28  * @ingroup API
  29  */
  30 class ApiClearHasMsg extends ApiBase {
  31         public function execute() {
  32                 $user = $this->getUser();
  33                 $user->setNewtalk( false );
  34                 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
  35         }
  36
  37         public function isWriteMode() {
  38                 return true;
  39         }
  40
  41         public function mustBePosted() {
  42                 return false;
  43         }
  44
  45         public function getDescription() {
  46                 return array( 'Clears the hasmsg flag for current user.' );
  47         }
  48
  49         public function getExamples() {
  50                 return array(
  51                         'api.php?action=clearhasmsg' => 'Clears the hasmsg flag for current user',
  52                 );
  53         }
  54
  55         public function getHelpUrls() {
  56                 return 'https://www.mediawiki.org/wiki/API:ClearHasMsg';
  57         }
  58 }