MediaWiki  master
RevDelRevisionList Class Reference

List for revision table items. More...

Inheritance diagram for RevDelRevisionList:
Collaboration diagram for RevDelRevisionList:

Public Member Functions

 doPostCommitUpdates (array $visibilityChangeMap)
 A hook for setVisibility(): do any necessary updates post-commit. More...
 
 doPreCommitUpdates ()
 A hook for setVisibility(): do batch updates pre-commit. More...
 
 doQuery ( $db)
 
 getCurrent ()
 
 getSuppressBit ()
 Get the integer value of the flag used for suppression. More...
 
 getType ()
 Get the internal type name of this list. More...
 
 newItem ( $row)
 Create an item object from a DB result row. More...
 
- Public Member Functions inherited from RevDelList
 __construct (IContextSource $context, Title $title, array $ids)
 
 areAnySuppressed ()
 Indicate whether any item in this list is suppressed. More...
 
 clearFileOps ()
 Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB. More...
 
 getLogAction ()
 Get the log action for this list type. More...
 
 getLogParams ( $params)
 Get log parameter array. More...
 
 reloadFromMaster ()
 Reload the list data from the master DB. More...
 
 setVisibility (array $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...
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values. More...
 
 key ()
 
 length ()
 Get the number of items in the list. More...
 
 next ()
 Move the iteration pointer to the next list item, and return it. More...
 
 reset ()
 Start iteration. More...
 
 rewind ()
 
 valid ()
 
- 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 Stable for overriding. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

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

Public Attributes

int $currentRevId
 
- Public Attributes inherited from RevisionListBase
Title $title
 

Additional Inherited Members

- Protected Member Functions inherited from RevDelList
 acquireItemLocks ()
 
 releaseItemLocks ()
 
- Protected Member Functions inherited from RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer. More...
 
- Protected Attributes inherited from RevisionListBase
RevisionItemBase false $current
 
array $ids
 
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 37 of file RevDelRevisionList.php.

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

References StatusValue\newGood().

◆ doPreCommitUpdates()

RevDelRevisionList::doPreCommitUpdates ( )

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

STUB

Returns
Status

Reimplemented from RevDelList.

Reimplemented in RevDelArchiveList.

Definition at line 185 of file RevDelRevisionList.php.

References StatusValue\newGood().

◆ doQuery()

RevDelRevisionList::doQuery (   $db)
Parameters
IDatabase$db
Returns
mixed

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 74 of file RevDelRevisionList.php.

References RevisionListBase\$ids, $revQuery, and ChangeTags\modifyDisplayQuery().

◆ getCurrent()

RevDelRevisionList::getCurrent ( )

Definition at line 172 of file RevDelRevisionList.php.

References $currentRevId, DB_MASTER, and wfGetDB().

◆ 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 47 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 51 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 55 of file RevDelRevisionList.php.

◆ getSuppressBit()

RevDelRevisionList::getSuppressBit ( )

Get the integer value of the flag used for suppression.

Reimplemented from RevDelList.

Definition at line 181 of file RevDelRevisionList.php.

◆ getType()

RevDelRevisionList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
null

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 43 of file RevDelRevisionList.php.

◆ newItem()

RevDelRevisionList::newItem (   $row)

Create an item object from a DB result row.

Parameters
object$row
Returns
RevisionItemBase

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 161 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$targetUser-supplied target
array$ids
Returns
Title|null

Reimplemented from RevDelList.

Definition at line 59 of file RevDelRevisionList.php.

References RevisionListBase\$ids, and Title\newFromLinkTarget().

Member Data Documentation

◆ $currentRevId

int RevDelRevisionList::$currentRevId

Definition at line 41 of file RevDelRevisionList.php.

Referenced by getCurrent().


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