includes/api/ApiLogout.php

   1 <?php
   2
   3 /*
   4  * Created on Jan 4, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiBase.php');
  29 }
  30
  31 class ApiLogout extends ApiBase {
  32
  33         public function __construct($main, $action) {
  34                 parent :: __construct($main, $action, 'lo');
  35         }
  36
  37         public function execute() {
  38                 global $wgUser;
  39                 $wgUser->logout();
  40         }
  41
  42         protected function getAllowedParams() {
  43                 return array ();
  44         }
  45
  46         protected function getParamDescription() {
  47                 return array ();
  48         }
  49
  50         protected function getDescription() {
  51                 return array (
  52                         'This module is used to logout and clear session data'
  53                 );
  54         }
  55
  56         protected function getExamples() {
  57                 return array(
  58                         'api.php?action=logout'
  59                 );
  60         }
  61
  62         public function getVersion() {
  63                 return __CLASS__ . ': $Id$';
  64         }
  65 }