List for logging table items. More...

Collaboration diagram for RevDelLogList:

[legend]

Public Member Functions

__construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory, CommentStore $commentStore, LogFormatterFactory $logFormatterFactory)

doQuery ( $db)

getLogAction ()

Get the log action for this list type.

Returns: string

getLogParams ( $params)

Get log parameter array.

Parameters

array $params Associative array of log parameters, same as updateLog()

Returns: array

getType ()

Get the internal type name of this list.Equal to the table name. Override this function.

Returns: string|null

newItem ( $row)

Create an item object from a DB result row.

Parameters

stdClass $row

Returns: RevisionItemBase

Public Member Functions inherited from RevDelList

__construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory)

areAnySuppressed ()

Indicate whether any item in this list is suppressed.

clearFileOps ()

Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.

doPostCommitUpdates (array $visibilityChangeMap)

A hook for setVisibility(): do any necessary updates post-commit.

doPreCommitUpdates ()

A hook for setVisibility(): do batch updates pre-commit.

reloadFromPrimary ()

Reload the list data from the primary DB.

setVisibility (array $params)

Set the visibility for the revisions in this list.

Public Member Functions inherited from MediaWiki\RevisionList\RevisionListBase

__construct (IContextSource $context, PageIdentity $page)

Construct a revision list for a given page identity.

current ()

Get the current list item, or false if we are at the end.

filterByIds (array $ids)

Select items only where the ID is any of the specified values.

getPage ()

getPageName ()

key ()

length ()

Get the number of items in the list.

next ()

Move the iteration pointer to the next list item, and return it.

reset ()

Start iteration.

rewind ()

valid ()

Public Member Functions inherited from MediaWiki\Context\ContextSource

canUseWikiPage ()

Check whether a WikiPage object can be get with getWikiPage().

exportSession ()

Export the resolved user IP, HTTP headers, user ID, and session ID.

getActionName ()

Get the action name for the current web request.

getAuthority ()

getConfig ()

getContext ()

Get the base IContextSource object.

getCsrfTokenSet ()

Get a repository to obtain and match CSRF tokens.

getLanguage ()

getLanguageCode ()

getOutput ()

getRequest ()

getSkin ()

getTiming ()

getTitle ()

getUser ()

getWikiPage ()

Get the WikiPage object.

msg ( $key,... $params)

Get a Message object with context set Parameters are the same as wfMessage()

setContext (IContextSource $context)

Static Public Member Functions

static getRelationType ()

Get the DB field name associated with the ID list.This used to populate the log_search table for finding log entries. Override this function.

Returns: string|null

static getRestriction ()

Get the user right required for this list type Override this function.

Since: 1.22

Returns: string|null

static getRevdelConstant ()

Get the revision deletion constant for this list type Override this function.

Since: 1.22

Returns: int|null

static suggestTarget ( $target, array $ids)

Suggest a target for the revision deletion Optionally override this function.

Since: 1.22

Parameters

Title \| null	$target	User-supplied target
array	$ids

Returns: Title|null

Protected Attributes
const	SUPPRESS_BIT = LogPage::DELETED_RESTRICTED

Protected Attributes inherited from RevDelList
const	SUPPRESS_BIT = RevisionRecord::DELETED_RESTRICTED
	Flag used for suppression, depending on the type of log.

Protected Attributes inherited from MediaWiki\RevisionList\RevisionListBase
RevisionItemBase false	$current

int[] null	$ids

PageIdentity	$page

IResultWrapper false	$res

Additional Inherited Members
Protected Member Functions inherited from RevDelList
	acquireItemLocks ()

	emitEvents (array $bitPars, array $visibilityChangeMap, array $tags, LogEntry $logEntry, bool $suppressed)

	releaseItemLocks ()

Protected Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
	initCurrent ()
	Initialise the current iteration pointer.

Detailed Description

List for logging table items.

Definition at line 22 of file RevDelLogList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelLogList::__construct	(	IContextSource	$context,
		PageIdentity	$page,
		array	$ids,
		LBFactory	$lbFactory,
		CommentStore	$commentStore,
		LogFormatterFactory	$logFormatterFactory )

Access: internal: Use RevisionDeleter

Parameters

IContextSource	$context
PageIdentity	$page
array	$ids
LBFactory	$lbFactory
CommentStore	$commentStore
LogFormatterFactory	$logFormatterFactory

Definition at line 39 of file RevDelLogList.php.

Member Function Documentation

◆ doQuery()

RevDelLogList::doQuery ( $db )

Parameters

\\Wikimedia\\Rdbms\\IReadableDatabase $db

Returns: IResultWrapper

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 93 of file RevDelLogList.php.

References MediaWiki\RevisionList\RevisionListBase\$ids.

◆ getLogAction()

RevDelLogList::getLogAction ( )

Get the log action for this list type.

Returns: string

Reimplemented from RevDelList.

Definition at line 136 of file RevDelLogList.php.

◆ getLogParams()

RevDelLogList::getLogParams ( $params )

Get log parameter array.

Parameters

array $params Associative array of log parameters, same as updateLog()

Returns: array

Reimplemented from RevDelList.

Definition at line 141 of file RevDelLogList.php.

◆ getRelationType()

static RevDelLogList::getRelationType ( )

static

Get the DB field name associated with the ID list.This used to populate the log_search table for finding log entries. Override this function.

Returns: string|null

Reimplemented from RevDelList.

Definition at line 58 of file RevDelLogList.php.

◆ getRestriction()

static RevDelLogList::getRestriction ( )

static

Get the user right required for this list type Override this function.

Since: 1.22

Returns: string|null

Reimplemented from RevDelList.

Definition at line 63 of file RevDelLogList.php.

◆ getRevdelConstant()

static RevDelLogList::getRevdelConstant ( )

static

Get the revision deletion constant for this list type Override this function.

Since: 1.22

Returns: int|null

Reimplemented from RevDelList.

Definition at line 68 of file RevDelLogList.php.

◆ getType()

RevDelLogList::getType ( )

Get the internal type name of this list.Equal to the table name. Override this function.

Returns: string|null

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 53 of file RevDelLogList.php.

◆ newItem()

RevDelLogList::newItem ( $row )

Create an item object from a DB result row.

Parameters

stdClass $row

Returns: RevisionItemBase

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 125 of file RevDelLogList.php.

◆ suggestTarget()

static RevDelLogList::suggestTarget	(		$target,
		array	$ids )

static

Suggest a target for the revision deletion Optionally override this function.

Since: 1.22

Parameters

Title \| null	$target	User-supplied target
array	$ids

Returns: Title|null

Reimplemented from RevDelList.

Definition at line 73 of file RevDelLogList.php.

Referenced by MediaWiki\ChangeTags\ChangeTags\updateTagsWithChecks().

Member Data Documentation

◆ SUPPRESS_BIT

const RevDelLogList::SUPPRESS_BIT = LogPage::DELETED_RESTRICTED

protected

Definition at line 24 of file RevDelLogList.php.

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

includes/RevisionDelete/RevDelLogList.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doQuery()

◆ getLogAction()

◆ getLogParams()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ getType()

◆ newItem()

◆ suggestTarget()

Member Data Documentation

◆ SUPPRESS_BIT