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

Inheritance diagram for RevDelList:

Collaboration diagram for RevDelList:

Public Member Functions
	__construct (IContextSource $context, Title $title, array $ids)
	clearFileOps ()
	Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.
	doPostCommitUpdates ()
	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 ($params)
	Set the visibility for the revisions in this list.
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
	updateLog ($params)
	Record a log entry on the action.

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

Constructor & Destructor Documentation

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

Definition at line 29 of file RevDelList.php.

References RevisionListBase\$ids.

Member Function Documentation

RevDelList::clearFileOps ( )

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

Reimplemented in RevDelFileList.

Definition at line 288 of file RevDelList.php.

Referenced by setVisibility().

RevDelList::doPostCommitUpdates ( )

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

STUB

Returns:: Status

Reimplemented in RevDelRevisionList, RevDelFileList, and RevDelArchiveList.

Definition at line 305 of file RevDelList.php.

References Status\newGood().

Referenced by setVisibility().

RevDelList::doPreCommitUpdates ( )

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

STUB

Returns:: Status

Reimplemented in RevDelRevisionList, RevDelFileList, and RevDelArchiveList.

Definition at line 296 of file RevDelList.php.

References Status\newGood().

Referenced by setVisibility().

RevDelList::getLogAction ( )

Get the log action for this list type.

Returns:: string

Reimplemented in RevDelLogList.

Definition at line 266 of file RevDelList.php.

Referenced by updateLog().

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

References $params, array(), and RevisionListBase\getType().

Referenced by updateLog().

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

Definition at line 40 of file RevDelList.php.

Referenced by updateLog().

static RevDelList::getRestriction ( ) [static]

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

Since:: 1.22

Returns:: string|null

Reimplemented in RevDelRevisionList, RevDelFileList, and RevDelLogList.

Definition at line 50 of file RevDelList.php.

static RevDelList::getRevdelConstant ( ) [static]

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

Since:: 1.22

Returns:: int|null

Reimplemented in RevDelRevisionList, RevDelFileList, and RevDelLogList.

Definition at line 60 of file RevDelList.php.

RevDelList::getSuppressBit ( ) [abstract]

Get the integer value of the flag used for suppression.

Reimplemented in RevDelRevisionList, RevDelFileList, and RevDelLogList.

Referenced by updateLog().

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

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

RevDelList::setVisibility ( $ 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: The integer value to set the visibility to comment: The log comment. perItemStatus: Set if you want per-item status reports

Returns:: Status

Since:: 1.23 Added 'perItemStatus' param

Definition at line 87 of file RevDelList.php.

References $comment, $ok, $params, array(), as, clearFileOps(), RevisionListBase\current(), Revision\DELETED_RESTRICTED, doPostCommitUpdates(), doPreCommitUpdates(), RevisionListBase\doQuery(), RevisionDeleter\extractBitfield(), IP\isIPAddress(), Status\newFatal(), Status\newGood(), RevisionListBase\next(), RevisionListBase\reset(), title, updateLog(), and wfGetDB().

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 RevDelRevisionList, and RevDelLogList.

Definition at line 72 of file RevDelList.php.

RevDelList::updateLog ( $ params ) [protected]

Record a log entry on the action.

Parameters:

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

Exceptions:

MWException

Definition at line 238 of file RevDelList.php.

References $params, getLogAction(), getLogParams(), getRelationType(), getSuppressBit(), 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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation