4 * Created on Jan 4, 2008
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiBase.php');
32 * API module to allow users to log out of the wiki. API equivalent of
37 class ApiLogout extends ApiBase {
39 public function __construct($main, $action) {
40 parent :: __construct($main, $action);
43 public function execute() {
45 $oldName = $wgUser->getName();
48 // Give extensions to do something after user logout
50 wfRunHooks( 'UserLogoutComplete', array(&$wgUser, &$injected_html, $oldName) );
53 public function getAllowedParams() {
57 public function getParamDescription() {
61 public function getDescription() {
63 'This module is used to logout and clear session data'
67 protected function getExamples() {
69 'api.php?action=logout'
73 public function getVersion() {
74 return __CLASS__ . ': $Id: ApiLogout.php 43522 2008-11-15 01:23:39Z brion $';