MediaWiki  master
RevDelFileList Class Reference

List for oldimage table items. More...

Inheritance diagram for RevDelFileList:
Collaboration diagram for RevDelFileList:

Public Member Functions

 __construct (IContextSource $context, PageIdentity $page, array $ids, LBFactory $lbFactory, HtmlCacheUpdater $htmlCacheUpdater, RepoGroup $repoGroup)
 
 clearFileOps ()
 Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB. More...
 
 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)
 
 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...
 
 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 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...
 
 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...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 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 Public Member Functions inherited from RevDelList
static suggestTarget ( $target, array $ids)
 Suggest a target for the revision deletion Optionally override this function. More...
 

Public Attributes

array $cleanupBatch
 
array $deleteBatch
 
array $storeBatch
 

Private Attributes

HtmlCacheUpdater $htmlCacheUpdater
 
RepoGroup $repoGroup
 

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
 
IResultWrapper false $res
 
Title $title
 

Detailed Description

List for oldimage table items.

Definition at line 29 of file RevDelFileList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelFileList::__construct ( IContextSource  $context,
PageIdentity  $page,
array  $ids,
LBFactory  $lbFactory,
HtmlCacheUpdater  $htmlCacheUpdater,
RepoGroup  $repoGroup 
)
Parameters
IContextSource$context
PageIdentity$page
array$ids
LBFactory$lbFactory
HtmlCacheUpdater$htmlCacheUpdater
RepoGroup$repoGroup

Reimplemented in RevDelArchivedFileList.

Definition at line 54 of file RevDelFileList.php.

References ContextSource\$context, $htmlCacheUpdater, RevisionListBase\$ids, RevDelList\$lbFactory, and $repoGroup.

Member Function Documentation

◆ clearFileOps()

RevDelFileList::clearFileOps ( )

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

Reimplemented from RevDelList.

Definition at line 111 of file RevDelFileList.php.

◆ doPostCommitUpdates()

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

Definition at line 141 of file RevDelFileList.php.

References $file, and StatusValue\newGood().

◆ doPreCommitUpdates()

RevDelFileList::doPreCommitUpdates ( )

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

STUB

Returns
Status

Reimplemented from RevDelList.

Definition at line 117 of file RevDelFileList.php.

References StatusValue\newGood(), and FileRepo\OVERWRITE_SAME.

◆ doQuery()

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

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchivedFileList.

Definition at line 87 of file RevDelFileList.php.

References OldLocalFile\getQueryInfo().

◆ getRelationType()

static RevDelFileList::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 RevDelArchivedFileList.

Definition at line 71 of file RevDelFileList.php.

◆ getRestriction()

static RevDelFileList::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 75 of file RevDelFileList.php.

◆ getRevdelConstant()

static RevDelFileList::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 79 of file RevDelFileList.php.

References File\DELETED_FILE.

◆ getSuppressBit()

RevDelFileList::getSuppressBit ( )

Get the integer value of the flag used for suppression.

Reimplemented from RevDelList.

Definition at line 162 of file RevDelFileList.php.

References File\DELETED_RESTRICTED.

◆ getType()

RevDelFileList::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 RevDelArchivedFileList.

Definition at line 67 of file RevDelFileList.php.

◆ newItem()

RevDelFileList::newItem (   $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from RevisionListBase.

Reimplemented in RevDelArchivedFileList.

Definition at line 107 of file RevDelFileList.php.

Member Data Documentation

◆ $cleanupBatch

array RevDelFileList::$cleanupBatch

Definition at line 44 of file RevDelFileList.php.

◆ $deleteBatch

array RevDelFileList::$deleteBatch

Definition at line 41 of file RevDelFileList.php.

◆ $htmlCacheUpdater

HtmlCacheUpdater RevDelFileList::$htmlCacheUpdater
private

Definition at line 32 of file RevDelFileList.php.

Referenced by RevDelArchivedFileList\__construct(), and __construct().

◆ $repoGroup

RepoGroup RevDelFileList::$repoGroup
private

Definition at line 35 of file RevDelFileList.php.

Referenced by RevDelArchivedFileList\__construct(), and __construct().

◆ $storeBatch

array RevDelFileList::$storeBatch

Definition at line 38 of file RevDelFileList.php.


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