Abstract base class for a list of deletable items. More...

Inheritance diagram for RevDelList:

[legend]

Collaboration diagram for RevDelList:

[legend]

Public Member Functions
	__construct (IContextSource $context, Title $title, array $ids)

	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.

	getSuppressBit ()
	Get the integer value of the flag used for suppression.

	reloadFromMaster ()
	Reload the list data from the master DB.

	setVisibility (array $params)
	Set the visibility for the revisions in this list.

Public Member Functions inherited from RevisionListBase
	__construct (IContextSource $context, Title $title)
	Construct a revision list for a given title.

	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.

	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 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.

	getConfig ()
	Get the Config object.

	getContext ()
	Get the base IContextSource object.

	getLanguage ()
	Get the Language object.

	getOutput ()
	Get the OutputPage object.

	getRequest ()
	Get the WebRequest object.

	getSkin ()
	Get the Skin object.

	getStats ()
	Get the Stats object.

	getTiming ()
	Get the Timing object.

	getTitle ()
	Get the Title object.

	getUser ()
	Get the User object.

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)
	Set the IContextSource object.

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 RevisionListBase
	initCurrent ()
	Initialise the current iteration pointer.

Private Member Functions
	updateLog ( $logType, $params)
	Record a log entry on the action.

Additional Inherited Members
Public Attributes inherited from RevisionListBase
Title	$title

Protected Attributes inherited from RevisionListBase
bool Revision	$current

array	$ids

ResultWrapper bool	$res

Detailed Description

Abstract base class for a list of deletable items.

The list class needs to be able to make a query from a set of identifiers to pull relevant rows, to return RevDelItem subclasses wrapping them, and to wrap bulk update operations.

Definition at line 30 of file RevDelList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelList::__construct	(	IContextSource	$context,
		Title	$title,
		array	$ids )

Definition at line 31 of file RevDelList.php.

References ContextSource\$context, and RevisionListBase\$ids.

Member Function Documentation

◆ acquireItemLocks()

RevDelList::acquireItemLocks ( )

finalprotected

Definition at line 295 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 83 of file RevDelList.php.

References getSuppressBit().

◆ clearFileOps()

RevDelList::clearFileOps ( )

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

Reimplemented in RevDelFileList.

Definition at line 390 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 408 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 398 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 368 of file RevDelList.php.

Referenced by updateLog().

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

References $params, and RevisionListBase\getType().

Referenced by updateLog().

◆ 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 42 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 52 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 62 of file RevDelList.php.

◆ getSuppressBit()

RevDelList::getSuppressBit ( )

abstract

Get the integer value of the flag used for suppression.

Reimplemented in RevDelFileList, RevDelLogList, and RevDelRevisionList.

Referenced by areAnySuppressed(), and setVisibility().

◆ releaseItemLocks()

RevDelList::releaseItemLocks ( )

finalprotected

Definition at line 305 of file RevDelList.php.

Referenced by setVisibility().

◆ reloadFromMaster()

RevDelList::reloadFromMaster ( )

Reload the list data from the master DB.

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

Definition at line 319 of file RevDelList.php.

References DB_MASTER, RevisionListBase\doQuery(), and wfGetDB().

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

References $params, acquireItemLocks(), clearFileOps(), DB_MASTER, Revision\DELETED_RESTRICTED, doPostCommitUpdates(), doPreCommitUpdates(), RevisionListBase\doQuery(), RevisionDeleter\extractBitfield(), getSuppressBit(), releaseItemLocks(), updateLog(), and wfGetDB().

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

◆ updateLog()

RevDelList::updateLog	(		$logType,
			$params )

private

Record a log entry on the action.

Parameters

string	$logType	One of (delete,suppress)
array	$params	Associative array of parameters: newBits: The new value of the _deleted bitfield oldBits: The old value of the _deleted bitfield. title: The target title ids: The ID list comment: The log comment authorsIds: The array of the user IDs of the offenders authorsIPs: The array of the IP/anon user offenders tags: The array of change tags to apply to the log entry

Exceptions

MWException

Definition at line 338 of file RevDelList.php.

References $params, getLogAction(), getLogParams(), RevisionDeleter\getRelationType(), RevisionListBase\getType(), and ContextSource\getUser().

Referenced by setVisibility().

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

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireItemLocks()

◆ areAnySuppressed()

◆ clearFileOps()

◆ doPostCommitUpdates()

◆ doPreCommitUpdates()

◆ getLogAction()

◆ getLogParams()

◆ getRelationType()

◆ getRestriction()

◆ getRevdelConstant()

◆ getSuppressBit()

◆ releaseItemLocks()

◆ reloadFromMaster()

◆ setVisibility()

◆ suggestTarget()

◆ updateLog()