Item class for a logging table row. More...

Inherits MediaWiki\RevisionDelete\RevDelItem.

Collaboration diagram for MediaWiki\RevisionDelete\RevDelLogItem:

[legend]

Public Member Functions

__construct (RevisionListBase $list, $row, private readonly CommentStore $commentStore, private readonly IConnectionProvider $dbProvider, private readonly LogFormatterFactory $logFormatterFactory, private readonly ChangeTagsFormatter $changeTagsFormatter,)

canView ()

Returns true if the current user can view the item.

Returns: bool

canViewContent ()

Returns true if the current user can view the item text/file.

Returns: bool

getApiData (ApiResult $result)

Get the return information about the revision for the API.

Since: 1.23

Parameters

ApiResult $result

Returns: array Data for the API result

getAuthorActorField ()

Get the DB field name storing actor ids.Override this function.

Since: 1.31

Returns: string|false

getAuthorIdField ()

Get the DB field name storing user ids.Override this function.

Returns: string|false

getAuthorNameField ()

Get the DB field name storing user names.Override this function.

Returns: string|false

getBits ()

Get the current deletion bitfield value.

Returns: int

getHTML ()

Get the HTML of the list item.Should be include "<li></li>" tags. This is used to show the list in HTML form, by the special page.

Returns: string HTML

getIdField ()

Get the DB field name associated with the ID list.Override this function.

Returns: string|null

getTimestampField ()

Get the DB field name storing timestamps.Override this function.

Returns: string|false

setBits ( $bits)

Set the visibility of the item.This should do any necessary DB queries.The DB update query should have a condition which forces it to only update if the value in the DB matches the value fetched earlier with the SELECT. If the update fails because it did not match, the function should return false. This prevents concurrency problems.

Parameters

int $newBits

Returns: bool Success

Public Member Functions inherited from MediaWiki\RevisionDelete\RevDelItem

isHideCurrentOp ( $newBits)

Returns true if the item is "current", and the operation to set the given bits can't be executed for that reason STUB.

lock ()

Lock the item against changes outside of the DB.

unlock ()

Unlock the item against changes outside of the DB.

Public Member Functions inherited from MediaWiki\RevisionList\RevisionItemBase

__construct (RevisionListBase $list, $row)

formatDate ()

Get the date, formatted in user's language.

formatTime ()

Get the time, formatted in user's language.

getAuthorActor ()

Get the author actor ID.

getAuthorId ()

Get the author user ID.

getAuthorName ()

Get the author user name.

getId ()

Get the ID, as it would appear in the ids URL parameter.

getTimestamp ()

Get the timestamp in MW 14-char form.

Additional Inherited Members
Protected Member Functions inherited from MediaWiki\RevisionList\RevisionItemBase
	getLinkRenderer ()
	Returns an instance of LinkRenderer.

Protected Attributes inherited from MediaWiki\RevisionList\RevisionItemBase
RevisionListBase	$list
	The parent.

stdClass	$row
	The database result row.

Detailed Description

Item class for a logging table row.

Definition at line 29 of file RevDelLogItem.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RevisionDelete\RevDelLogItem::__construct	(	RevisionListBase	$list,
			$row,
		private readonly CommentStore	$commentStore,
		private readonly IConnectionProvider	$dbProvider,
		private readonly LogFormatterFactory	$logFormatterFactory,
		private readonly ChangeTagsFormatter	$changeTagsFormatter )

Parameters

RevisionListBase	$list
stdClass	$row	DB result row
CommentStore	$commentStore
IConnectionProvider	$dbProvider
LogFormatterFactory	$logFormatterFactory
ChangeTagsFormatter	$changeTagsFormatter

Definition at line 39 of file RevDelLogItem.php.

References MediaWiki\RevisionList\RevisionItemBase\$list, and MediaWiki\RevisionList\RevisionItemBase\$row.

Member Function Documentation

◆ canView()

MediaWiki\RevisionDelete\RevDelLogItem::canView ( )

Returns true if the current user can view the item.

Returns: bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 76 of file RevDelLogItem.php.

◆ canViewContent()

MediaWiki\RevisionDelete\RevDelLogItem::canViewContent ( )

Returns true if the current user can view the item text/file.

Returns: bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 83 of file RevDelLogItem.php.

◆ getApiData()

MediaWiki\RevisionDelete\RevDelLogItem::getApiData ( ApiResult $result )

Get the return information about the revision for the API.

Since: 1.23

Parameters

ApiResult $result

Returns: array Data for the API result

Reimplemented from MediaWiki\RevisionDelete\RevDelItem.

Definition at line 163 of file RevDelLogItem.php.

◆ getAuthorActorField()

MediaWiki\RevisionDelete\RevDelLogItem::getAuthorActorField ( )

Get the DB field name storing actor ids.Override this function.

Since: 1.31

Returns: string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 71 of file RevDelLogItem.php.

◆ getAuthorIdField()

MediaWiki\RevisionDelete\RevDelLogItem::getAuthorIdField ( )

Get the DB field name storing user ids.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 61 of file RevDelLogItem.php.

◆ getAuthorNameField()

MediaWiki\RevisionDelete\RevDelLogItem::getAuthorNameField ( )

Get the DB field name storing user names.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 66 of file RevDelLogItem.php.

◆ getBits()

MediaWiki\RevisionDelete\RevDelLogItem::getBits ( )

Get the current deletion bitfield value.

Returns: int

Reimplemented from MediaWiki\RevisionDelete\RevDelItem.

Definition at line 88 of file RevDelLogItem.php.

◆ getHTML()

MediaWiki\RevisionDelete\RevDelLogItem::getHTML ( )

Get the HTML of the list item.Should be include "<li></li>" tags. This is used to show the list in HTML form, by the special page.

Returns: string HTML

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 126 of file RevDelLogItem.php.

References MediaWiki\RevisionList\RevisionItemBase\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\makeTitle().

◆ getIdField()

MediaWiki\RevisionDelete\RevDelLogItem::getIdField ( )

Get the DB field name associated with the ID list.Override this function.

Returns: string|null

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 51 of file RevDelLogItem.php.

◆ getTimestampField()

MediaWiki\RevisionDelete\RevDelLogItem::getTimestampField ( )

Get the DB field name storing timestamps.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 56 of file RevDelLogItem.php.

◆ setBits()

MediaWiki\RevisionDelete\RevDelLogItem::setBits ( $bits )

Set the visibility of the item.This should do any necessary DB queries.The DB update query should have a condition which forces it to only update if the value in the DB matches the value fetched earlier with the SELECT. If the update fails because it did not match, the function should return false. This prevents concurrency problems.

Parameters

int $newBits

Returns: bool Success

Reimplemented from MediaWiki\RevisionDelete\RevDelItem.

Definition at line 93 of file RevDelLogItem.php.

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

includes/RevisionDelete/RevDelLogItem.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canView()

◆ canViewContent()

◆ getApiData()

◆ getAuthorActorField()

◆ getAuthorIdField()

◆ getAuthorNameField()

◆ getBits()

◆ getHTML()

◆ getIdField()

◆ getTimestampField()

◆ setBits()