Inherits ApiQueryBase.
Public Member Functions | |
__construct ($query, $moduleName) | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getCacheMode ($params) | |
Get the cache mode for the data generated by this module. | |
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. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the 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 ($row) | |
Private Attributes | |
$fld_ids = false | |
$fld_flags = false | |
$fld_timestamp = false | |
$fld_size = false | |
$fld_comment = false | |
$fld_parsedcomment = false | |
$fld_user = false | |
$fld_content = false | |
$fld_tags = false |
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.
ApiQueryRevisions::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 40 of file ApiQueryRevisions.php.
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 $res, $title, $wgOldChangeTagsIndex, ApiQueryBase::addFields(), ApiQueryBase::addJoinConds(), 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(), 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 | ( | $ | row | ) | [private] |
Definition at line 339 of file ApiQueryRevisions.php.
References $n, $t, $title, $wgAPIMaxUncachedDiffs, $wgParser, $wgUser, Revision::DELETED_COMMENT, Revision::DELETED_TEXT, Revision::DELETED_USER, ApiBase::dieUsage(), DifferenceEngine::getNewid(), ApiBase::getResult(), getTokenFunctions(), ApiResult::setContent(), ApiBase::setWarning(), and wfTimestamp().
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.
Reimplemented from ApiBase.
Definition at line 481 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::getCacheMode | ( | $ | params | ) |
Get the cache mode for the data generated by this module.
Override this in the module subclass.
Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.
Reimplemented from ApiQueryBase.
Definition at line 470 of file ApiQueryRevisions.php.
ApiQueryRevisions::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 567 of file ApiQueryRevisions.php.
ApiQueryRevisions::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 591 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.
Reimplemented from ApiBase.
Definition at line 543 of file ApiQueryRevisions.php.
ApiQueryRevisions::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiQueryBase.
Definition at line 578 of file ApiQueryRevisions.php.
static ApiQueryRevisions::getRollbackToken | ( | $ | pageid, | |
$ | title, | |||
$ | rev | |||
) | [static] |
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
Reimplemented from ApiBase.
Definition at line 608 of file ApiQueryRevisions.php.
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_parsedcomment = false [private] |
Definition at line 45 of file ApiQueryRevisions.php.
ApiQueryRevisions::$fld_size = false [private] |
Definition at line 44 of file ApiQueryRevisions.php.
ApiQueryRevisions::$fld_tags = false [private] |
Definition at line 45 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.