ApiComparePages Class Reference

Inheritance diagram for ApiComparePages:

Collaboration diagram for ApiComparePages:

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.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Member Functions
	revisionOrTitle ($revision, $titleText)

---

Detailed Description

Definition at line 26 of file ApiComparePages.php.

---

Constructor & Destructor Documentation

ApiComparePages::__construct	(	$	main,
		$	action
	)

Definition at line 28 of file ApiComparePages.php.

---

Member Function Documentation

ApiComparePages::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 32 of file ApiComparePages.php.

References ApiBase\dieUsage(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getModuleName(), ApiBase\getResult(), revisionOrTitle(), and ApiResult\setContent().

Here is the call graph for this function:

ApiComparePages::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 85 of file ApiComparePages.php.

References ApiBase\PARAM_TYPE.

ApiComparePages::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 106 of file ApiComparePages.php.

ApiComparePages::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 121 of file ApiComparePages.php.

ApiComparePages::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 98 of file ApiComparePages.php.

ApiComparePages::getPossibleErrors

(

)

Returns a list of all possible errors returned by the module.

Returns:

array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 113 of file ApiComparePages.php.

ApiComparePages::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 127 of file ApiComparePages.php.

ApiComparePages::revisionOrTitle	(	$	revision,
		$	titleText
	)		[private]

Parameters:

$revision	int
$titleText	string

Returns:

int

Definition at line 72 of file ApiComparePages.php.

References $title, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), and Title\newFromText().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• includes/api/ApiComparePages.php