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 /**
  32  * API module to allow users to log out of the wiki. API equivalent of
  33  * Special:Userlogout.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiLogout extends ApiBase {
  38
  39         public function __construct($main, $action) {
  40                 parent :: __construct($main, $action);
  41         }
  42
  43         public function execute() {
  44                 global $wgUser;
  45                 $wgUser->logout();
  46
  47                 // Give extensions to do something after user logout
  48                 $injected_html = '';
  49                 wfRunHooks( 'UserLogoutComplete', array(&$wgUser, &$injected_html) );
  50         }
  51
  52         public function getAllowedParams() {
  53                 return array ();
  54         }
  55
  56         public function getParamDescription() {
  57                 return array ();
  58         }
  59
  60         public function getDescription() {
  61                 return array (
  62                         'This module is used to logout and clear session data'
  63                 );
  64         }
  65
  66         protected function getExamples() {
  67                 return array(
  68                         'api.php?action=logout'
  69                 );
  70         }
  71
  72         public function getVersion() {
  73                 return __CLASS__ . ': $Id$';
  74         }
  75 }