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, DomainEventDispatcher $eventDispatcher)

doPostCommitUpdates (array $visibilityChangeMap)

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

Parameters

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

Returns: Status

doPreCommitUpdates ()

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

Returns: Status

doQuery ( $db)

getCurrent ()

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.

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.

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

Public Attributes
int	$currentRevId

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

Protected Member Functions inherited from RevDelList
	acquireItemLocks ()

	releaseItemLocks ()

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

Additional Inherited Members
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

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 34 of file RevDelRevisionList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in RevDelArchiveList.

Definition at line 52 of file RevDelRevisionList.php.

References MediaWiki\RevisionList\RevisionListBase\$ids, and MediaWiki\RevisionList\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 237 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 231 of file RevDelRevisionList.php.

◆ doQuery()

RevDelRevisionList::doQuery ( $db )

Parameters

\\Wikimedia\\Rdbms\\IReadableDatabase $db

Returns: IResultWrapper

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 106 of file RevDelRevisionList.php.

References MediaWiki\RevisionList\RevisionListBase\$ids.

◆ emitEvents()

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

protected

Parameters

array	$bitPars	See RevisionDeleter::extractBitfield
array	$visibilityChangeMap	[id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
array	$tags
LogEntry	$logEntry
bool	$suppressed

Reimplemented from RevDelList.

Reimplemented in RevDelArchiveList.

Definition at line 185 of file RevDelRevisionList.php.

References MediaWiki\RevisionList\RevisionListBase\$page, getCurrent(), MediaWiki\RevisionList\RevisionListBase\getPage(), and MediaWiki\Context\ContextSource\getUser().

◆ getCurrent()

RevDelRevisionList::getCurrent ( )

Definition at line 166 of file RevDelRevisionList.php.

References $currentRevId.

Referenced by emitEvents().

◆ 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 76 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 81 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 86 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 MediaWiki\RevisionList\RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 71 of file RevDelRevisionList.php.

◆ newItem()

RevDelRevisionList::newItem ( $row )

Create an item object from a DB result row.

Parameters

stdClass $row

Returns: RevisionItemBase

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 154 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 91 of file RevDelRevisionList.php.

References MediaWiki\RevisionList\RevisionListBase\$ids.

Member Data Documentation

◆ $currentRevId

int RevDelRevisionList::$currentRevId

Definition at line 49 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

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doPostCommitUpdates()

◆ doPreCommitUpdates()

◆ doQuery()

◆ emitEvents()

◆ getCurrent()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ getType()

◆ newItem()

◆ suggestTarget()

Member Data Documentation

◆ $currentRevId