RevDelArchiveItem Class Reference

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

Inherits RevDelRevisionItem.

Inherited by RevDelArchivedRevisionItem.

Collaboration diagram for RevDelArchiveItem:

Public Member Functions
	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
	__construct (RevisionListBase $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.
	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 RevDelRevisionItem
	getRevisionRecord ()
	Get the RevisionRecord for the item.
Protected Member Functions inherited from RevisionItemBase
	getLinkRenderer ()
	Returns an instance of LinkRenderer.

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

Additional Inherited Members
Public Attributes inherited from RevDelRevisionItem
RevisionRecord	$revisionRecord
Protected Attributes inherited from RevisionItemBase
RevisionListBase	$list
	The parent.
stdClass	$row
	The database result row.

Detailed Description

Item class for a archive table row.

Definition at line 28 of file RevDelArchiveItem.php.

Member Function Documentation

getAuthorActorField()

RevDelArchiveItem::getAuthorActorField

(

)

Get the DB field name storing actor ids.

Override this function.

Since

1.31

Returns

string|false

Reimplemented from RevDelRevisionItem.

Definition at line 58 of file RevDelArchiveItem.php.

getAuthorIdField()

RevDelArchiveItem::getAuthorIdField

(

)

Get the DB field name storing user ids.

Override this function.

Returns

string|false

Reimplemented from RevDelRevisionItem.

Definition at line 50 of file RevDelArchiveItem.php.

getAuthorNameField()

RevDelArchiveItem::getAuthorNameField

(

)

Get the DB field name storing user names.

Override this function.

Returns

string|false

Reimplemented from RevDelRevisionItem.

Definition at line 54 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 104 of file RevDelArchiveItem.php.

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

getId()

RevDelArchiveItem::getId

(

)

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

Returns

int|string

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 62 of file RevDelArchiveItem.php.

getIdField()

RevDelArchiveItem::getIdField

(

)

Get the DB field name associated with the ID list.

Override this function.

Returns

string|null

Reimplemented from RevDelRevisionItem.

Reimplemented in RevDelArchivedRevisionItem.

Definition at line 42 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 85 of file RevDelArchiveItem.php.

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

getTimestampField()

RevDelArchiveItem::getTimestampField

(

)

Get the DB field name storing timestamps.

Override this function.

Returns

string|false

Reimplemented from RevDelRevisionItem.

Definition at line 46 of file RevDelArchiveItem.php.

initRevisionRecord()

static RevDelArchiveItem::initRevisionRecord ( $list, $row )

staticprotected

Create RevisionRecord object from $row sourced from $list.

Parameters

RevisionListBase	$list
mixed	$row

Returns

RevisionRecord

Reimplemented from RevDelRevisionItem.

Definition at line 29 of file RevDelArchiveItem.php.

References RevisionItemBase\$list, RevisionItemBase\$row, and RevisionListBase\getPage().

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 67 of file RevDelArchiveItem.php.

---

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

• includes/revisiondelete/RevDelArchiveItem.php