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 (ApiQuery $query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ($flags=0)
	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	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)
	getAllowedLogActions ()
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	(	ApiQuery $	query,
		$	moduleName
	)

Definition at line 34 of file ApiQueryLogEvents.php.

Member Function Documentation

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

Parameters:

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

Returns:: array

Definition at line 256 of file ApiQueryLogEvents.php.

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

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

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, $type, $user, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), array(), as, LogPage\DELETED_ACTION, LogPage\DELETED_RESTRICTED, LogPage\DELETED_USER, ApiBase\dieContinueUsageIf(), ApiBase\dieUsage(), ApiBase\encodeParamName(), ApiBase\extractRequestParams(), extractRowInfo(), getAllowedLogActions(), ContextSource\getConfig(), ApiQueryBase\getDB(), LogEventsList\getExcludeClause(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), User\idFromName(), list, Title\newFromText(), ApiBase\requireMaxOneParameter(), IP\sanitizeIP(), ApiQueryBase\select(), and ApiQueryBase\setContinueEnumParameter().

ApiQueryLogEvents::extractRowInfo ( $ row ) [private]

Definition at line 350 of file ApiQueryLogEvents.php.

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

Referenced by execute().

ApiQueryLogEvents::getAllowedLogActions ( ) [private]

Returns:: array

Definition at line 454 of file ApiQueryLogEvents.php.

References ContextSource\getConfig().

Referenced by execute(), and getAllowedParams().

ApiQueryLogEvents::getAllowedParams ( $ flags = 0 )

Definition at line 475 of file ApiQueryLogEvents.php.

References $flags, array(), ApiBase\GET_VALUES_FOR_HELP, getAllowedLogActions(), ContextSource\getConfig(), 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:

array $params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 459 of file ApiQueryLogEvents.php.

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

ApiQueryLogEvents::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 569 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 573 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 579 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 534 of file ApiQueryLogEvents.php.

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

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