Inherits ApiQueryBase.
Public Member Functions | |
__construct ($query, $moduleName) | |
initProperties ($prop) | |
Sets internal state to include the desired properties in the output. | |
execute () | |
Generates and outputs the result of this query based upon the provided parameters. | |
extractRowInfo ($row) | |
Extracts from a single sql row the data needed to describe one recent change. | |
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 | getPatrolToken ($pageid, $title, $rc) |
Protected Member Functions | |
getTokenFunctions () | |
Get an array mapping token names to their handler functions. | |
getExamples () | |
Returns usage examples for this module. | |
Private Member Functions | |
parseRCType ($type) | |
Private Attributes | |
$fld_comment = false | |
$fld_parsedcomment = false | |
$fld_user = false | |
$fld_flags = false | |
$fld_timestamp = false | |
$fld_title = false | |
$fld_ids = false | |
$fld_sizes = false |
Various filters are supported.
Definition at line 37 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 39 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::execute | ( | ) |
Generates and outputs the result of this query based upon the provided parameters.
Reimplemented from ApiBase.
Definition at line 106 of file ApiQueryRecentChanges.php.
References $res, $wgOldChangeTagsIndex, $wgUser, ApiQueryBase::addFields(), ApiQueryBase::addFieldsIf(), ApiQueryBase::addJoinConds(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), ApiQueryBase::addWhereIf(), ApiQueryBase::addWhereRange(), ApiBase::dieUsage(), ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), extractRowInfo(), ApiQueryBase::getDB(), ApiBase::getModuleName(), ApiBase::getResult(), initProperties(), parseRCType(), ApiQueryBase::select(), ApiQueryBase::setContinueEnumParameter(), and wfTimestamp().
ApiQueryRecentChanges::extractRowInfo | ( | $ | row | ) |
Extracts from a single sql row the data needed to describe one recent change.
$row | The row from which to extract the data. |
Definition at line 278 of file ApiQueryRecentChanges.php.
References $t, $title, $wgUser, 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.
Reimplemented from ApiBase.
Definition at line 443 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::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 425 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 544 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 556 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.
Reimplemented from ApiBase.
Definition at line 524 of file ApiQueryRecentChanges.php.
static ApiQueryRecentChanges::getPatrolToken | ( | $ | pageid, | |
$ | title, | |||
$ | rc | |||
) | [static] |
ApiQueryRecentChanges::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiQueryBase.
Definition at line 548 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::getTokenFunctions | ( | ) | [protected] |
Get an array mapping token names to their handler functions.
The prototype for a token function is func($pageid, $title, $rc) it should return a token or false (permission denied)
Definition at line 52 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
Reimplemented from ApiBase.
Definition at line 562 of file ApiQueryRecentChanges.php.
ApiQueryRecentChanges::initProperties | ( | $ | prop | ) |
Sets internal state to include the desired properties in the output.
$prop | associative array of properties, only keys are used here |
Definition at line 88 of file ApiQueryRecentChanges.php.
Referenced by execute().
ApiQueryRecentChanges::parseRCType | ( | $ | type | ) | [private] |
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_parsedcomment = false [private] |
Definition at line 43 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.