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

Inheritance diagram for ApiQueryRevisions:

Collaboration diagram for ApiQueryRevisions:

Public Member Functions
	__construct (ApiQuery $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.
	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.
Static Public Member Functions
static	getRollbackToken ($pageid, $title, $rev)
Public Attributes
	$contentFormat
	$difftotext
	$expandTemplates
	$fld_comment = false
	$fld_content = false
	$fld_contentmodel = false
	$fld_flags = false
	$fld_parsedcomment = false
	$fld_sha1 = false
	$fld_size = false
	$fld_tags = false
	$fld_timestamp = false
	$fld_user = false
	$fld_userid = false
	$generateXML
	$parseContent
	$section
	$token
Protected Member Functions
	getTokenFunctions ()
Private Member Functions
	extractRowInfo ($row)
Private Attributes
	$diffto
	$fld_ids = false
	$tokenFunctions

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

Constructor & Destructor Documentation

ApiQueryRevisions::__construct	(	ApiQuery $	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 92 of file ApiQueryRevisions.php.

References $count, $limit, $params, $res, $title, $titles, $user, ApiQueryBase\addFields(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addPageSubItem(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), array(), as, Revision\DELETED_RESTRICTED, Revision\DELETED_TEXT, Revision\DELETED_USER, ApiBase\dieContinueUsageIf(), ApiBase\dieDebug(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), empty, ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiBase\getMain(), ApiBase\getModuleName(), ApiQueryBase\getPageSet(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\LIMIT_SML1, ApiBase\LIMIT_SML2, section, ApiQueryBase\select(), Revision\selectFields(), Revision\selectPageFields(), Revision\selectTextFields(), Revision\selectUserFields(), ApiQueryBase\setContinueEnumParameter(), ApiBase\setWarning(), Revision\userJoinCond(), and ApiBase\validateLimit().

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.

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

References array(), ContentHandler\getAllContentFormats(), getTokenFunctions(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DEPRECATED, 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. 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:

array $params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 681 of file ApiQueryRevisions.php.

References $params, and ApiQueryBase\userCanSeeRevDel().

ApiQueryRevisions::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 813 of file ApiQueryRevisions.php.

References array().

ApiQueryRevisions::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 824 of file ApiQueryRevisions.php.

References array().

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

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

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

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

Deprecated:: since 1.24

Parameters:

int	$pageid
Title	$title
Revision	$rev

Returns:: bool|string

Definition at line 82 of file ApiQueryRevisions.php.

References $rev, $title, $wgUser, array(), and global.

ApiQueryRevisions::getTokenFunctions ( ) [protected]

Deprecated:: since 1.24

Definition at line 52 of file ApiQueryRevisions.php.

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

Referenced by extractRowInfo(), and getAllowedParams().

Member Data Documentation

ApiQueryRevisions::$contentFormat

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$diffto [private]

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$difftotext

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$expandTemplates

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_comment = false

Definition at line 45 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_content = false

Definition at line 47 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_contentmodel = false

Definition at line 47 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_flags = false

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

Definition at line 46 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_sha1 = false

Definition at line 45 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_size = false

Definition at line 45 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_tags = false

Definition at line 47 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_timestamp = false

Definition at line 44 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_user = false

Definition at line 46 of file ApiQueryRevisions.php.

ApiQueryRevisions::$fld_userid = false

Definition at line 46 of file ApiQueryRevisions.php.

ApiQueryRevisions::$generateXML

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$parseContent

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$section

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$token

Definition at line 37 of file ApiQueryRevisions.php.

ApiQueryRevisions::$tokenFunctions [private]

Definition at line 49 of file ApiQueryRevisions.php.

Referenced by extractRowInfo().

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

includes/api/ApiQueryRevisions.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