MediaWiki  master
RevDelRevisionList Class Reference

List for revision table items. More...

Inheritance diagram for RevDelRevisionList:
Collaboration diagram for RevDelRevisionList:

Public Member Functions

 __construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory, HookContainer $hookContainer, HtmlCacheUpdater $htmlCacheUpdater, RevisionStore $revisionStore, WANObjectCache $wanObjectCache)
 
 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, PageIdentity $page, array $ids, LBFactory $lbFactory)
 
 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 ()
 
 reloadFromPrimary ()
 Reload the list data from the primary DB. More...
 
 setVisibility (array $params)
 Set the visibility for the revisions in this list. More...
 
- Public Member Functions inherited from RevisionListBase
 __construct (IContextSource $context, PageIdentity $page)
 Construct a revision list for a given page identity. 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...
 
 getPage ()
 
 getPageName ()
 
 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...
 
 getActionName ()
 Get the action name for the current web request. More...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 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
 

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
 
int[] null $ids
 
PageIdentity $page
 
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 41 of file RevDelRevisionList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelRevisionList::__construct ( IContextSource  $context,
PageIdentity  $page,
array  $ids,
LBFactory  $lbFactory,
HookContainer  $hookContainer,
HtmlCacheUpdater  $htmlCacheUpdater,
RevisionStore  $revisionStore,
WANObjectCache  $wanObjectCache 
)
Parameters
IContextSource$context
PageIdentity$page
array$ids
LBFactory$lbFactory
HookContainer$hookContainer
HtmlCacheUpdater$htmlCacheUpdater
RevisionStore$revisionStore
WANObjectCache$wanObjectCache

Reimplemented in RevDelArchiveList.

Definition at line 71 of file RevDelRevisionList.php.

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

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

References Title\castFromPageIdentity(), and 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 234 of file RevDelRevisionList.php.

References Title\castFromPageIdentity(), and StatusValue\newGood().

◆ doQuery()

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

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 120 of file RevDelRevisionList.php.

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

◆ getCurrent()

RevDelRevisionList::getCurrent ( )

Definition at line 217 of file RevDelRevisionList.php.

References $currentRevId, and DB_PRIMARY.

◆ 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 93 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 97 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 101 of file RevDelRevisionList.php.

◆ getSuppressBit()

RevDelRevisionList::getSuppressBit ( )

Get the integer value of the flag used for suppression.

Reimplemented from RevDelList.

Definition at line 230 of file RevDelRevisionList.php.

◆ getType()

RevDelRevisionList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
string|null

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 89 of file RevDelRevisionList.php.

◆ newItem()

RevDelRevisionList::newItem (   $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchiveList.

Definition at line 206 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 105 of file RevDelRevisionList.php.

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

Member Data Documentation

◆ $currentRevId

int RevDelRevisionList::$currentRevId

Definition at line 59 of file RevDelRevisionList.php.

Referenced by getCurrent().


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