Item class for a live revision table row. More...

Inheritance diagram for RevDelRevisionItem:

[legend]

Collaboration diagram for RevDelRevisionItem:

[legend]

Public Member Functions
	__construct ( $list, $row)

	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 ()

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

	getTags ()

	getTimestampField ()
	Get the DB field name storing timestamps.

	isDeleted ()

	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.

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

Public Member Functions inherited from RevDelItem
	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
	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.

Public Attributes
Revision	$revision

Protected Member Functions
	getDiffLink ()
	Get the HTML link to the diff.

	getRevisionLink ()
	Get the HTML link to the revision text.

Protected Member Functions inherited from RevisionItemBase
	getLinkRenderer ()
	Returns an instance of LinkRenderer.

Static Protected Member Functions
static	initRevision ( $list, $row)
	Create revision object from $row sourced from $list.

Additional Inherited Members
Protected Attributes inherited from RevisionItemBase
RevisionListBase	$list
	The parent.

	$row
	The database result row.

Detailed Description

Item class for a live revision table row.

Definition at line 25 of file RevDelRevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelRevisionItem::__construct	(		$list,
			$row )

Parameters

RevisionListBase	$list
object	$row	DB result row

Reimplemented from RevisionItemBase.

Definition at line 29 of file RevDelRevisionItem.php.

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

Member Function Documentation

◆ canView()

RevDelRevisionItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 65 of file RevDelRevisionItem.php.

References Revision\DELETED_RESTRICTED, and list.

◆ canViewContent()

RevDelRevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 69 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, and list.

Referenced by RevDelArchiveItem\getDiffLink(), getDiffLink(), RevDelArchiveItem\getRevisionLink(), and getRevisionLink().

◆ getApiData()

RevDelRevisionItem::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 200 of file RevDelRevisionItem.php.

References $ret, $rev, $revision, Revision\DELETED_COMMENT, Revision\DELETED_TEXT, Revision\DELETED_USER, Revision\FOR_THIS_USER, list, and wfTimestamp().

◆ getAuthorActorField()

RevDelRevisionItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since: 1.31

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 61 of file RevDelRevisionItem.php.

◆ getAuthorIdField()

RevDelRevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 53 of file RevDelRevisionItem.php.

◆ getAuthorNameField()

RevDelRevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 57 of file RevDelRevisionItem.php.

◆ getBits()

RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Returns: int

Reimplemented from RevDelItem.

Definition at line 73 of file RevDelRevisionItem.php.

◆ getDiffLink()

RevDelRevisionItem::getDiffLink ( )

protected

Get the HTML link to the diff.

Overridden by RevDelArchiveItem

Returns: string

Reimplemented in RevDelArchiveItem.

Definition at line 148 of file RevDelRevisionItem.php.

References canViewContent(), RevisionItemBase\getLinkRenderer(), isDeleted(), and list.

Referenced by getHTML().

◆ getHTML()

RevDelRevisionItem::getHTML ( )

Returns: string A HTML element representing this revision, showing change tags and everything

Reimplemented from RevisionItemBase.

Definition at line 169 of file RevDelRevisionItem.php.

References $attribs, $content, getDiffLink(), getRevisionLink(), getTags(), isDeleted(), list, Linker\revComment(), and Linker\revUserLink().

◆ getIdField()

RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns: null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 45 of file RevDelRevisionItem.php.

◆ getRevisionLink()

RevDelRevisionItem::getRevisionLink ( )

protected

Get the HTML link to the revision text.

Overridden by RevDelArchiveItem.

Returns: string

Reimplemented in RevDelArchiveItem.

Definition at line 124 of file RevDelRevisionItem.php.

References canViewContent(), RevisionItemBase\getLinkRenderer(), isDeleted(), and list.

Referenced by getHTML().

◆ getTags()

RevDelRevisionItem::getTags ( )

Returns: string Comma-separated list of tags

Definition at line 196 of file RevDelRevisionItem.php.

Referenced by getHTML().

◆ getTimestampField()

RevDelRevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 49 of file RevDelRevisionItem.php.

◆ initRevision()

static RevDelRevisionItem::initRevision	(		$list,
			$row )

staticprotected

Create revision object from $row sourced from $list.

Parameters

RevisionListBase	$list
mixed	$row

Returns: Revision

Reimplemented in RevDelArchiveItem.

Definition at line 41 of file RevDelRevisionItem.php.

References RevisionItemBase\$row.

◆ isDeleted()

RevDelRevisionItem::isDeleted ( )

Definition at line 110 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT.

Referenced by RevDelArchiveItem\getDiffLink(), getDiffLink(), getHTML(), RevDelArchiveItem\getRevisionLink(), and getRevisionLink().

◆ isHideCurrentOp()

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

Parameters

int $newBits

Returns: bool

Reimplemented from RevDelItem.

Definition at line 114 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, RevisionItemBase\getId(), and list.

◆ setBits()

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

Reimplemented in RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 77 of file RevDelRevisionItem.php.

References DB_MASTER, and wfGetDB().

Member Data Documentation

◆ $revision

Revision RevDelRevisionItem::$revision

Definition at line 27 of file RevDelRevisionItem.php.

Referenced by getApiData().

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

includes/revisiondelete/RevDelRevisionItem.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canView()

◆ canViewContent()

◆ getApiData()

◆ getAuthorActorField()

◆ getAuthorIdField()

◆ getAuthorNameField()

◆ getBits()

◆ getDiffLink()

◆ getHTML()

◆ getIdField()

◆ getRevisionLink()

◆ getTags()

◆ getTimestampField()

◆ initRevision()

◆ isDeleted()

◆ isHideCurrentOp()

◆ setBits()

Member Data Documentation

◆ $revision