MediaWiki  REL1_24
Public Member Functions | Public Attributes | Protected Member Functions
RevDelRevisionItem Class Reference

Item class for a live revision table row. More...

Inheritance diagram for RevDelRevisionItem:
Inheritance graph
[legend]
Collaboration diagram for RevDelRevisionItem:
Collaboration graph
[legend]

List of all members.

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.
 getIdField ()
 Get the DB field name associated with the ID list.
 getTimestampField ()
 Get the DB field name storing timestamps.
 isDeleted ()
 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.
 setBits ($bits)
 Set the visibility of the item.

Public Attributes

Revision $revision
 *

Protected Member Functions

 getDiffLink ()
 Get the HTML link to the diff.
 getRevisionLink ()
 Get the HTML link to the revision text.

Detailed Description

Item class for a live revision table row.

Definition at line 25 of file RevDelRevisionItem.php.

Constructor & Destructor Documentation

RevDelRevisionItem::__construct ( $  list,
$  row 
)
Parameters:
RevisionListBase$list
object$rowDB result row

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 28 of file RevDelRevisionItem.php.

References RevisionItemBase\$list, and RevisionItemBase\$row.

Member Function Documentation

RevDelRevisionItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 49 of file RevDelRevisionItem.php.

References Revision\DELETED_RESTRICTED, and list.

RevDelRevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 53 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, and list.

Referenced by RevDelArchiveItem\getDiffLink(), and RevDelArchiveItem\getRevisionLink().

RevDelRevisionItem::getApiData ( ApiResult $  result)

Get the return information about the revision for the API.

Since:
1.23
Parameters:
ApiResult$resultAPI result object
Returns:
array Data for the API result

Reimplemented from RevDelItem.

Definition at line 162 of file RevDelRevisionItem.php.

References $ret, $rev, $user, array(), Revision\DELETED_COMMENT, Revision\DELETED_TEXT, Revision\DELETED_USER, Revision\FOR_THIS_USER, list, and wfTimestamp().

RevDelRevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns:
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 41 of file RevDelRevisionItem.php.

RevDelRevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns:
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 45 of file RevDelRevisionItem.php.

RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Reimplemented from RevDelItem.

Definition at line 57 of file RevDelRevisionItem.php.

Referenced by RevDelArchiveItem\setBits(), and setBits().

RevDelRevisionItem::getDiffLink ( ) [protected]

Get the HTML link to the diff.

Overridden by RevDelArchiveItem

Returns:
string

Reimplemented in RevDelArchiveItem.

Definition at line 132 of file RevDelRevisionItem.php.

Referenced by getHTML().

RevDelRevisionItem::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 149 of file RevDelRevisionItem.php.

References $comment, getDiffLink(), getRevisionLink(), isDeleted(), list, Linker\revComment(), and Linker\revUserLink().

RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns:
null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 33 of file RevDelRevisionItem.php.

RevDelRevisionItem::getRevisionLink ( ) [protected]

Get the HTML link to the revision text.

Overridden by RevDelArchiveItem.

Returns:
string

Reimplemented in RevDelArchiveItem.

Definition at line 108 of file RevDelRevisionItem.php.

Referenced by getHTML().

RevDelRevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns:
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 37 of file RevDelRevisionItem.php.

RevDelRevisionItem::isDeleted ( )

Definition at line 94 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT.

Referenced by RevDelArchiveItem\getDiffLink(), getHTML(), and RevDelArchiveItem\getRevisionLink().

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

Parameters:
int$newBits
Returns:
bool

Reimplemented from RevDelItem.

Definition at line 98 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, RevisionItemBase\getId(), and list.

RevDelRevisionItem::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 RevDelArchiveItem, and RevDelArchivedRevisionItem.

Definition at line 61 of file RevDelRevisionItem.php.

References array(), getBits(), and wfGetDB().

Member Data Documentation

Revision RevDelRevisionItem::$revision

*

Definition at line 26 of file RevDelRevisionItem.php.

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