Inherits MediaWiki\RevisionList\RevisionListBase.

Inherited by RevDelFileList, RevDelLogList, and RevDelRevisionList.

Collaboration diagram for RevDelList:

[legend]

Public Member Functions
	__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.

	getLogAction ()
	Get the log action for this list type.

	getLogParams ( $params)
	Get log parameter array.

	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.

	doQuery ( $db)
	Do the DB query to iterate through the objects.

	filterByIds (array $ids)
	Select items only where the ID is any of the specified values.

	getPage ()

	getPageName ()

	getType ()
	Get the internal type name of this list.

	key ()

	length ()
	Get the number of items in the list.

	newItem ( $row)
	Create an item object from a DB result row.

	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.

static	getRestriction ()
	Get the user right required for this list type Override this function.

static	getRevdelConstant ()
	Get the revision deletion constant for this list type Override this function.

static	suggestTarget ( $target, array $ids)
	Suggest a target for the revision deletion Optionally override this function.

Protected Member Functions
	acquireItemLocks ()

	releaseItemLocks ()

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

Protected Attributes
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

Detailed Description

Definition at line 42 of file RevDelList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

IContextSource	$context
PageIdentity	$page
array	$ids
LBFactory	$lbFactory

Definition at line 56 of file RevDelList.php.

Member Function Documentation

◆ acquireItemLocks()

RevDelList::acquireItemLocks ( )

finalprotected

Definition at line 321 of file RevDelList.php.

Referenced by setVisibility().

◆ areAnySuppressed()

RevDelList::areAnySuppressed ( )

Indicate whether any item in this list is suppressed.

Since: 1.25

Returns: bool

Definition at line 116 of file RevDelList.php.

◆ clearFileOps()

RevDelList::clearFileOps ( )

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

Reimplemented in RevDelFileList.

Definition at line 419 of file RevDelList.php.

Referenced by setVisibility().

◆ doPostCommitUpdates()

RevDelList::doPostCommitUpdates ( array $visibilityChangeMap )

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

STUB

Parameters

array $visibilityChangeMap [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]

Returns: Status

Reimplemented in RevDelArchiveList, RevDelFileList, and RevDelRevisionList.

Definition at line 437 of file RevDelList.php.

Referenced by setVisibility().

◆ doPreCommitUpdates()

RevDelList::doPreCommitUpdates ( )

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

STUB

Returns: Status

Reimplemented in RevDelArchiveList, RevDelFileList, and RevDelRevisionList.

Definition at line 427 of file RevDelList.php.

Referenced by setVisibility().

◆ getLogAction()

RevDelList::getLogAction ( )

Get the log action for this list type.

Returns: string

Reimplemented in RevDelLogList.

Definition at line 397 of file RevDelList.php.

◆ getLogParams()

RevDelList::getLogParams ( $params )

Get log parameter array.

Parameters

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

Returns: array

Reimplemented in RevDelLogList.

Definition at line 406 of file RevDelList.php.

References $params, and MediaWiki\RevisionList\RevisionListBase\getType().

◆ getRelationType()

static RevDelList::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 in RevDelArchivedFileList, RevDelArchiveList, RevDelFileList, RevDelLogList, and RevDelRevisionList.

Definition at line 75 of file RevDelList.php.

◆ getRestriction()

static RevDelList::getRestriction ( )

static

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

Since: 1.22

Returns: string|null

Reimplemented in RevDelFileList, RevDelLogList, and RevDelRevisionList.

Definition at line 85 of file RevDelList.php.

◆ getRevdelConstant()

static RevDelList::getRevdelConstant ( )

static

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

Since: 1.22

Returns: int|null

Reimplemented in RevDelFileList, RevDelLogList, and RevDelRevisionList.

Definition at line 95 of file RevDelList.php.

◆ releaseItemLocks()

RevDelList::releaseItemLocks ( )

finalprotected

Definition at line 331 of file RevDelList.php.

Referenced by setVisibility().

◆ reloadFromPrimary()

RevDelList::reloadFromPrimary ( )

Reload the list data from the primary DB.

This can be done after setVisibility() to allow $item->getHTML() to show the new data.

Since: 1.37

Definition at line 346 of file RevDelList.php.

References MediaWiki\RevisionList\RevisionListBase\doQuery().

◆ setVisibility()

RevDelList::setVisibility ( array $params )

Set the visibility for the revisions in this list.

Logging and transactions are done here.

Parameters

array $params Associative array of parameters. Members are: value: ExtractBitParams() bitfield array comment: The log comment perItemStatus: Set if you want per-item status reports tags: The array of change tags to apply to the log entry

Returns: Status

Since: 1.23 Added 'perItemStatus' param

Definition at line 139 of file RevDelList.php.

References $params, acquireItemLocks(), clearFileOps(), doPostCommitUpdates(), doPreCommitUpdates(), MediaWiki\RevisionList\RevisionListBase\doQuery(), and releaseItemLocks().

◆ suggestTarget()

static RevDelList::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 in RevDelLogList, and RevDelRevisionList.

Definition at line 107 of file RevDelList.php.

Member Data Documentation

◆ SUPPRESS_BIT

const RevDelList::SUPPRESS_BIT = RevisionRecord::DELETED_RESTRICTED

protected

Flag used for suppression, depending on the type of log.

Definition at line 45 of file RevDelList.php.

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

includes/revisiondelete/RevDelList.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireItemLocks()

◆ areAnySuppressed()

◆ clearFileOps()

◆ doPostCommitUpdates()

◆ doPreCommitUpdates()

◆ getLogAction()

◆ getLogParams()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ releaseItemLocks()

◆ reloadFromPrimary()

◆ setVisibility()

◆ suggestTarget()

Member Data Documentation

◆ SUPPRESS_BIT