MediaWiki  REL1_31
ApiLogout.php
Go to the documentation of this file.
1 <?php
24 
31 class ApiLogout extends ApiBase {
32 
33  public function execute() {
35 
36  // Handle bot password logout specially
37  if ( $session->getProvider() instanceof BotPasswordSessionProvider ) {
38  $session->unpersist();
39  return;
40  }
41 
42  // Make sure it's possible to log out
43  if ( !$session->canSetUser() ) {
44  $this->dieWithError(
45  [
46  'cannotlogoutnow-text',
47  $session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() )
48  ],
49  'cannotlogout'
50  );
51  }
52 
53  $user = $this->getUser();
54  $oldName = $user->getName();
55  $user->logout();
56 
57  // Give extensions to do something after user logout
58  $injected_html = '';
59  Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
60  }
61 
62  public function mustBePosted() {
63  return true;
64  }
65 
66  public function needsToken() {
67  return 'csrf';
68  }
69 
70  protected function getWebUITokenSalt( array $params ) {
71  return 'logoutToken';
72  }
73 
74  public function isReadMode() {
75  return false;
76  }
77 
78  protected function getExamplesMessages() {
79  return [
80  'action=logout&token=123ABC'
81  => 'apihelp-logout-example-logout',
82  ];
83  }
84 
85  public function getHelpUrls() {
86  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout';
87  }
88 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
ApiLogout\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiLogout.php:78
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Session\Session\BotPasswordSessionProvider
Session provider for bot passwords.
Definition: BotPasswordSessionProvider.php:34
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiLogout\getWebUITokenSalt
getWebUITokenSalt(array $params)
Fetch the salt used in the Web UI corresponding to this module.
Definition: ApiLogout.php:70
$params
$params
Definition: styleTest.css.php:40
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiLogout
API module to allow users to log out of the wiki.
Definition: ApiLogout.php:31
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiLogout\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiLogout.php:33
ApiLogout\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiLogout.php:74
ApiLogout\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiLogout.php:62
MediaWiki\Session\SessionManager\getGlobalSession
static getGlobalSession()
Get the "global" session.
Definition: SessionManager.php:107
ApiLogout\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiLogout.php:85
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ApiLogout\needsToken
needsToken()
Returns the token type this module requires in order to execute.
Definition: ApiLogout.php:66