ApiQueryDisabled Class Reference

API module that does nothing. More...

Inheritance diagram for ApiQueryDisabled:

Collaboration diagram for ApiQueryDisabled:

List of all members.

Public Member Functions
	__construct ($main, $action)
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.

---

Detailed Description

API module that does nothing.

Use this to disable core modules with e.g. $wgAPIPropModules['modulename'] = 'ApiQueryDisabled';

To disable top-level modules, use ApiDisabled instead

Definition at line 37 of file ApiQueryDisabled.php.

---

Constructor & Destructor Documentation

ApiQueryDisabled::__construct	(	$	main,
		$	action
	)

Definition at line 39 of file ApiQueryDisabled.php.

---

Member Function Documentation

ApiQueryDisabled::execute

(

)

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 43 of file ApiQueryDisabled.php.

References ApiBase\setWarning().

Here is the call graph for this function:

ApiQueryDisabled::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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 47 of file ApiQueryDisabled.php.

ApiQueryDisabled::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 55 of file ApiQueryDisabled.php.

ApiQueryDisabled::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 61 of file ApiQueryDisabled.php.

ApiQueryDisabled::getParamDescription

(

)

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 51 of file ApiQueryDisabled.php.

ApiQueryDisabled::getVersion

(

)

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:

string

Reimplemented from ApiBase.

Definition at line 65 of file ApiQueryDisabled.php.

---

The documentation for this class was generated from the following file:

• includes/api/ApiQueryDisabled.php