MediaWiki  REL1_19
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
ApiQueryWatchlist Class Reference
API

This query action allows clients to retrieve a list of recently modified pages that are part of the logged-in user's watchlist. More...

Inheritance diagram for ApiQueryWatchlist:
Inheritance graph
[legend]
Collaboration diagram for ApiQueryWatchlist:
Collaboration graph
[legend]

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.
 getHelpUrls ()
 getParamDescription ()
 Returns an array of parameter descriptions.
 getPossibleErrors ()
 getVersion ()
 Returns a string that identifies the version of the extending class.

Public Attributes

 $fld_comment = false
 $fld_flags = false
 $fld_loginfo = false
 $fld_notificationtimestamp = false
 $fld_parsedcomment = false
 $fld_patrol = false
 $fld_sizes = false
 $fld_timestamp = false
 $fld_title = false
 $fld_user = false
 $fld_userid = false

Private Member Functions

 extractRowInfo ($row)
 run ($resultPageSet=null)

Private Attributes

 $fld_ids = false

Detailed Description

This query action allows clients to retrieve a list of recently modified pages that are part of the logged-in user's watchlist.

Definition at line 33 of file ApiQueryWatchlist.php.

Constructor & Destructor Documentation

ApiQueryWatchlist::__construct ( $  query,
$  moduleName 
)

Definition at line 35 of file ApiQueryWatchlist.php.

Member Function Documentation

ApiQueryWatchlist::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 ApiQueryWatchlist.php.

References run().

Here is the call graph for this function:

ApiQueryWatchlist::executeGenerator ( $  resultPageSet)

Execute this module as a generator.

Parameters:
$resultPageSetApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 43 of file ApiQueryWatchlist.php.

References run().

Here is the call graph for this function:

ApiQueryWatchlist::extractRowInfo ( $  row) [private]

Definition at line 226 of file ApiQueryWatchlist.php.

References $title, ApiQueryLogEvents\addLogParams(), ApiQueryBase\addTitleInfo(), Linker\formatComment(), ApiBase\getResult(), Title\makeTitle(), and wfTimestamp().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryWatchlist::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 312 of file ApiQueryWatchlist.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.

ApiQueryWatchlist::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 420 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 436 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::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 447 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::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 385 of file ApiQueryWatchlist.php.

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

Here is the call graph for this function:

ApiQueryWatchlist::getPossibleErrors ( )
Returns:
array

Reimplemented from ApiQueryBase.

Definition at line 424 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::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 451 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::run ( $  resultPageSet = null) [private]
Parameters:
$resultPageSetApiPageSet
Returns:
void

Definition at line 55 of file ApiQueryWatchlist.php.

References $count, $res, $user, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereIf(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), extractRowInfo(), ApiQueryBase\getDB(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\getWatchlistUser(), ApiQueryBase\select(), ApiQueryBase\selectNamedDB(), ApiQueryBase\setContinueEnumParameter(), and wfTimestamp().

Referenced by execute(), and executeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiQueryWatchlist::$fld_comment = false

Definition at line 48 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_flags = false

Definition at line 47 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_ids = false [private]

Definition at line 47 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_loginfo = false

Definition at line 49 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_notificationtimestamp = false

Definition at line 49 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_parsedcomment = false

Definition at line 48 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_patrol = false

Definition at line 47 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_sizes = false

Definition at line 48 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_timestamp = false

Definition at line 48 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_title = false

Definition at line 47 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_user = false

Definition at line 48 of file ApiQueryWatchlist.php.

ApiQueryWatchlist::$fld_userid = false

Definition at line 49 of file ApiQueryWatchlist.php.

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