ApiQueryRecentChanges Class Reference
[API]

A query action to enumerate the recent changes that were done to the wiki. More...

Inherits ApiQueryBase.

List of all members.

Public Member Functions

 __construct ($query, $moduleName)
 execute ()
 Generates and outputs the result of this query based upon the provided parameters.
 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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Static Public Member Functions

static getPatrolToken ($pageid, $title, $rc)

Protected Member Functions

 getTokenFunctions ()
 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 extractRowInfo ($row)
 Extracts from a single sql row the data needed to describe one recent change.
 parseRCType ($type)

Private Attributes

 $fld_comment = false
 $fld_user = false
 $fld_flags = false
 $fld_timestamp = false
 $fld_title = false
 $fld_ids = false
 $fld_sizes = false


Detailed Description

A query action to enumerate the recent changes that were done to the wiki.

Various filters are supported.

Definition at line 37 of file ApiQueryRecentChanges.php.


Constructor & Destructor Documentation

ApiQueryRecentChanges::__construct ( query,
moduleName 
)

Definition at line 39 of file ApiQueryRecentChanges.php.


Member Function Documentation

ApiQueryRecentChanges::execute (  ) 

ApiQueryRecentChanges::extractRowInfo ( row  )  [private]

Extracts from a single sql row the data needed to describe one recent change.

Parameters:
$row The row from which to extract the data.
Returns:
An array mapping strings (descriptors) to their respective string values.
Access:
private

Definition at line 234 of file ApiQueryRecentChanges.php.

References $row, $t, $title, $type, ApiQueryLogEvents::addLogParams(), ApiQueryBase::addTitleInfo(), ApiBase::getResult(), getTokenFunctions(), Title::makeTitle(), RecentChange::newFromRow(), ApiBase::setWarning(), and wfTimestamp().

Referenced by execute().

ApiQueryRecentChanges::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

Reimplemented from ApiBase.

Definition at line 356 of file ApiQueryRecentChanges.php.

References getTokenFunctions(), 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.

ApiQueryRecentChanges::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 445 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 449 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::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

Reimplemented from ApiBase.

Definition at line 428 of file ApiQueryRecentChanges.php.

static ApiQueryRecentChanges::getPatrolToken ( pageid,
title,
rc 
) [static]

Definition at line 67 of file ApiQueryRecentChanges.php.

References $wgUser.

ApiQueryRecentChanges::getTokenFunctions (  )  [protected]

Definition at line 47 of file ApiQueryRecentChanges.php.

References ApiBase::getMain(), and wfRunHooks().

Referenced by extractRowInfo(), and getAllowedParams().

ApiQueryRecentChanges::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 455 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::parseRCType ( type  )  [private]

Definition at line 339 of file ApiQueryRecentChanges.php.

References $t, and $type.

Referenced by execute().


Member Data Documentation

ApiQueryRecentChanges::$fld_comment = false [private]

Definition at line 43 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_flags = false [private]

Definition at line 43 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_ids = false [private]

Definition at line 44 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_sizes = false [private]

Definition at line 45 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_timestamp = false [private]

Definition at line 44 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_title = false [private]

Definition at line 44 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_user = false [private]

Definition at line 43 of file ApiQueryRecentChanges.php.


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

Generated on Sat Sep 5 02:08:32 2009 for MediaWiki by  doxygen 1.5.9