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

Inheritance diagram for ApiQueryRecentChanges:

Collaboration diagram for ApiQueryRecentChanges:

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.
	extractRowInfo ($row)
	Extracts from a single sql row the data needed to describe one recent change.
	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.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	initProperties ($prop)
	Sets internal state to include the desired properties in the output.
	run ($resultPageSet=null)
	Generates and outputs the result of this query based upon the provided parameters.
Static Public Member Functions
static	getPatrolToken ($pageid, $title, $rc=null)
Public Attributes
	$fld_flags = false
	$fld_ids = false
	$fld_loginfo = false
	$fld_parsedcomment = false
	$fld_patrolled = false
	$fld_redirect = false
	$fld_sha1 = false
	$fld_sizes = false
	$fld_tags = false
	$fld_timestamp = false
	$fld_title = false
	$fld_user = false
	$fld_userid = false
	$token = array()
Protected Member Functions
	getTokenFunctions ()
	Get an array mapping token names to their handler functions.
Private Member Functions
	parseRCType ($type)
Private Attributes
	$fld_comment = false
	$tokenFunctions

Detailed Description

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

Various filters are supported.

Definition at line 33 of file ApiQueryRecentChanges.php.

Constructor & Destructor Documentation

ApiQueryRecentChanges::__construct	(	$	query,
		$	moduleName
	)

Definition at line 35 of file ApiQueryRecentChanges.php.

References $query.

Member Function Documentation

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

References run().

ApiQueryRecentChanges::executeGenerator ( $ resultPageSet )

Execute this module as a generator.

Parameters:

$resultPageSet ApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 131 of file ApiQueryRecentChanges.php.

References run().

ApiQueryRecentChanges::extractRowInfo ( $ row )

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

Parameters:

mixed $row The row from which to extract the data.

Returns:: array An array mapping strings (descriptors) to their respective string values.

Access:: public

Definition at line 353 of file ApiQueryRecentChanges.php.

References $t, $title, $tokenFunctions, ApiQueryLogEvents\addLogParams(), ApiQueryBase\addTitleInfo(), array(), as, Revision\DELETED_TEXT, Linker\formatComment(), ApiBase\getResult(), getTokenFunctions(), Title\makeTitle(), RecentChange\newFromRow(), DatabaseLogEntry\newFromRow(), ApiBase\setWarning(), token, wfBaseConvert(), and wfTimestamp().

Referenced by run().

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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 551 of file ApiQueryRecentChanges.php.

References array(), 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. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 533 of file ApiQueryRecentChanges.php.

References $params, and as.

ApiQueryRecentChanges::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 777 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 789 of file ApiQueryRecentChanges.php.

References array().

ApiQueryRecentChanges::getHelpUrls ( )

Returns:: bool|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 795 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 637 of file ApiQueryRecentChanges.php.

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

static ApiQueryRecentChanges::getPatrolToken	(	$	pageid,
		$	title,
		$	rc = `null`
	)		`[static]`

Parameters:

$pageid
$title
$rc	RecentChange (optional)

Returns:: bool|String

Definition at line 76 of file ApiQueryRecentChanges.php.

References $wgUser, and global.

Referenced by ResourceLoaderUserTokensModule\contextUserTokens().

ApiQueryRecentChanges::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 781 of file ApiQueryRecentChanges.php.

References array().

ApiQueryRecentChanges::getResultProperties ( )

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

Don't call this function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 676 of file ApiQueryRecentChanges.php.

References ApiBase\addTokenProperties(), array(), getTokenFunctions(), global, ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.

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)

Returns:: array array(tokenname => function)

Definition at line 52 of file ApiQueryRecentChanges.php.

References array(), ApiBase\getMain(), ContextSource\getRequest(), and wfRunHooks().

Referenced by extractRowInfo(), getAllowedParams(), and getResultProperties().

ApiQueryRecentChanges::initProperties ( $ prop )

Sets internal state to include the desired properties in the output.

Parameters:

array $prop associative array of properties, only keys are used here

Definition at line 110 of file ApiQueryRecentChanges.php.

Referenced by run().

ApiQueryRecentChanges::parseRCType ( $ type ) [private]

Definition at line 513 of file ApiQueryRecentChanges.php.

References $retval, $t, array(), and as.

Referenced by run().

ApiQueryRecentChanges::run ( $ resultPageSet = null )

Generates and outputs the result of this query based upon the provided parameters.

Parameters:

$resultPageSet ApiPageSet

Definition at line 140 of file ApiQueryRecentChanges.php.

References $count, $params, $res, $result, $timestamp, $titles, $user, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereIf(), array(), as, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), extractRowInfo(), ApiQueryBase\getDB(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), initProperties(), Title\makeTitle(), parseRCType(), ApiQueryBase\select(), ApiQueryGeneratorBase\setContinueEnumParameter(), token, and wfTimestamp().

Referenced by execute(), and executeGenerator().

Member Data Documentation

ApiQueryRecentChanges::$fld_comment = false [private]

Definition at line 39 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_flags = false

Definition at line 40 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_ids = false

Definition at line 40 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_loginfo = false

Definition at line 41 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_parsedcomment = false

Definition at line 39 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_patrolled = false

Definition at line 41 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_redirect = false

Definition at line 41 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_sha1 = false

Definition at line 42 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_sizes = false

Definition at line 41 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_tags = false

Definition at line 42 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_timestamp = false

Definition at line 40 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_title = false

Definition at line 40 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_user = false

Definition at line 39 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$fld_userid = false

Definition at line 39 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$token = array()

Definition at line 42 of file ApiQueryRecentChanges.php.

ApiQueryRecentChanges::$tokenFunctions [private]

Definition at line 44 of file ApiQueryRecentChanges.php.

Referenced by extractRowInfo().

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

includes/api/ApiQueryRecentChanges.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation