MediaWiki  1.34.0
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 }
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:640
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
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
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:520