wiki.techinc.nl/includes/api/ApiLogout.php
Sam Reed d18c0dc315 * (bug 28817) Add reference help page link to API Modules
Start of this bug, fleshed out base code implemented, plus a few key modules (will finish rest up soon)

Tweaked/improved/updated some documentation as I went through also
2011-07-17 16:18:09 +00:00

83 lines
2 KiB
PHP

<?php
/**
*
*
* Created on Jan 4, 2008
*
* Copyright © 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiBase.php' );
}
/**
* API module to allow users to log out of the wiki. API equivalent of
* Special:Userlogout.
*
* @ingroup API
*/
class ApiLogout extends ApiBase {
public function __construct( $main, $action ) {
parent::__construct( $main, $action );
}
public function execute() {
global $wgUser;
$oldName = $wgUser->getName();
$wgUser->logout();
// Give extensions to do something after user logout
$injected_html = '';
wfRunHooks( 'UserLogoutComplete', array( &$wgUser, &$injected_html, $oldName ) );
}
public function isReadMode() {
return false;
}
public function getAllowedParams() {
return array();
}
public function getParamDescription() {
return array();
}
public function getDescription() {
return 'Log out and clear session data';
}
protected function getExamples() {
return array(
'api.php?action=logout'
);
}
public function getHelpUrl() {
return 'http://www.mediawiki.org/wiki/API:Logout';
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}