API module that dies with an error immediately. More...
Public Member Functions | |
| execute () | |
| Evaluates the parameters, performs the requested query, and sets up the result. | |
| getAllowedParams () | |
| Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. | |
| getDescription () | |
| Returns the description string for this module. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
| isReadMode () | |
| Indicates whether this module requires read rights. | |
Detailed Description
API module that dies with an error immediately.
Use this to disable core modules with $wgAPIModules['modulename'] = 'ApiDisabled';
To disable submodules of action=query, use ApiQueryDisabled instead
Definition at line 37 of file ApiDisabled.php.
Member Function Documentation
Evaluates the parameters, performs the requested query, and sets up the result.
Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.
The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.
The result data should be stored in the ApiResult object available through getResult().
Reimplemented from ApiBase.
Definition at line 39 of file ApiDisabled.php.
References ApiBase\dieUsage().
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 47 of file ApiDisabled.php.
References array().
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 55 of file ApiDisabled.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 59 of file ApiDisabled.php.
References array().
Returns an array of parameter descriptions.
Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no parameter descriptions
Reimplemented from ApiBase.
Definition at line 51 of file ApiDisabled.php.
References array().
Indicates whether this module requires read rights.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 43 of file ApiDisabled.php.
The documentation for this class was generated from the following file:
- includes/api/ApiDisabled.php
