ApiQueryDeletedrevs Class Reference

Query module to enumerate all deleted revisions. More...

Inheritance diagram for ApiQueryDeletedrevs:

Collaboration diagram for ApiQueryDeletedrevs:

List of all members.

Public Member Functions
	__construct ($query, $moduleName)
	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.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	getVersion ()
	Returns a string that identifies the version of the extending class.

---

Detailed Description

Query module to enumerate all deleted revisions.

Definition at line 32 of file ApiQueryDeletedrevs.php.

---

Constructor & Destructor Documentation

ApiQueryDeletedrevs::__construct	(	$	query,
		$	moduleName
	)

Definition at line 34 of file ApiQueryDeletedrevs.php.

---

Member Function Documentation

ApiQueryDeletedrevs::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 38 of file ApiQueryDeletedrevs.php.

References $count, $dir, $lb, $limit, $res, $result, $title, $user, ApiQueryBase\$where, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), Linker\formatComment(), ApiQueryBase\getDB(), ApiBase\getMain(), ApiBase\getModuleName(), ApiQueryBase\getPageSet(), ContextSource\getRequest(), ApiBase\getResult(), Revision\getRevisionText(), ContextSource\getUser(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\LIMIT_SML1, ApiBase\LIMIT_SML2, Title\makeTitle(), ApiQueryBase\select(), ApiResult\setContent(), ApiQueryBase\setContinueEnumParameter(), ApiQueryBase\titleToKey(), ApiBase\validateLimit(), wfBaseConvert(), and wfTimestamp().

Here is the call graph for this function:

ApiQueryDeletedrevs::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 283 of file ApiQueryDeletedrevs.php.

References ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

ApiQueryDeletedrevs::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 371 of file ApiQueryDeletedrevs.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryDeletedrevs::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 399 of file ApiQueryDeletedrevs.php.

ApiQueryDeletedrevs::getHelpUrls

(

)

Returns:

false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 412 of file ApiQueryDeletedrevs.php.

ApiQueryDeletedrevs::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 340 of file ApiQueryDeletedrevs.php.

References ApiQueryBase\getDirectionDescription(), and ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryDeletedrevs::getPossibleErrors

(

)

Returns:

array

Reimplemented from ApiQueryBase.

Definition at line 384 of file ApiQueryDeletedrevs.php.

ApiQueryDeletedrevs::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 416 of file ApiQueryDeletedrevs.php.

---

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

• includes/api/ApiQueryDeletedrevs.php