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

Collaboration diagram for RevDelLogItem:

[legend]

Public Member Functions
	__construct (RevisionListBase $list, $row, CommentStore $commentStore, IConnectionProvider $dbProvider)

	canView ()
	Returns true if the current user can view the item.

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

	getApiData (ApiResult $result)
	Get the return information about the revision for the API.

	getAuthorActorField ()
	Get the DB field name storing actor ids.

	getAuthorIdField ()
	Get the DB field name storing user ids.

	getAuthorNameField ()
	Get the DB field name storing user names.

	getBits ()
	Get the current deletion bitfield value.

	getHTML ()
	Get the HTML of the list item.

	getIdField ()
	Get the DB field name associated with the ID list.

	getTimestampField ()
	Get the DB field name storing timestamps.

	setBits ( $bits)
	Set the visibility of the item.

Public Member Functions inherited from 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 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 RevisionItemBase
	getLinkRenderer ()
	Returns an instance of LinkRenderer.

Protected Attributes inherited from RevisionItemBase
RevisionListBase	$list
	The parent.

stdClass	$row
	The database result row.

Detailed Description

Item class for a logging table row.

Definition at line 30 of file RevDelLogItem.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelLogItem::__construct	(	RevisionListBase	$list,
			$row,
		CommentStore	$commentStore,
		IConnectionProvider	$dbProvider )

Parameters

RevisionListBase	$list
stdClass	$row	DB result row
CommentStore	$commentStore
IConnectionProvider	$dbProvider

Definition at line 42 of file RevDelLogItem.php.

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

Member Function Documentation

◆ canView()

RevDelLogItem::canView ( )

Returns true if the current user can view the item.

Returns: bool

Reimplemented from RevisionItemBase.

Definition at line 73 of file RevDelLogItem.php.

◆ canViewContent()

RevDelLogItem::canViewContent ( )

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

Returns: bool

Reimplemented from RevisionItemBase.

Definition at line 79 of file RevDelLogItem.php.

◆ getApiData()

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 RevDelItem.

Definition at line 155 of file RevDelLogItem.php.

◆ getAuthorActorField()

RevDelLogItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since: 1.31

Returns: string|false

Reimplemented from RevisionItemBase.

Definition at line 69 of file RevDelLogItem.php.

◆ getAuthorIdField()

RevDelLogItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns: string|false

Reimplemented from RevisionItemBase.

Definition at line 61 of file RevDelLogItem.php.

◆ getAuthorNameField()

RevDelLogItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns: string|false

Reimplemented from RevisionItemBase.

Definition at line 65 of file RevDelLogItem.php.

◆ getBits()

RevDelLogItem::getBits ( )

Get the current deletion bitfield value.

Returns: int

Reimplemented from RevDelItem.

Definition at line 83 of file RevDelLogItem.php.

◆ getHTML()

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 RevisionItemBase.

Definition at line 119 of file RevDelLogItem.php.

References ChangeTags\formatSummaryRow(), and RevisionItemBase\getLinkRenderer().

◆ getIdField()

RevDelLogItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns: string|null

Reimplemented from RevisionItemBase.

Definition at line 53 of file RevDelLogItem.php.

◆ getTimestampField()

RevDelLogItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns: string|false

Reimplemented from RevisionItemBase.

Definition at line 57 of file RevDelLogItem.php.

◆ setBits()

RevDelLogItem::setBits ( $newBits )

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 RevDelItem.

Definition at line 87 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()