MediaWiki
master
ApiDisabled.php
Go to the documentation of this file.
1
<?php
9
namespace
MediaWiki\Api
;
10
21
class
ApiDisabled
extends
ApiBase
{
22
23
public
function
execute
(): never {
24
$this->
dieWithError
( [
'apierror-moduledisabled'
, $this->
getModuleName
() ] );
25
}
26
28
public
function
isReadMode
() {
29
return
false
;
30
}
31
33
protected
function
getSummaryMessage
() {
34
return
'apihelp-disabled-summary'
;
35
}
36
38
protected
function
getExtendedDescription
() {
39
return
[ [
40
'apihelp-disabled-extended-description'
,
41
'api-help-no-extended-description'
,
42
] ];
43
}
44
}
45
47
class_alias( ApiDisabled::class,
'ApiDisabled'
);
MediaWiki\Api\ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition
ApiBase.php:61
MediaWiki\Api\ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition
ApiBase.php:1511
MediaWiki\Api\ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition
ApiBase.php:543
MediaWiki\Api\ApiDisabled
API module that dies with an error immediately.
Definition
ApiDisabled.php:21
MediaWiki\Api\ApiDisabled\getSummaryMessage
getSummaryMessage()
Return the summary message.This is a one-line description of the module, suitable for display in a li...
Definition
ApiDisabled.php:33
MediaWiki\Api\ApiDisabled\isReadMode
isReadMode()
Indicates whether this module requires read rights.to override bool
Definition
ApiDisabled.php:28
MediaWiki\Api\ApiDisabled\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition
ApiDisabled.php:23
MediaWiki\Api\ApiDisabled\getExtendedDescription
getExtendedDescription()
Return the extended help text message.This is additional text to display at the top of the help secti...
Definition
ApiDisabled.php:38
MediaWiki\Api
Language name search API.
Definition
ApiAcquireTempUserName.php:8
includes
Api
ApiDisabled.php
Generated on Fri Dec 12 2025 22:23:27 for MediaWiki by
1.10.0