MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
35 class ApiLogout extends ApiBase {
37  public function execute() {
40  // Handle bot password logout specially
41  if ( $session->getProvider() instanceof BotPasswordSessionProvider ) {
42  $session->unpersist();
43  return;
44  }
46  // Make sure it's possible to log out
47  if ( !$session->canSetUser() ) {
48  $this->dieUsage(
49  'Cannot log out when using ' .
50  $session->getProvider()->describe( Language::factory( 'en' ) ),
51  'cannotlogout'
52  );
53  }
55  $user = $this->getUser();
56  $oldName = $user->getName();
57  $user->logout();
59  // Give extensions to do something after user logout
60  $injected_html = '';
61  Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
62  }
64  public function isReadMode() {
65  return false;
66  }
68  protected function getExamplesMessages() {
69  return [
70  'action=logout'
71  => 'apihelp-logout-example-logout',
72  ];
73  }
75  public function getHelpUrls() {
76  return '';
77  }
78 }
Definition: ApiLogout.php:75
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: ApiLogout.php:68
API module to allow users to log out of the wiki.
Definition: ApiLogout.php:35
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Definition: ApiLogout.php:64
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 local account $user
Definition: hooks.txt:242
static getGlobalSession()
Get the "global" session.
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
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1585
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:181
Get the User object.