Page MenuHomeWickedGov Phorge
Files F4111325

ApiLogout.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiLogout.php
View Options

<?php
/**
* Copyright © 2008 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
*
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Session\BotPasswordSessionProvider;
/**
* API module to allow users to log out of the wiki. API equivalent of
* Special:Userlogout.
*
* @ingroup API
*/
class ApiLogout extends ApiBase {
public function execute() {
$session = $this->getRequest()->getSession();
// Handle bot password logout specially
if ( $session->getProvider() instanceof BotPasswordSessionProvider ) {
$session->unpersist();
return;
}
// Make sure it's possible to log out
if ( !$session->canSetUser() ) {
$this->dieWithError(
[
'cannotlogoutnow-text',
$session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() )
],
'cannotlogout'
);
}
$user = $this->getUser();
if ( $user->isAnon() ) {
// Cannot logout a anon user, so add a warning and return early.
$this->addWarning( 'apierror-mustbeloggedin-generic', 'notloggedin' );
return;
}
$oldName = $user->getName();
$user->logout();
// Give extensions to do something after user logout
$injected_html = '';
$this->getHookRunner()->onUserLogoutComplete( $user, $injected_html, $oldName );
}
/** @inheritDoc */
public function mustBePosted() {
return true;
}
/** @inheritDoc */
public function needsToken() {
return 'csrf';
}
/** @inheritDoc */
public function isWriteMode() {
// While core is optimized by default to not require DB writes on log out,
// these are authenticated POST requests and extensions (eg. CheckUser) are
// allowed to perform DB writes here without warnings.
return true;
}
/** @inheritDoc */
protected function getWebUITokenSalt( array $params ) {
return 'logoutToken';
}
/** @inheritDoc */
public function isReadMode() {
return false;
}
/** @inheritDoc */
protected function getExamplesMessages() {
return [
'action=logout&token=123ABC'
=> 'apihelp-logout-example-logout',
];
}
/** @inheritDoc */
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiLogout::class, 'ApiLogout' );

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 22:17 (1 d, 13 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
51/9d/b8e7d220b6616dafc165b8c7964b
Default Alt Text
ApiLogout.php (2 KB)

Event Timeline