MediaWiki master
ApiQueryDisabled.php
Go to the documentation of this file.
1<?php
9namespace MediaWiki\Api;
10
22
23 public function execute() {
24 $this->addWarning( [ 'apierror-moduledisabled', $this->getModuleName() ] );
25 }
26
28 public function getSummaryMessage() {
29 return 'apihelp-query+disabled-summary';
30 }
31
33 public function getExtendedDescription() {
34 return [ [
35 'apihelp-query+disabled-extended-description',
36 'api-help-no-extended-description',
37 ] ];
38 }
39}
40
42class_alias( ApiQueryDisabled::class, 'ApiQueryDisabled' );
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:543
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1429
This is a base class for all Query modules.
API module that does nothing.
getExtendedDescription()
Return the extended help text message.This is additional text to display at the top of the help secti...
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getSummaryMessage()
Return the summary message.This is a one-line description of the module, suitable for display in a li...