MediaWiki  REL1_22
MockApi Class Reference
Inheritance diagram for MockApi:
Collaboration diagram for MockApi:

List of all members.

Public Member Functions

 __construct ()
 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.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Detailed Description

Definition at line 215 of file ApiTestCase.php.


Constructor & Destructor Documentation

Definition at line 222 of file ApiTestCase.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 216 of file ApiTestCase.php.

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 225 of file ApiTestCase.php.

References array().

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
Deprecated:
since 1.21, version string is no longer supported

Reimplemented from ApiBase.

Definition at line 219 of file ApiTestCase.php.


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