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

Inheritance diagram for RevDelArchivedFileItem:

[legend]

Collaboration diagram for RevDelArchivedFileItem:

[legend]

Public Member Functions
	__construct ( $list, $row)

	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.

	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.

	lock ()
	Lock the item against changes outside of the DB.

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

	unlock ()
	Unlock the item against changes outside of the DB.

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.

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

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

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

Protected Attributes
LocalFile	$lockFile

Protected Attributes inherited from RevDelFileItem
OldLocalFile	$file

RevDelFileList	$list

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 31 of file RevDelArchivedFileItem.php.

References RevDelFileItem\$list, RevisionItemBase\$row, and RepoGroup\singleton().

Member Function Documentation

◆ getApiData()

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

Definition at line 103 of file RevDelArchivedFileItem.php.

References RevDelFileItem\$file, $ret, $user, RevDelFileItem\canViewContent(), Revision\DELETED_COMMENT, Revision\DELETED_USER, LocalFile\getHeight(), LocalFile\getSize(), LocalFile\getTimestamp(), LocalFile\getUser(), LocalFile\getWidth(), OldLocalFile\isDeleted(), RevDelFileItem\isDeleted(), list, OldLocalFile\userCan(), and wfTimestamp().

◆ getAuthorActorField()

RevDelArchivedFileItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since: 1.31

Returns: bool

Reimplemented from RevDelFileItem.

Definition at line 56 of file RevDelArchivedFileItem.php.

◆ getAuthorIdField()

RevDelArchivedFileItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns: bool

Reimplemented from RevDelFileItem.

Definition at line 48 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 52 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 60 of file RevDelArchivedFileItem.php.

◆ getIdField()

RevDelArchivedFileItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns: null

Reimplemented from RevDelFileItem.

Definition at line 40 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 78 of file RevDelArchivedFileItem.php.

References $link, RevDelFileItem\canViewContent(), file, RevisionItemBase\getLinkRenderer(), RevDelFileItem\isDeleted(), and list.

◆ getTimestampField()

RevDelArchivedFileItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns: bool

Reimplemented from RevDelFileItem.

Definition at line 44 of file RevDelArchivedFileItem.php.

◆ initFile()

static RevDelArchivedFileItem::initFile	(	$list,
		$row
	)

staticprotected

Create file object from $row sourced from $list.

Parameters

RevDelFileList	$list
mixed	$row

Returns: mixed

Reimplemented from RevDelFileItem.

Definition at line 36 of file RevDelArchivedFileItem.php.

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

◆ lock()

RevDelArchivedFileItem::lock ( )

Lock the item against changes outside of the DB.

Returns: Status

Since: 1.28

Reimplemented from RevDelFileItem.

Definition at line 142 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 64 of file RevDelArchivedFileItem.php.

References DB_MASTER, and wfGetDB().

◆ unlock()

RevDelArchivedFileItem::unlock ( )

Unlock the item against changes outside of the DB.

Returns: Status

Since: 1.28

Reimplemented from RevDelFileItem.

Definition at line 146 of file RevDelArchivedFileItem.php.

Member Data Documentation

◆ $lockFile

LocalFile RevDelArchivedFileItem::$lockFile

protected

Definition at line 29 of file RevDelArchivedFileItem.php.

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

includes/revisiondelete/RevDelArchivedFileItem.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getApiData()

◆ getAuthorActorField()

◆ getAuthorIdField()

◆ getAuthorNameField()

◆ getId()

◆ getIdField()

◆ getLink()

◆ getTimestampField()

◆ initFile()

◆ lock()

◆ setBits()

◆ unlock()

Member Data Documentation

◆ $lockFile