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

Inheritance diagram for RevDelFileItem:

Collaboration diagram for RevDelFileItem:

Public Member Functions
	__construct ($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.
	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.
	getBits ()
	Get the current deletion bitfield value.
	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.
	getTimestampField ()
	Get the DB field name storing timestamps.
	isDeleted ()
	setBits ($bits)
	Set the visibility of the item.
Public Attributes
File	$file
	*
Protected Member Functions
	getComment ()
	Wrap and format the file's comment block, if the current user is allowed to view it.
	getLink ()
	Get the link to the file.
	getUserTools ()
	Generate a user tool link cluster if the current user is allowed to view it.

Detailed Description

Item class for an oldimage table row.

Definition at line 25 of file RevDelFileItem.php.

Constructor & Destructor Documentation

RevDelFileItem::__construct	(	$	list,
		$	row
	)

Parameters:

RevisionListBase	$list
object	$row	DB result row

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 28 of file RevDelFileItem.php.

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

Member Function Documentation

RevDelFileItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 55 of file RevDelFileItem.php.

References File\DELETED_RESTRICTED, file, and list.

RevDelFileItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 59 of file RevDelFileItem.php.

References File\DELETED_FILE, file, and list.

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

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

Reimplemented in RevDelArchivedFileItem.

Definition at line 192 of file RevDelFileItem.php.

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

RevDelFileItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns:: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 41 of file RevDelFileItem.php.

RevDelFileItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns:: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 45 of file RevDelFileItem.php.

RevDelFileItem::getBits ( )

Get the current deletion bitfield value.

Reimplemented from RevDelItem.

Definition at line 63 of file RevDelFileItem.php.

References file.

RevDelFileItem::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 169 of file RevDelFileItem.php.

Referenced by getHTML().

RevDelFileItem::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 182 of file RevDelFileItem.php.

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

RevDelFileItem::getId ( )

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

Returns:: int

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 49 of file RevDelFileItem.php.

RevDelFileItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns:: null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 33 of file RevDelFileItem.php.

RevDelFileItem::getLink ( ) [protected]

Get the link to the file.

Overridden by RevDelArchivedFileItem.

Returns:: string

Reimplemented in RevDelArchivedFileItem.

Definition at line 115 of file RevDelFileItem.php.

Referenced by getHTML().

RevDelFileItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns:: bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedFileItem.

Definition at line 37 of file RevDelFileItem.php.

RevDelFileItem::getUserTools ( ) [protected]

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

Returns:: string HTML

Definition at line 148 of file RevDelFileItem.php.

Referenced by getHTML().

RevDelFileItem::isDeleted ( )

Definition at line 106 of file RevDelFileItem.php.

References File\DELETED_FILE, and file.

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

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

Reimplemented in RevDelArchivedFileItem.

Definition at line 67 of file RevDelFileItem.php.

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

Member Data Documentation

File RevDelFileItem::$file

*

Definition at line 26 of file RevDelFileItem.php.

Referenced by RevDelArchivedFileItem\getApiData(), and getApiData().

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

includes/revisiondelete/RevDelFileItem.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation