MediaWiki  1.33.0
ApiDisabled.php
Go to the documentation of this file.
1 <?php
33 class ApiDisabled extends ApiBase {
34 
35  public function execute() {
36  $this->dieWithError( [ 'apierror-moduledisabled', $this->getModuleName() ] );
37  }
38 
39  public function isReadMode() {
40  return false;
41  }
42 
43  protected function getSummaryMessage() {
44  return 'apihelp-disabled-summary';
45  }
46 
47  protected function getExtendedDescription() {
48  return 'apihelp-disabled-extended-description';
49  }
50 }
ApiDisabled\getExtendedDescription
getExtendedDescription()
Return the extended help text message.
Definition: ApiDisabled.php:47
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1990
ApiDisabled\getSummaryMessage
getSummaryMessage()
Return the summary message.
Definition: ApiDisabled.php:43
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:35
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiDisabled\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiDisabled.php:35
ApiDisabled\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiDisabled.php:39
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
ApiDisabled
API module that dies with an error immediately.
Definition: ApiDisabled.php:33