MediaWiki\RevisionDelete\RevDelItem Class Reference

Abstract base class for deletable items. More...

Inherits MediaWiki\RevisionList\RevisionItemBase.

Inherited by MediaWiki\RevisionDelete\RevDelFileItem, MediaWiki\RevisionDelete\RevDelLogItem, and MediaWiki\RevisionDelete\RevDelRevisionItem.

Collaboration diagram for MediaWiki\RevisionDelete\RevDelItem:

Public Member Functions
	getApiData (ApiResult $result)
	Get the return information about the revision for the API.
	getBits ()
	Get the current deletion bitfield value.
	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.
	setBits ( $newBits)
	Set the visibility of the item.
	unlock ()
	Unlock the item against changes outside of the DB.
Public Member Functions inherited from MediaWiki\RevisionList\RevisionItemBase
	__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.
	formatDate ()
	Get the date, formatted in user's language.
	formatTime ()
	Get the time, formatted in user's language.
	getAuthorActor ()
	Get the author actor ID.
	getAuthorActorField ()
	Get the DB field name storing actor ids.
	getAuthorId ()
	Get the author user ID.
	getAuthorIdField ()
	Get the DB field name storing user ids.
	getAuthorName ()
	Get the author user name.
	getAuthorNameField ()
	Get the DB field name storing user names.
	getHTML ()
	Get the HTML of the list item.
	getId ()
	Get the ID, as it would appear in the ids URL parameter.
	getIdField ()
	Get the DB field name associated with the ID list.
	getTimestamp ()
	Get the timestamp in MW 14-char form.
	getTimestampField ()
	Get the DB field name storing timestamps.

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

Abstract base class for deletable items.

Definition at line 17 of file RevDelItem.php.

Member Function Documentation

getApiData()

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

abstract

Get the return information about the revision for the API.

Since

1.23

Parameters

ApiResult

$result

Returns

array Data for the API result

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedFileItem, MediaWiki\RevisionDelete\RevDelFileItem, MediaWiki\RevisionDelete\RevDelLogItem, and MediaWiki\RevisionDelete\RevDelRevisionItem.

getBits()

MediaWiki\RevisionDelete\RevDelItem::getBits ( )

abstract

Get the current deletion bitfield value.

Returns

int

Reimplemented in MediaWiki\RevisionDelete\RevDelFileItem, MediaWiki\RevisionDelete\RevDelLogItem, and MediaWiki\RevisionDelete\RevDelRevisionItem.

isHideCurrentOp()

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.

Parameters

int

$newBits

Returns

bool

Reimplemented in MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 25 of file RevDelItem.php.

lock()

MediaWiki\RevisionDelete\RevDelItem::lock

(

)

Lock the item against changes outside of the DB.

Returns

Status

Since

1.28

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedFileItem, and MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 62 of file RevDelItem.php.

setBits()

MediaWiki\RevisionDelete\RevDelItem::setBits ( $newBits )

abstract

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 in MediaWiki\RevisionDelete\RevDelArchivedFileItem, MediaWiki\RevisionDelete\RevDelArchivedRevisionItem, MediaWiki\RevisionDelete\RevDelArchiveItem, MediaWiki\RevisionDelete\RevDelFileItem, MediaWiki\RevisionDelete\RevDelLogItem, and MediaWiki\RevisionDelete\RevDelRevisionItem.

unlock()

MediaWiki\RevisionDelete\RevDelItem::unlock

(

)

Unlock the item against changes outside of the DB.

Returns

Status

Since

1.28

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedFileItem, and MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 71 of file RevDelItem.php.

---

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

• includes/RevisionDelete/RevDelItem.php