RevDelArchivedFileItem Class Reference

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

Inheritance diagram for RevDelArchivedFileItem:

Collaboration diagram for RevDelArchivedFileItem:

Public Member Functions
	__construct ( $list, $row)
	getApiData (ApiResult $result)
	Get the return information about the revision for the API.
	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 RevDelFileItem
	canView ()
	Returns true if the current user can view the item.
	canViewContent ()
	Returns true if the current user can view the item text/file.
	getBits ()
	Get the current deletion bitfield value.
	getHTML ()
	Get the HTML of the list item.
	isDeleted ()
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.
Public Member Functions inherited from RevisionItemBase
	formatDate ()
	Get the date, formatted in user's language.
	formatTime ()
	Get the time, formatted in user's language.
	getAuthorId ()
	Get the author user ID.
	getAuthorName ()
	Get the author user name.
	getTimestamp ()
	Get the timestamp in MW 14-char form.

Protected Member Functions
	getLink ()
	Get the link to the file.
Protected Member Functions inherited from RevDelFileItem
	getComment ()
	Wrap and format the file's comment block, if the current user is allowed to view it.
	getUserTools ()
	Generate a user tool link cluster if the current user is allowed to view it.

Additional Inherited Members
Public Attributes inherited from RevDelFileItem
File	$file
Protected Attributes inherited from RevisionItemBase
RevisionListBase	$list
	The parent.
	$row
	The database result row.

Detailed Description

Item class for a filearchive table row.

Definition at line 25 of file RevDelArchivedFileItem.php.

Constructor & Destructor Documentation

__construct()

RevDelArchivedFileItem::__construct	(		$list,
			$row
	)

Parameters

RevisionListBase	$list
object	$row	DB result row

Reimplemented from RevDelFileItem.

Definition at line 26 of file RevDelArchivedFileItem.php.

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

Member Function Documentation

getApiData()

RevDelArchivedFileItem::getApiData

(

ApiResult

$result

)

Get the return information about the revision for the API.

Since

1.23

Parameters

ApiResult

$result

API result object

Returns

array Data for the API result

Reimplemented from RevDelFileItem.

Definition at line 90 of file RevDelArchivedFileItem.php.

References RevDelFileItem\$file, $ret, $user, RevDelFileItem\canViewContent(), Revision\DELETED_COMMENT, Revision\DELETED_USER, File\getHeight(), File\getSize(), File\getTimestamp(), SpecialPage\getTitleFor(), File\getUser(), File\getWidth(), File\isDeleted(), RevDelFileItem\isDeleted(), list, PROTO_RELATIVE, TS_ISO_8601, File\userCan(), and wfTimestamp().

getAuthorIdField()

RevDelArchivedFileItem::getAuthorIdField

(

)

Get the DB field name storing user ids.

Override this function.

Returns

bool

Reimplemented from RevDelFileItem.

Definition at line 39 of file RevDelArchivedFileItem.php.

getAuthorNameField()

RevDelArchivedFileItem::getAuthorNameField

(

)

Get the DB field name storing user names.

Override this function.

Returns

bool

Reimplemented from RevDelFileItem.

Definition at line 43 of file RevDelArchivedFileItem.php.

getId()

RevDelArchivedFileItem::getId

(

)

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

Returns

int

Reimplemented from RevDelFileItem.

Definition at line 47 of file RevDelArchivedFileItem.php.

References row().

getIdField()

RevDelArchivedFileItem::getIdField

(

)

Get the DB field name associated with the ID list.

Override this function.

Returns

null

Reimplemented from RevDelFileItem.

Definition at line 31 of file RevDelArchivedFileItem.php.

getLink()

RevDelArchivedFileItem::getLink ( )

protected

Get the link to the file.

Overridden by RevDelArchivedFileItem.

Returns

string

Reimplemented from RevDelFileItem.

Definition at line 65 of file RevDelArchivedFileItem.php.

References $link, RevDelFileItem\canViewContent(), file, SpecialPage\getTitleFor(), RevDelFileItem\isDeleted(), Linker\link(), and list.

getTimestampField()

RevDelArchivedFileItem::getTimestampField

(

)

Get the DB field name storing timestamps.

Override this function.

Returns

bool

Reimplemented from RevDelFileItem.

Definition at line 35 of file RevDelArchivedFileItem.php.

setBits()

RevDelArchivedFileItem::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 RevDelFileItem.

Definition at line 51 of file RevDelArchivedFileItem.php.

References DB_MASTER, row(), and wfGetDB().

---

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

• includes/revisiondelete/RevDelArchivedFileItem.php