MediaWiki  master
RevDelLogList Class Reference

List for logging table items. More...

Inheritance diagram for RevDelLogList:
Collaboration diagram for RevDelLogList:

Public Member Functions

 __construct (IContextSource $context, Title $title, array $ids, LBFactory $lbFactory, ActorMigration $actorMigration, CommentStore $commentStore)
 
 doQuery ( $db)
 
 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...
 
 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, 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...
 
 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...
 
 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...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 Stable to override. 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...
 

Private Attributes

ActorMigration $actorMigration
 
CommentStore $commentStore
 

Additional Inherited Members

- Public Attributes inherited from RevisionListBase
Title $title
 
- 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
 

Detailed Description

List for logging table items.

Definition at line 29 of file RevDelLogList.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelLogList::__construct ( IContextSource  $context,
Title  $title,
array  $ids,
LBFactory  $lbFactory,
ActorMigration  $actorMigration,
CommentStore  $commentStore 
)
Parameters
IContextSource$context
Title$title
array$ids
LBFactory$lbFactory
ActorMigration$actorMigration
CommentStore$commentStore

Definition at line 45 of file RevDelLogList.php.

References $actorMigration, $commentStore, ContextSource\$context, RevisionListBase\$ids, RevDelList\$lbFactory, and RevisionListBase\$title.

Member Function Documentation

◆ doQuery()

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

Reimplemented from RevisionListBase.

Definition at line 93 of file RevDelLogList.php.

References RevisionListBase\$ids.

◆ getLogAction()

RevDelLogList::getLogAction ( )

Get the log action for this list type.

Returns
string

Reimplemented from RevDelList.

Definition at line 127 of file RevDelLogList.php.

◆ getLogParams()

RevDelLogList::getLogParams (   $params)

Get log parameter array.

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

Reimplemented from RevDelList.

Definition at line 131 of file RevDelLogList.php.

◆ getRelationType()

static RevDelLogList::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.

Definition at line 62 of file RevDelLogList.php.

◆ getRestriction()

static RevDelLogList::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 66 of file RevDelLogList.php.

◆ getRevdelConstant()

static RevDelLogList::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 70 of file RevDelLogList.php.

References LogPage\DELETED_ACTION.

◆ getSuppressBit()

RevDelLogList::getSuppressBit ( )

Get the integer value of the flag used for suppression.

Reimplemented from RevDelList.

Definition at line 123 of file RevDelLogList.php.

◆ getType()

RevDelLogList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
string|null

Reimplemented from RevisionListBase.

Definition at line 58 of file RevDelLogList.php.

◆ newItem()

RevDelLogList::newItem (   $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from RevisionListBase.

Definition at line 119 of file RevDelLogList.php.

◆ suggestTarget()

static RevDelLogList::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 74 of file RevDelLogList.php.

References RevisionListBase\$ids, DB_REPLICA, SpecialPage\getTitleFor(), and wfGetDB().

Referenced by ChangeTags\updateTagsWithChecks().

Member Data Documentation

◆ $actorMigration

ActorMigration RevDelLogList::$actorMigration
private

Definition at line 32 of file RevDelLogList.php.

Referenced by __construct().

◆ $commentStore

CommentStore RevDelLogList::$commentStore
private

Definition at line 35 of file RevDelLogList.php.

Referenced by __construct().


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