Item class for an oldimage table row. More...

Inheritance diagram for RevDel_FileItem:

[legend]

Collaboration diagram for RevDel_FileItem:

[legend]

Public Member Functions
	__construct ( $list, $row)

	canView ()
	Returns true if the current user can view the item. More...

	canViewContent ()
	Returns true if the current user can view the item text/file. More...

	getApiData (ApiResult $result)
	Get the return information about the revision for the API. More...

	getAuthorIdField ()
	Get the DB field name storing user ids. More...

	getAuthorNameField ()
	Get the DB field name storing user names. More...

	getBits ()
	Get the current deletion bitfield value. More...

	getHTML ()
	Get the HTML of the list item. More...

	getId ()
	Get the ID, as it would appear in the ids URL parameter. More...

	getIdField ()
	Get the DB field name associated with the ID list. More...

	getTimestampField ()
	Get the DB field name storing timestamps. More...

	isDeleted ()

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

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

Public Member Functions inherited from RevisionItemBase
	formatDate ()
	Get the date, formatted in user's language. More...

	formatTime ()
	Get the time, formatted in user's language. More...

	getAuthorId ()
	Get the author user ID. More...

	getAuthorName ()
	Get the author user name. More...

	getTimestamp ()
	Get the timestamp in MW 14-char form. More...

Public Attributes
File	$file

Public Attributes inherited from RevisionItemBase
	$list
	The parent RevisionListBase. More...

	$row
	The DB result row. More...

Protected Member Functions
	getComment ()
	Wrap and format the file's comment block, if the current user is allowed to view it. More...

	getLink ()
	Get the link to the file. More...

	getUserTools ()
	Generate a user tool link cluster if the current user is allowed to view it. More...

Detailed Description

Item class for an oldimage table row.

Definition at line 571 of file RevisionDelete.php.

Constructor & Destructor Documentation

◆ __construct()

RevDel_FileItem::__construct	(	$list,
		$row
	)

Parameters

$list	RevisionListBase
$row	DB result row

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 577 of file RevisionDelete.php.

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

Member Function Documentation

◆ canView()

RevDel_FileItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 603 of file RevisionDelete.php.

References File\DELETED_RESTRICTED, file, and list.

◆ canViewContent()

RevDel_FileItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 607 of file RevisionDelete.php.

References File\DELETED_FILE, file, and list.

Referenced by getApiData(), getLink(), and RevDel_ArchivedFileItem\getLink().

◆ getApiData()

RevDel_FileItem::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 RevDel_Item.

Definition at line 736 of file RevisionDelete.php.

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

◆ getAuthorIdField()

RevDel_FileItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 590 of file RevisionDelete.php.

◆ getAuthorNameField()

RevDel_FileItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 594 of file RevisionDelete.php.

◆ getBits()

RevDel_FileItem::getBits ( )

Get the current deletion bitfield value.

Reimplemented from RevDel_Item.

Definition at line 611 of file RevisionDelete.php.

References file.

◆ getComment()

RevDel_FileItem::getComment ( )

protected

Wrap and format the file's comment block, if the current user is allowed to view it.

Returns: string HTML

Definition at line 714 of file RevisionDelete.php.

References Linker\commentBlock(), File\DELETED_COMMENT, file, and list.

Referenced by getHTML().

◆ getHTML()

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

Reimplemented from RevisionItemBase.

Definition at line 726 of file RevisionDelete.php.

References file, getComment(), getLink(), getUserTools(), list, and text.

◆ getId()

RevDel_FileItem::getId ( )

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

Returns

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 598 of file RevisionDelete.php.

◆ getIdField()

RevDel_FileItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns: null

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 582 of file RevisionDelete.php.

◆ getLink()

RevDel_FileItem::getLink ( )

protected

Get the link to the file.

Overridden by RevDel_ArchivedFileItem.

Returns: string

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 662 of file RevisionDelete.php.

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

Referenced by getHTML().

◆ getTimestampField()

RevDel_FileItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 586 of file RevisionDelete.php.

◆ getUserTools()

RevDel_FileItem::getUserTools ( )

protected

Generate a user tool link cluster if the current user is allowed to view it.

Returns: string HTML

Definition at line 694 of file RevisionDelete.php.

References $link, $name, Revision\DELETED_USER, file, list, Linker\userLink(), and Linker\userToolLinks().

Referenced by getHTML().

◆ isDeleted()

RevDel_FileItem::isDeleted ( )

Definition at line 653 of file RevisionDelete.php.

References File\DELETED_FILE, and file.

Referenced by getApiData(), getLink(), RevDel_ArchivedFileItem\getLink(), and setBits().

◆ setBits()

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

Returns: boolean success

Reimplemented from RevDel_Item.

Reimplemented in RevDel_ArchivedFileItem.

Definition at line 615 of file RevisionDelete.php.

References array(), DB_MASTER, File\DELETED_FILE, file, isDeleted(), list, and wfGetDB().

Member Data Documentation

◆ $file

File RevDel_FileItem::$file

Definition at line 575 of file RevisionDelete.php.

Referenced by getApiData().

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

includes/revisiondelete/RevisionDelete.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canView()

◆ canViewContent()

◆ getApiData()

◆ getAuthorIdField()

◆ getAuthorNameField()

◆ getBits()

◆ getComment()

◆ getHTML()

◆ getId()

◆ getIdField()

◆ getLink()

◆ getTimestampField()

◆ getUserTools()

◆ isDeleted()

◆ setBits()

Member Data Documentation

◆ $file