MockApi Class Reference

Inherits ApiBase.

List of all members.

Public Member Functions

 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 getVersion ()
 Returns a string that identifies the version of the extending class.
 __construct ()
 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.


Detailed Description

Definition at line 5 of file ApiTest.php.


Constructor & Destructor Documentation

MockApi::__construct (  ) 

Definition at line 9 of file ApiTest.php.


Member Function Documentation

MockApi::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 6 of file ApiTest.php.

MockApi::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

Reimplemented from ApiBase.

Definition at line 11 of file ApiTest.php.

MockApi::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 7 of file ApiTest.php.


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

Generated on Sat Apr 30 22:57:43 2011 for MediaWiki by  doxygen 1.5.9