Query action to List the log events, with optional filtering by various parameters. More...

Inheritance diagram for ApiQueryLogEvents:

Collaboration diagram for ApiQueryLogEvents:

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.
	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.
Static Public Member Functions
static	addLogParams ($result, &$vals, $params, $type, $action, $ts, $legacy=false)
Public Attributes
	$fld_action = false
	$fld_comment = false
	$fld_details = false
	$fld_parsedcomment = false
	$fld_tags = false
	$fld_timestamp = false
	$fld_title = false
	$fld_type = false
	$fld_user = false
	$fld_userid = false
Private Member Functions
	extractRowInfo ($row)
Private Attributes
	$fld_ids = false

Detailed Description

Query action to List the log events, with optional filtering by various parameters.

Definition at line 32 of file ApiQueryLogEvents.php.

Constructor & Destructor Documentation

ApiQueryLogEvents::__construct	(	$	query,
		$	moduleName
	)

Definition at line 34 of file ApiQueryLogEvents.php.

References $query.

Member Function Documentation

static ApiQueryLogEvents::addLogParams	(	$	result,
		&$	vals,
		$	params,
		$	type,
		$	action,
		$	ts,
		$	legacy = `false`
	)		`[static]`

Parameters:

$result	ApiResult
$vals	array
$params	string
$type	string
$action	string
$ts
$legacy	bool

Returns:: array

Definition at line 200 of file ApiQueryLogEvents.php.

References $key, $params, $result, $title, $value, ApiQueryBase\addTitleInfo(), array(), as, list, Title\newFromText(), SpecialBlock\parseExpiryInput(), wfGetDB(), and wfTimestamp().

Referenced by ApiQueryWatchlist\extractRowInfo(), extractRowInfo(), and ApiQueryRecentChanges\extractRowInfo().

ApiQueryLogEvents::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 43 of file ApiQueryLogEvents.php.

References $count, $limit, $params, $res, $result, $title, $user, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), array(), as, LogPage\DELETED_ACTION, LogPage\DELETED_USER, ApiBase\dieUsage(), ApiBase\extractRequestParams(), extractRowInfo(), ApiQueryBase\getDB(), LogEventsList\getExcludeClause(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), global, User\idFromName(), list, Title\newFromText(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), and wfTimestamp().

ApiQueryLogEvents::extractRowInfo ( $ row ) [private]

Definition at line 291 of file ApiQueryLogEvents.php.

References $title, addLogParams(), ApiQueryBase\addTitleInfo(), array(), LogPage\DELETED_ACTION, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, Linker\formatComment(), ApiBase\getResult(), LogEventsList\isDeleted(), Title\makeTitle(), DatabaseLogEntry\newFromRow(), and wfTimestamp().

Referenced by execute().

ApiQueryLogEvents::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 397 of file ApiQueryLogEvents.php.

References array(), global, 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.

ApiQueryLogEvents::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 384 of file ApiQueryLogEvents.php.

References $params, ApiQueryBase\getDB(), LogEventsList\getExcludeClause(), and ContextSource\getUser().

ApiQueryLogEvents::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 534 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 547 of file ApiQueryLogEvents.php.

References array().

ApiQueryLogEvents::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 553 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::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 449 of file ApiQueryLogEvents.php.

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

ApiQueryLogEvents::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 538 of file ApiQueryLogEvents.php.

References array().

ApiQueryLogEvents::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 478 of file ApiQueryLogEvents.php.

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

Member Data Documentation

ApiQueryLogEvents::$fld_action = false

Definition at line 39 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_comment = false

Definition at line 40 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_details = false

Definition at line 41 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_ids = false [private]

Definition at line 38 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_parsedcomment = false

Definition at line 40 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_tags = false

Definition at line 41 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_timestamp = false

Definition at line 40 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_title = false

Definition at line 38 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_type = false

Definition at line 38 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_user = false

Definition at line 39 of file ApiQueryLogEvents.php.

ApiQueryLogEvents::$fld_userid = false

Definition at line 39 of file ApiQueryLogEvents.php.

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

includes/api/ApiQueryLogEvents.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation