ApiComparePages Class Reference

Inheritance diagram for ApiComparePages:

Collaboration diagram for ApiComparePages:

List of all members.

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.
Private Member Functions
	revisionOrTitleOrId ($revision, $titleText, $titleId)

---

Detailed Description

Definition at line 26 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 28 of file ApiComparePages.php.

References $params, array(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getModuleName(), ApiBase\getResult(), Revision\newFromId(), revisionOrTitleOrId(), and ApiResult\setContent().

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.

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

References array(), and ApiBase\PARAM_TYPE.

ApiComparePages::getDescription

(

)

Returns the description string for this module.

Returns:

string|array

Reimplemented from ApiBase.

Definition at line 140 of file ApiComparePages.php.

References array().

ApiComparePages::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 147 of file ApiComparePages.php.

References array().

ApiComparePages::getParamDescription

(

)

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

References array().

ApiComparePages::revisionOrTitleOrId	(	$	revision,
		$	titleText,
		$	titleId
	)		[private]

Parameters:

int	$revision
string	$titleText
int	$titleId

Returns:

int

Definition at line 86 of file ApiComparePages.php.

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

Referenced by execute().

---

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

• includes/api/ApiComparePages.php