Inherits MediaWiki\RevisionList\RevisionListBase.

Inherited by MediaWiki\RevisionDelete\RevDelFileList, MediaWiki\RevisionDelete\RevDelLogList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Collaboration diagram for MediaWiki\RevisionDelete\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 ()

	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.

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 33 of file RevDelList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 47 of file RevDelList.php.

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

Member Function Documentation

◆ acquireItemLocks()

MediaWiki\RevisionDelete\RevDelList::acquireItemLocks ( )

finalprotected

Definition at line 335 of file RevDelList.php.

References StatusValue\merge().

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ areAnySuppressed()

MediaWiki\RevisionDelete\RevDelList::areAnySuppressed ( )

Indicate whether any item in this list is suppressed.

Since: 1.25

Returns: bool

Definition at line 107 of file RevDelList.php.

References MediaWiki\RevisionDelete\RevDelList\SUPPRESS_BIT.

◆ clearFileOps()

MediaWiki\RevisionDelete\RevDelList::clearFileOps ( )

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

Reimplemented in MediaWiki\RevisionDelete\RevDelFileList.

Definition at line 435 of file RevDelList.php.

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ doPostCommitUpdates()

MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelArchiveList, MediaWiki\RevisionDelete\RevDelFileList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 453 of file RevDelList.php.

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ doPreCommitUpdates()

MediaWiki\RevisionDelete\RevDelList::doPreCommitUpdates ( )

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

STUB

Returns: Status

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveList, MediaWiki\RevisionDelete\RevDelFileList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 443 of file RevDelList.php.

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ emitEvents()

MediaWiki\RevisionDelete\RevDelList::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 in MediaWiki\RevisionDelete\RevDelArchiveList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 325 of file RevDelList.php.

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ getLogAction()

MediaWiki\RevisionDelete\RevDelList::getLogAction ( )

Get the log action for this list type.

Returns: string

Reimplemented in MediaWiki\RevisionDelete\RevDelLogList.

Definition at line 413 of file RevDelList.php.

◆ getLogParams()

MediaWiki\RevisionDelete\RevDelList::getLogParams ( $params )

Get log parameter array.

Parameters

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

Returns: array

Reimplemented in MediaWiki\RevisionDelete\RevDelLogList.

Definition at line 422 of file RevDelList.php.

◆ getRelationType()

static MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelArchivedFileList, MediaWiki\RevisionDelete\RevDelArchiveList, MediaWiki\RevisionDelete\RevDelFileList, MediaWiki\RevisionDelete\RevDelLogList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 66 of file RevDelList.php.

◆ getRestriction()

static MediaWiki\RevisionDelete\RevDelList::getRestriction ( )

static

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

Since: 1.22

Returns: string|null

Reimplemented in MediaWiki\RevisionDelete\RevDelFileList, MediaWiki\RevisionDelete\RevDelLogList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 76 of file RevDelList.php.

◆ getRevdelConstant()

static MediaWiki\RevisionDelete\RevDelList::getRevdelConstant ( )

static

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

Since: 1.22

Returns: int|null

Reimplemented in MediaWiki\RevisionDelete\RevDelFileList, MediaWiki\RevisionDelete\RevDelLogList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 86 of file RevDelList.php.

◆ releaseItemLocks()

MediaWiki\RevisionDelete\RevDelList::releaseItemLocks ( )

finalprotected

Definition at line 345 of file RevDelList.php.

References StatusValue\merge().

Referenced by MediaWiki\RevisionDelete\RevDelList\setVisibility().

◆ reloadFromPrimary()

MediaWiki\RevisionDelete\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 360 of file RevDelList.php.

◆ setVisibility()

MediaWiki\RevisionDelete\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 130 of file RevDelList.php.

References MediaWiki\RevisionDelete\RevDelList\acquireItemLocks(), MediaWiki\RevisionDelete\RevDelList\clearFileOps(), MediaWiki\RevisionDelete\RevDelList\doPostCommitUpdates(), MediaWiki\RevisionDelete\RevDelList\doPreCommitUpdates(), MediaWiki\RevisionList\RevisionListBase\doQuery(), MediaWiki\RevisionDelete\RevDelList\emitEvents(), MediaWiki\RevisionDelete\RevisionDeleter\extractBitfield(), and MediaWiki\RevisionDelete\RevDelList\releaseItemLocks().

◆ suggestTarget()

static MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelLogList, and MediaWiki\RevisionDelete\RevDelRevisionList.

Definition at line 98 of file RevDelList.php.

Member Data Documentation

◆ SUPPRESS_BIT

const MediaWiki\RevisionDelete\RevDelList::SUPPRESS_BIT = RevisionRecord::DELETED_RESTRICTED

protected

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

Definition at line 36 of file RevDelList.php.

Referenced by MediaWiki\RevisionDelete\RevDelList\areAnySuppressed().

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

◆ emitEvents()

◆ getLogAction()

◆ getLogParams()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ releaseItemLocks()

◆ reloadFromPrimary()

◆ setVisibility()

◆ suggestTarget()

Member Data Documentation

◆ SUPPRESS_BIT