includes/api/ApiLogout.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Jan 4, 2008
   6  *
   7  * Copyright © 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiBase.php' );
  30 }
  31
  32 /**
  33  * API module to allow users to log out of the wiki. API equivalent of
  34  * Special:Userlogout.
  35  *
  36  * @ingroup API
  37  */
  38 class ApiLogout extends ApiBase {
  39
  40         public function __construct( $main, $action ) {
  41                 parent::__construct( $main, $action );
  42         }
  43
  44         public function execute() {
  45                 $user = $this->getUser();
  46                 $oldName = $user->getName();
  47                 $user->logout();
  48
  49                 // Give extensions to do something after user logout
  50                 $injected_html = '';
  51                 wfRunHooks( 'UserLogoutComplete', array( &$user, &$injected_html, $oldName ) );
  52         }
  53
  54         public function isReadMode() {
  55                 return false;
  56         }
  57
  58         public function getAllowedParams() {
  59                 return array();
  60         }
  61
  62         public function getParamDescription() {
  63                 return array();
  64         }
  65
  66         public function getDescription() {
  67                 return 'Log out and clear session data';
  68         }
  69
  70         public function getExamples() {
  71                 return array(
  72                         'api.php?action=logout'
  73                 );
  74         }
  75
  76         public function getHelpUrls() {
  77                 return 'http://www.mediawiki.org/wiki/API:Logout';
  78         }
  79
  80         public function getVersion() {
  81                 return __CLASS__ . ': $Id$';
  82         }
  83 }