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 /**
  28  * API module to allow users to log out of the wiki. API equivalent of
  29  * Special:Userlogout.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiLogout extends ApiBase {
  34
  35         public function execute() {
  36                 $user = $this->getUser();
  37                 $oldName = $user->getName();
  38                 $user->logout();
  39
  40                 // Give extensions to do something after user logout
  41                 $injected_html = '';
  42                 wfRunHooks( 'UserLogoutComplete', array( &$user, &$injected_html, $oldName ) );
  43         }
  44
  45         public function isReadMode() {
  46                 return false;
  47         }
  48
  49         public function getAllowedParams() {
  50                 return array();
  51         }
  52
  53         public function getResultProperties() {
  54                 return array();
  55         }
  56
  57         public function getParamDescription() {
  58                 return array();
  59         }
  60
  61         public function getDescription() {
  62                 return 'Log out and clear session data';
  63         }
  64
  65         public function getExamples() {
  66                 return array(
  67                         'api.php?action=logout' => 'Log the current user out',
  68                 );
  69         }
  70
  71         public function getHelpUrls() {
  72                 return 'https://www.mediawiki.org/wiki/API:Logout';
  73         }
  74 }