MediaWiki  1.23.2
RevDel_List Class Reference

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

Inheritance diagram for RevDel_List:
Collaboration diagram for RevDel_List:

Public Member Functions

 __construct (IContextSource $context, Title $title, array $ids)
 
 clearFileOps ()
 Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB. More...
 
 doPostCommitUpdates ()
 A hook for setVisibility(): do any necessary updates post-commit. More...
 
 doPreCommitUpdates ()
 A hook for setVisibility(): do batch updates pre-commit. More...
 
 getLogAction ()
 Get the log action for this list type. More...
 
 getLogParams ( $params)
 Get log parameter array. More...
 
 getSuppressBit ()
 Get the integer value of the flag used for suppression. More...
 
 reloadFromMaster ()
 Reload the list data from the master DB. More...
 
 setVisibility ( $params)
 Set the visibility for the revisions in this list. More...
 
- Public Member Functions inherited from RevisionListBase
 __construct (IContextSource $context, Title $title)
 Construct a revision list for a given title. More...
 
 current ()
 Get the current list item, or false if we are at the end. More...
 
 doQuery ( $db)
 Do the DB query to iterate through the objects. More...
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values. More...
 
 getType ()
 Get the internal type name of this list. More...
 
 length ()
 Get the number of items in the list. More...
 
 newItem ( $row)
 Create an item object from a DB result row. More...
 
 next ()
 Move the iteration pointer to the next list item, and return it. More...
 
 reset ()
 Start iteration. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Static Public Member Functions

static getRelationType ()
 Get the DB field name associated with the ID list. More...
 
static getRestriction ()
 Get the user right required for this list type Override this function. More...
 
static getRevdelConstant ()
 Get the revision deletion constant for this list type Override this function. More...
 
static suggestTarget ( $target, array $ids)
 Suggest a target for the revision deletion Optionally override this function. More...
 

Protected Member Functions

 updateLog ( $params)
 Record a log entry on the action. More...
 
- Protected Member Functions inherited from RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer. More...
 

Additional Inherited Members

- Public Attributes inherited from RevisionListBase
 $current
 
 $ids
 
 $res
 
Title $title
 

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 RevDel_Item subclasses wrapping them, and to wrap bulk update operations.

Definition at line 30 of file RevisionDeleteAbstracts.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ clearFileOps()

RevDel_List::clearFileOps ( )

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

Reimplemented in RevDel_FileList.

Definition at line 288 of file RevisionDeleteAbstracts.php.

Referenced by setVisibility().

◆ doPostCommitUpdates()

RevDel_List::doPostCommitUpdates ( )

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

STUB

Returns
Status

Reimplemented in RevDel_FileList, RevDel_ArchiveList, and RevDel_RevisionList.

Definition at line 305 of file RevisionDeleteAbstracts.php.

References Status\newGood().

Referenced by setVisibility().

◆ doPreCommitUpdates()

RevDel_List::doPreCommitUpdates ( )

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

STUB

Returns
Status

Reimplemented in RevDel_FileList, RevDel_ArchiveList, and RevDel_RevisionList.

Definition at line 296 of file RevisionDeleteAbstracts.php.

References Status\newGood().

Referenced by setVisibility().

◆ getLogAction()

RevDel_List::getLogAction ( )

Get the log action for this list type.

Returns
string

Reimplemented in RevDel_LogList.

Definition at line 266 of file RevisionDeleteAbstracts.php.

Referenced by updateLog().

◆ getLogParams()

RevDel_List::getLogParams (   $params)

Get log parameter array.

Parameters
array$paramsAssociative array of log parameters, same as updateLog()
Returns
array

Reimplemented in RevDel_LogList.

Definition at line 275 of file RevisionDeleteAbstracts.php.

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

Referenced by updateLog().

◆ getRelationType()

static RevDel_List::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 RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, and RevDel_RevisionList.

Definition at line 42 of file RevisionDeleteAbstracts.php.

◆ getRestriction()

static RevDel_List::getRestriction ( )
static

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

Since
1.22
Returns
string|null

Reimplemented in RevDel_LogList, RevDel_FileList, and RevDel_RevisionList.

Definition at line 52 of file RevisionDeleteAbstracts.php.

◆ getRevdelConstant()

static RevDel_List::getRevdelConstant ( )
static

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

Since
1.22
Returns
int|null

Reimplemented in RevDel_LogList, RevDel_FileList, and RevDel_RevisionList.

Definition at line 62 of file RevisionDeleteAbstracts.php.

◆ getSuppressBit()

RevDel_List::getSuppressBit ( )
abstract

Get the integer value of the flag used for suppression.

Reimplemented in RevDel_LogList, RevDel_FileList, and RevDel_RevisionList.

Referenced by updateLog().

◆ reloadFromMaster()

RevDel_List::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 RevisionDeleteAbstracts.php.

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

◆ setVisibility()

RevDel_List::setVisibility (   $params)

Set the visibility for the revisions in this list.

Logging and transactions are done here.

Parameters
array$paramsAssociative 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 89 of file RevisionDeleteAbstracts.php.

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

◆ suggestTarget()

static RevDel_List::suggestTarget (   $target,
array  $ids 
)
static

Suggest a target for the revision deletion Optionally override this function.

Since
1.22
Parameters
Title | null$targetUser-supplied target
array$ids
Returns
Title|null

Reimplemented in RevDel_LogList, and RevDel_RevisionList.

Definition at line 74 of file RevisionDeleteAbstracts.php.

◆ updateLog()

RevDel_List::updateLog (   $params)
protected

Record a log entry on the action.

Parameters
array$paramsAssociative 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 RevisionDeleteAbstracts.php.

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

Referenced by setVisibility().


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