Inherits MediaWiki\RevisionDelete\RevDelFileItem.

Collaboration diagram for MediaWiki\RevisionDelete\RevDelArchivedFileItem:

[legend]

Public Member Functions

__construct (RevisionListBase $list, $row)

Parameters

RevisionListBase	$list
stdClass	$row	DB result row

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

getAuthorActorField ()

Get the DB field name storing actor ids.Override this function.

Since: 1.31

Returns: string|false

getAuthorIdField ()

Get the DB field name storing user ids.Override this function.

Returns: string|false

getAuthorNameField ()

Get the DB field name storing user names.Override this function.

Returns: string|false

getId ()

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

Returns: int|string

getIdField ()

Get the DB field name associated with the ID list.Override this function.

Returns: string|null

getTimestampField ()

Get the DB field name storing timestamps.Override this function.

Returns: string|false

lock ()

Lock the item against changes outside of the DB.

Returns: Status

Since: 1.28

setBits ( $bits)

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

unlock ()

Unlock the item against changes outside of the DB.

Returns: Status

Since: 1.28

Public Member Functions inherited from MediaWiki\RevisionDelete\RevDelFileItem

canView ()

Returns true if the current user can view the item.

Returns: bool

canViewContent ()

Returns true if the current user can view the item text/file.

Returns: bool

getBits ()

Get the current deletion bitfield value.

Returns: int

getHTML ()

Get the HTML of the list item.Should be include "<li></li>" tags. This is used to show the list in HTML form, by the special page.

Returns: string HTML

isDeleted ()

Public Member Functions inherited from 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.

Public Member Functions inherited from MediaWiki\RevisionList\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.Overridden by RevDelArchivedFileItem. Returns string

Protected Member Functions inherited from MediaWiki\RevisionDelete\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 MediaWiki\RevisionList\RevisionItemBase
	getLinkRenderer ()
	Returns an instance of LinkRenderer.

Static Protected Member Functions

static initFile ( $list, $row)

Create file object from $row sourced from $list.

Parameters

RevisionListBase	$list
mixed	$row

Returns: mixed

Protected Attributes
LocalFile	$lockFile

Protected Attributes inherited from MediaWiki\RevisionDelete\RevDelFileItem
IConnectionProvider	$dbProvider

OldLocalFile	$file

RevDelFileList	$list

Protected Attributes inherited from MediaWiki\RevisionList\RevisionItemBase
RevisionListBase	$list
	The parent.

stdClass	$row
	The database result row.

Detailed Description

Definition at line 25 of file RevDelArchivedFileItem.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::__construct	(	RevisionListBase	$list,
			$row )

Parameters

RevisionListBase	$list
stdClass	$row	DB result row

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 30 of file RevDelArchivedFileItem.php.

References MediaWiki\RevisionDelete\RevDelFileItem\$list, MediaWiki\RevisionList\RevisionItemBase\$row, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ getApiData()

MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 113 of file RevDelArchivedFileItem.php.

References MediaWiki\RevisionDelete\RevDelFileItem\$file, MediaWiki\RevisionDelete\RevDelFileItem\canViewContent(), MediaWiki\FileRepo\File\LocalFile\getDescription(), MediaWiki\FileRepo\File\LocalFile\getHeight(), MediaWiki\FileRepo\File\LocalFile\getSize(), MediaWiki\FileRepo\File\LocalFile\getTimestamp(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\FileRepo\File\LocalFile\getUploader(), MediaWiki\FileRepo\File\LocalFile\getWidth(), MediaWiki\FileRepo\File\OldLocalFile\isDeleted(), MediaWiki\RevisionDelete\RevDelFileItem\isDeleted(), and wfTimestamp().

◆ getAuthorActorField()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getAuthorActorField ( )

Get the DB field name storing actor ids.Override this function.

Since: 1.31

Returns: string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 62 of file RevDelArchivedFileItem.php.

◆ getAuthorIdField()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getAuthorIdField ( )

Get the DB field name storing user ids.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 52 of file RevDelArchivedFileItem.php.

◆ getAuthorNameField()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getAuthorNameField ( )

Get the DB field name storing user names.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 57 of file RevDelArchivedFileItem.php.

◆ getId()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getId ( )

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

Returns: int|string

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 67 of file RevDelArchivedFileItem.php.

◆ getIdField()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getIdField ( )

Get the DB field name associated with the ID list.Override this function.

Returns: string|null

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 42 of file RevDelArchivedFileItem.php.

◆ getLink()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getLink ( )

protected

Get the link to the file.Overridden by RevDelArchivedFileItem.

Returns: string

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 87 of file RevDelArchivedFileItem.php.

References MediaWiki\RevisionDelete\RevDelFileItem\canViewContent(), MediaWiki\RevisionList\RevisionItemBase\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\RevisionDelete\RevDelFileItem\isDeleted().

◆ getTimestampField()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::getTimestampField ( )

Get the DB field name storing timestamps.Override this function.

Returns: string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 47 of file RevDelArchivedFileItem.php.

◆ initFile()

static MediaWiki\RevisionDelete\RevDelArchivedFileItem::initFile	(		$list,
			$row )

staticprotected

Create file object from $row sourced from $list.

Parameters

RevisionListBase	$list
mixed	$row

Returns: mixed

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 37 of file RevDelArchivedFileItem.php.

References MediaWiki\RevisionList\RevisionItemBase\$row.

◆ lock()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::lock ( )

Lock the item against changes outside of the DB.

Returns: Status

Since: 1.28

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 155 of file RevDelArchivedFileItem.php.

◆ setBits()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::setBits ( $bits )

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 MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 72 of file RevDelArchivedFileItem.php.

◆ unlock()

MediaWiki\RevisionDelete\RevDelArchivedFileItem::unlock ( )

Unlock the item against changes outside of the DB.

Returns: Status

Since: 1.28

Reimplemented from MediaWiki\RevisionDelete\RevDelFileItem.

Definition at line 160 of file RevDelArchivedFileItem.php.

Member Data Documentation

◆ $lockFile

LocalFile MediaWiki\RevisionDelete\RevDelArchivedFileItem::$lockFile

protected

Definition at line 27 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