MediaWiki  1.29.1
ApiLogout.php
Go to the documentation of this file.
1 <?php
28 
35 class ApiLogout extends ApiBase {
36 
37  public function execute() {
39 
40  // Handle bot password logout specially
41  if ( $session->getProvider() instanceof BotPasswordSessionProvider ) {
42  $session->unpersist();
43  return;
44  }
45 
46  // Make sure it's possible to log out
47  if ( !$session->canSetUser() ) {
48  $this->dieWithError(
49  [
50  'cannotlogoutnow-text',
51  $session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() )
52  ],
53  'cannotlogout'
54  );
55  }
56 
57  $user = $this->getUser();
58  $oldName = $user->getName();
59  $user->logout();
60 
61  // Give extensions to do something after user logout
62  $injected_html = '';
63  Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
64  }
65 
66  public function isReadMode() {
67  return false;
68  }
69 
70  protected function getExamplesMessages() {
71  return [
72  'action=logout'
73  => 'apihelp-logout-example-logout',
74  ];
75  }
76 
77  public function getHelpUrls() {
78  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout';
79  }
80 }
ApiLogout\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiLogout.php:70
MediaWiki\Session\Session\BotPasswordSessionProvider
Session provider for bot passwords.
Definition: BotPasswordSessionProvider.php:34
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$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:246
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
ApiLogout
API module to allow users to log out of the wiki.
Definition: ApiLogout.php:35
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:35
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:41
ContextSource\getLanguage
getLanguage()
Get the Language object.
Definition: ContextSource.php:143
ApiLogout\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiLogout.php:37
ApiLogout\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiLogout.php:66
MediaWiki\Session\SessionManager\getGlobalSession
static getGlobalSession()
Get the "global" session.
Definition: SessionManager.php:106
ApiLogout\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiLogout.php:77
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
ApiBase\getErrorFormatter
getErrorFormatter()
Get the error formatter.
Definition: ApiBase.php:624