ApiQueryRevisions Class Reference
[API]

A query action to enumerate revisions of a given page, or show top revisions of multiple pages. More...

Inherits ApiQueryBase.

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.
 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 getRollbackToken ($pageid, $title, $rev)

Protected Member Functions

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

Private Member Functions

 extractRowInfo ($revision)

Private Attributes

 $fld_ids = false
 $fld_flags = false
 $fld_timestamp = false
 $fld_size = false
 $fld_comment = false
 $fld_user = false
 $fld_content = false


Detailed Description

A query action to enumerate revisions of a given page, or show top revisions of multiple pages.

Various pieces of information may be shown - flags, comments, and the actual wiki markup of the rev. In the enumeration mode, ranges of revisions may be requested and filtered.

Definition at line 38 of file ApiQueryRevisions.php.


Constructor & Destructor Documentation

ApiQueryRevisions::__construct ( query,
moduleName 
)

Definition at line 40 of file ApiQueryRevisions.php.


Member Function Documentation

ApiQueryRevisions::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 76 of file ApiQueryRevisions.php.

References $count, $db, $res, $revision, $row, $title, ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addPageSubItem(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), ApiQueryBase::addWhereRange(), Revision::DELETED_TEXT, Revision::DELETED_USER, ApiBase::dieDebug(), ApiBase::dieUsage(), ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), extractRowInfo(), ApiQueryBase::getDB(), ApiBase::getMain(), ApiBase::getModuleName(), ApiQueryBase::getPageSet(), ApiBase::getResult(), ApiBase::LIMIT_BIG1, ApiBase::LIMIT_BIG2, ApiBase::LIMIT_SML1, ApiBase::LIMIT_SML2, ApiQueryBase::select(), Revision::selectFields(), Revision::selectPageFields(), Revision::selectTextFields(), ApiQueryBase::setContinueEnumParameter(), ApiBase::setWarning(), and ApiBase::validateLimit().

ApiQueryRevisions::extractRowInfo ( revision  )  [private]

ApiQueryRevisions::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 414 of file ApiQueryRevisions.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.

ApiQueryRevisions::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 493 of file ApiQueryRevisions.php.

ApiQueryRevisions::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 504 of file ApiQueryRevisions.php.

ApiQueryRevisions::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 472 of file ApiQueryRevisions.php.

static ApiQueryRevisions::getRollbackToken ( pageid,
title,
rev 
) [static]

Definition at line 67 of file ApiQueryRevisions.php.

References $title, and $wgUser.

ApiQueryRevisions::getTokenFunctions (  )  [protected]

Definition at line 47 of file ApiQueryRevisions.php.

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

Referenced by extractRowInfo(), and getAllowedParams().

ApiQueryRevisions::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 521 of file ApiQueryRevisions.php.


Member Data Documentation

ApiQueryRevisions::$fld_comment = false [private]

Definition at line 45 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_content = false [private]

Definition at line 45 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_flags = false [private]

Definition at line 44 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_ids = false [private]

Definition at line 44 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_size = false [private]

Definition at line 44 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_timestamp = false [private]

Definition at line 44 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_user = false [private]

Definition at line 45 of file ApiQueryRevisions.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