MediaWiki  REL1_31
ApiClearHasMsg.php
Go to the documentation of this file.
1 <?php
2 
28 class ApiClearHasMsg extends ApiBase {
29  public function execute() {
30  $user = $this->getUser();
31  $user->setNewtalk( false );
32  $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
33  }
34 
35  public function isWriteMode() {
36  return true;
37  }
38 
39  public function mustBePosted() {
40  return true;
41  }
42 
43  protected function getExamplesMessages() {
44  return [
45  'action=clearhasmsg'
46  => 'apihelp-clearhasmsg-example-1',
47  ];
48  }
49 
50  public function getHelpUrls() {
51  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:ClearHasMsg';
52  }
53 }
$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
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiClearHasMsg\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiClearHasMsg.php:29
ApiClearHasMsg\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiClearHasMsg.php:39
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiClearHasMsg
API module that clears the hasmsg flag for current user.
Definition: ApiClearHasMsg.php:28
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
ApiClearHasMsg\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiClearHasMsg.php:35
ApiClearHasMsg\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiClearHasMsg.php:43
ApiClearHasMsg\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiClearHasMsg.php:50
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521