MediaWiki
master
ApiDisabled.php
Go to the documentation of this file.
1
<?php
23
namespace
MediaWiki\Api
;
24
35
class
ApiDisabled
extends
ApiBase
{
36
37
public
function
execute
() {
38
$this->
dieWithError
( [
'apierror-moduledisabled'
, $this->
getModuleName
() ] );
39
}
40
41
public
function
isReadMode
() {
42
return
false
;
43
}
44
45
protected
function
getSummaryMessage
() {
46
return
'apihelp-disabled-summary'
;
47
}
48
49
protected
function
getExtendedDescription
() {
50
return
[ [
51
'apihelp-disabled-extended-description'
,
52
'api-help-no-extended-description'
,
53
] ];
54
}
55
}
56
58
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:76
MediaWiki\Api\ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition
ApiBase.php:1577
MediaWiki\Api\ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition
ApiBase.php:571
MediaWiki\Api\ApiDisabled
API module that dies with an error immediately.
Definition
ApiDisabled.php:35
MediaWiki\Api\ApiDisabled\getSummaryMessage
getSummaryMessage()
Return the summary message.
Definition
ApiDisabled.php:45
MediaWiki\Api\ApiDisabled\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition
ApiDisabled.php:41
MediaWiki\Api\ApiDisabled\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition
ApiDisabled.php:37
MediaWiki\Api\ApiDisabled\getExtendedDescription
getExtendedDescription()
Return the extended help text message.
Definition
ApiDisabled.php:49
MediaWiki\Api
Definition
ApiAcquireTempUserName.php:22
includes
api
ApiDisabled.php
Generated on Thu Nov 14 2024 01:22:41 for MediaWiki by
1.10.0