List for revision table items. More...

Collaboration diagram for RevDelRevisionList:

[legend]

Public Member Functions
	__construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory, HookContainer $hookContainer, HtmlCacheUpdater $htmlCacheUpdater, RevisionStore $revisionStore)

	doPostCommitUpdates (array $visibilityChangeMap)
	A hook for setVisibility(): do any necessary updates post-commit.

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

	doQuery ( $db)

	getCurrent ()

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

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

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.

	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 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 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 ()

	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.

Public Attributes
int	$currentRevId

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

	releaseItemLocks ()

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

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 RevisionListBase
RevisionItemBase false	$current

int[] null	$ids

PageIdentity	$page

IResultWrapper false	$res

Detailed Description

List for revision table items.

This will check both the 'revision' table for live revisions and the 'archive' table for traditionally-deleted revisions that have an ar_rev_id saved.

See RevDelRevisionItem and RevDelArchivedRevisionItem for items.

Definition at line 43 of file RevDelRevisionList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelRevisionList::__construct	(	IContextSource	$context,
		PageIdentity	$page,
		array	$ids,
		LBFactory	$lbFactory,
		HookContainer	$hookContainer,
		HtmlCacheUpdater	$htmlCacheUpdater,
		RevisionStore	$revisionStore )

Parameters

IContextSource	$context
PageIdentity	$page
array	$ids
LBFactory	$lbFactory
HookContainer	$hookContainer
HtmlCacheUpdater	$htmlCacheUpdater
RevisionStore	$revisionStore

Reimplemented in RevDelArchiveList.

Definition at line 69 of file RevDelRevisionList.php.

References RevisionListBase\$ids, and RevisionListBase\$page.

Member Function Documentation

◆ doPostCommitUpdates()

RevDelRevisionList::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 from RevDelList.

Reimplemented in RevDelArchiveList.

Definition at line 191 of file RevDelRevisionList.php.

◆ doPreCommitUpdates()

RevDelRevisionList::doPreCommitUpdates ( )

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

STUB

Returns: Status

Reimplemented from RevDelList.

Reimplemented in RevDelArchiveList.

Definition at line 186 of file RevDelRevisionList.php.

◆ doQuery()

RevDelRevisionList::doQuery ( $db )

Parameters

\\Wikimedia\\Rdbms\\IReadableDatabase $db

Returns: IResultWrapper

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 116 of file RevDelRevisionList.php.

References RevisionListBase\$ids.

◆ getCurrent()

RevDelRevisionList::getCurrent ( )

Definition at line 174 of file RevDelRevisionList.php.

References $currentRevId.

◆ getRelationType()

static RevDelRevisionList::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.

Reimplemented in RevDelArchiveList.

Definition at line 89 of file RevDelRevisionList.php.

◆ getRestriction()

static RevDelRevisionList::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 93 of file RevDelRevisionList.php.

◆ getRevdelConstant()

static RevDelRevisionList::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 97 of file RevDelRevisionList.php.

◆ getType()

RevDelRevisionList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns: string|null

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 85 of file RevDelRevisionList.php.

◆ newItem()

RevDelRevisionList::newItem ( $row )

Create an item object from a DB result row.

Parameters

stdClass $row

Returns: RevisionItemBase

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 163 of file RevDelRevisionList.php.

◆ suggestTarget()

static RevDelRevisionList::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 101 of file RevDelRevisionList.php.

References RevisionListBase\$ids.

Member Data Documentation

◆ $currentRevId

int RevDelRevisionList::$currentRevId

Definition at line 58 of file RevDelRevisionList.php.

Referenced by getCurrent().

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

includes/revisiondelete/RevDelRevisionList.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doPostCommitUpdates()

◆ doPreCommitUpdates()

◆ doQuery()

◆ getCurrent()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ getType()

◆ newItem()

◆ suggestTarget()

Member Data Documentation

◆ $currentRevId