MediaWiki master
RevDelArchiveList Class Reference

List for archive table items, i.e. More...

Inherits RevDelRevisionList.

Collaboration diagram for RevDelArchiveList:

Public Member Functions

 __construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory, HookContainer $hookContainer, HTMLCacheUpdater $htmlCacheUpdater, RevisionStore $revisionStore)
 
 doPostCommitUpdates (array $visibilityChangeMap)
 A hook for setVisibility(): do any necessary updates post-commit.
 
 doPreCommitUpdates ()
 A hook for setVisibility(): do batch updates pre-commit.
 
 doQuery ( $db)
 
 getType ()
 Get the internal type name of this list.
 
 newItem ( $row)
 Create an item object from a DB result row.
 
- Public Member Functions inherited from RevDelRevisionList
 getCurrent ()
 
- 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.
 
 clearFileOps ()
 Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.
 
 getLogAction ()
 Get the log action for this list type.
 
 getLogParams ( $params)
 Get log parameter array.
 
 reloadFromPrimary ()
 Reload the list data from the primary DB.
 
 setVisibility (array $params)
 Set the visibility for the revisions in this list.
 
- Public Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
 __construct (IContextSource $context, PageIdentity $page)
 Construct a revision list for a given page identity.
 
 current ()
 Get the current list item, or false if we are at the end.
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values.
 
 getPage ()
 
 getPageName ()
 
 key ()
 
 length ()
 Get the number of items in the list.
 
 next ()
 Move the iteration pointer to the next list item, and return it.
 
 reset ()
 Start iteration.
 
 rewind ()
 
 valid ()
 
- Public Member Functions inherited from MediaWiki\Context\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.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getLanguageCode ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Static Public Member Functions

static getRelationType ()
 Get the DB field name associated with the ID list.
 
- Static Public Member Functions inherited from RevDelRevisionList
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.
 

Additional Inherited Members

- Public Attributes inherited from RevDelRevisionList
int $currentRevId
 
- Protected Member Functions inherited from RevDelList
 acquireItemLocks ()
 
 releaseItemLocks ()
 
- Protected Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer.
 
- Protected Attributes inherited from RevDelList
const SUPPRESS_BIT = RevisionRecord::DELETED_RESTRICTED
 Flag used for suppression, depending on the type of log.
 
- Protected Attributes inherited from MediaWiki\RevisionList\RevisionListBase
RevisionItemBase false $current
 
int[] null $ids
 
PageIdentity $page
 
IResultWrapper false $res
 

Detailed Description

List for archive table items, i.e.

revisions deleted via action=delete

Definition at line 36 of file RevDelArchiveList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelArchiveList::__construct ( IContextSource $context,
PageIdentity $page,
array $ids,
LBFactory $lbFactory,
HookContainer $hookContainer,
HTMLCacheUpdater $htmlCacheUpdater,
RevisionStore $revisionStore )
Parameters
IContextSource$context
PageIdentity$page
array$ids
LBFactory$lbFactory
HookContainer$hookContainer
HTMLCacheUpdater$htmlCacheUpdater
RevisionStore$revisionStore

Reimplemented from RevDelRevisionList.

Definition at line 50 of file RevDelArchiveList.php.

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

Member Function Documentation

◆ doPostCommitUpdates()

RevDelArchiveList::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 RevDelRevisionList.

Definition at line 111 of file RevDelArchiveList.php.

◆ doPreCommitUpdates()

RevDelArchiveList::doPreCommitUpdates ( )

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

STUB

Returns
Status

Reimplemented from RevDelRevisionList.

Definition at line 107 of file RevDelArchiveList.php.

◆ doQuery()

RevDelArchiveList::doQuery ( $db)
Parameters
\\Wikimedia\\Rdbms\\IReadableDatabase$db
Returns
IResultWrapper

Reimplemented from RevDelRevisionList.

Definition at line 83 of file RevDelArchiveList.php.

References MediaWiki\RevisionList\RevisionListBase\getPage().

◆ getRelationType()

static RevDelArchiveList::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 RevDelRevisionList.

Definition at line 75 of file RevDelArchiveList.php.

◆ getType()

RevDelArchiveList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
string|null

Reimplemented from RevDelRevisionList.

Definition at line 71 of file RevDelArchiveList.php.

◆ newItem()

RevDelArchiveList::newItem ( $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from RevDelRevisionList.

Definition at line 103 of file RevDelArchiveList.php.


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