RevDelArchiveItem Class Reference

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

Inheritance diagram for RevDelArchiveItem:

Collaboration diagram for RevDelArchiveItem:

Public Member Functions
	__construct ( $list, $row)
	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.
	getId ()
	Get the ID, as it would appear in the ids URL parameter.
	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 RevDelRevisionItem
	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.
	getBits ()
	Get the current deletion bitfield value.
	getHTML ()
	getTags ()
	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.
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.
	getTimestamp ()
	Get the timestamp in MW 14-char form.

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.

Additional Inherited Members
Public Attributes inherited from RevDelRevisionItem
Revision	$revision
Protected Attributes inherited from RevisionItemBase
RevisionListBase	$list
	The parent.
	$row
	The database result row.

Detailed Description

Item class for a archive table row.

Definition at line 25 of file RevDelArchiveItem.php.

Constructor & Destructor Documentation

__construct()

RevDelArchiveItem::__construct	(		$list,
			$row )

Parameters

RevisionListBase	$list
object	$row	DB result row

Reimplemented from RevDelRevisionItem.

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 26 of file RevDelArchiveItem.php.

References RevisionItemBase\$list, RevisionItemBase\$row, RevisionItemBase\__construct(), and list.

Member Function Documentation

getAuthorActorField()

RevDelArchiveItem::getAuthorActorField

(

)

Get the DB field name storing actor ids.

Override this function.

Since

1.31

Returns

bool

Reimplemented from RevDelRevisionItem.

Definition at line 48 of file RevDelArchiveItem.php.

getAuthorIdField()

RevDelArchiveItem::getAuthorIdField

(

)

Get the DB field name storing user ids.

Override this function.

Returns

bool

Reimplemented from RevDelRevisionItem.

Definition at line 40 of file RevDelArchiveItem.php.

getAuthorNameField()

RevDelArchiveItem::getAuthorNameField

(

)

Get the DB field name storing user names.

Override this function.

Returns

bool

Reimplemented from RevDelRevisionItem.

Definition at line 44 of file RevDelArchiveItem.php.

getDiffLink()

RevDelArchiveItem::getDiffLink ( )

protected

Get the HTML link to the diff.

Overridden by RevDelArchiveItem

Returns

string

Reimplemented from RevDelRevisionItem.

Definition at line 93 of file RevDelArchiveItem.php.

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

getId()

RevDelArchiveItem::getId

(

)

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

Returns

int

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 52 of file RevDelArchiveItem.php.

getIdField()

RevDelArchiveItem::getIdField

(

)

Get the DB field name associated with the ID list.

Override this function.

Returns

null

Reimplemented from RevDelRevisionItem.

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 32 of file RevDelArchiveItem.php.

getRevisionLink()

RevDelArchiveItem::getRevisionLink ( )

protected

Get the HTML link to the revision text.

Overridden by RevDelArchiveItem.

Returns

string

Reimplemented from RevDelRevisionItem.

Definition at line 74 of file RevDelArchiveItem.php.

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

getTimestampField()

RevDelArchiveItem::getTimestampField

(

)

Get the DB field name storing timestamps.

Override this function.

Returns

bool

Reimplemented from RevDelRevisionItem.

Definition at line 36 of file RevDelArchiveItem.php.

setBits()

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

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 57 of file RevDelArchiveItem.php.

References DB_MASTER, list, and wfGetDB().

---

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

• includes/revisiondelete/RevDelArchiveItem.php