ApiQueryWatchlistRaw Class Reference

This query action allows clients to retrieve a list of pages on the logged-in user's watchlist. More...

Inheritance diagram for ApiQueryWatchlistRaw:

Collaboration diagram for ApiQueryWatchlistRaw:

List of all members.

Public Member Functions
	__construct ($query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	executeGenerator ($resultPageSet)
	Execute this module as a generator.
	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 ()
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Member Functions
	run ($resultPageSet=null)

---

Detailed Description

This query action allows clients to retrieve a list of pages on the logged-in user's watchlist.

Definition at line 33 of file ApiQueryWatchlistRaw.php.

---

Constructor & Destructor Documentation

ApiQueryWatchlistRaw::__construct	(	$	query,
		$	moduleName
	)

Definition at line 35 of file ApiQueryWatchlistRaw.php.

---

Member Function Documentation

ApiQueryWatchlistRaw::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 39 of file ApiQueryWatchlistRaw.php.

References run().

Here is the call graph for this function:

ApiQueryWatchlistRaw::executeGenerator

(

$

resultPageSet

)

Execute this module as a generator.

Parameters:

$resultPageSet

ApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 43 of file ApiQueryWatchlistRaw.php.

References run().

Here is the call graph for this function:

ApiQueryWatchlistRaw::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 131 of file ApiQueryWatchlistRaw.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.

ApiQueryWatchlistRaw::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 182 of file ApiQueryWatchlistRaw.php.

ApiQueryWatchlistRaw::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 195 of file ApiQueryWatchlistRaw.php.

ApiQueryWatchlistRaw::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 167 of file ApiQueryWatchlistRaw.php.

ApiQueryWatchlistRaw::getPossibleErrors

(

)

Returns:

array

Reimplemented from ApiQueryBase.

Definition at line 186 of file ApiQueryWatchlistRaw.php.

ApiQueryWatchlistRaw::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 202 of file ApiQueryWatchlistRaw.php.

ApiQueryWatchlistRaw::run

(

$

resultPageSet = null

)

[private]

Parameters:

$resultPageSet

ApiPageSet

Returns:

void

Definition at line 51 of file ApiQueryWatchlistRaw.php.

References $count, $res, $t, $title, $user, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereIf(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\getWatchlistUser(), Title\makeTitle(), ApiQueryBase\select(), ApiQueryBase\selectNamedDB(), ApiQueryBase\setContinueEnumParameter(), ApiQueryBase\titleToKey(), and wfTimestamp().

Referenced by execute(), and executeGenerator().

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/ApiQueryWatchlistRaw.php