MediaWiki  1.23.15
RevDel_RevisionItem Class Reference

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

Inheritance diagram for RevDel_RevisionItem:
Collaboration diagram for RevDel_RevisionItem:

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...
 
 getIdField ()
 Get the DB field name associated with the ID list. More...
 
 getTimestampField ()
 Get the DB field name storing timestamps. More...
 
 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. More...
 
 setBits ( $bits)
 Set the visibility of the item. 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...
 
 getId ()
 Get the ID, as it would appear in the ids URL parameter. More...
 
 getTimestamp ()
 Get the timestamp in MW 14-char form. More...
 

Public Attributes

 $revision
 
- Public Attributes inherited from RevisionItemBase
 $list
 The parent RevisionListBase. More...
 
 $row
 The DB result row. More...
 

Protected Member Functions

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

Detailed Description

Item class for a live revision table row.

Definition at line 149 of file RevisionDelete.php.

Constructor & Destructor Documentation

◆ __construct()

RevDel_RevisionItem::__construct (   $list,
  $row 
)
Parameters
$listRevisionListBase
$rowDB result row

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedRevisionItem, and RevDel_ArchiveItem.

Definition at line 152 of file RevisionDelete.php.

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

Member Function Documentation

◆ canView()

RevDel_RevisionItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 173 of file RevisionDelete.php.

References Revision\DELETED_RESTRICTED, and list.

◆ canViewContent()

RevDel_RevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 177 of file RevisionDelete.php.

References Revision\DELETED_TEXT, and list.

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

◆ getApiData()

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

Definition at line 283 of file RevisionDelete.php.

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

◆ getAuthorIdField()

RevDel_RevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchiveItem.

Definition at line 165 of file RevisionDelete.php.

◆ getAuthorNameField()

RevDel_RevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchiveItem.

Definition at line 169 of file RevisionDelete.php.

◆ getBits()

RevDel_RevisionItem::getBits ( )

Get the current deletion bitfield value.

Reimplemented from RevDel_Item.

Definition at line 181 of file RevisionDelete.php.

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

◆ getDiffLink()

RevDel_RevisionItem::getDiffLink ( )
protected

Get the HTML link to the diff.

Overridden by RevDel_ArchiveItem

Returns
string

Reimplemented in RevDel_ArchiveItem.

Definition at line 254 of file RevisionDelete.php.

References array(), canViewContent(), isDeleted(), Linker\linkKnown(), and list.

Referenced by getHTML().

◆ getHTML()

RevDel_RevisionItem::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 271 of file RevisionDelete.php.

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

◆ getIdField()

RevDel_RevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
null

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchivedRevisionItem, and RevDel_ArchiveItem.

Definition at line 157 of file RevisionDelete.php.

◆ getRevisionLink()

RevDel_RevisionItem::getRevisionLink ( )
protected

Get the HTML link to the revision text.

Overridden by RevDel_ArchiveItem.

Returns
string

Reimplemented in RevDel_ArchiveItem.

Definition at line 231 of file RevisionDelete.php.

References array(), canViewContent(), isDeleted(), Linker\linkKnown(), and list.

Referenced by getHTML().

◆ getTimestampField()

RevDel_RevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDel_ArchiveItem.

Definition at line 161 of file RevisionDelete.php.

◆ isDeleted()

RevDel_RevisionItem::isDeleted ( )

◆ isHideCurrentOp()

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

Returns
bool

Reimplemented from RevDel_Item.

Definition at line 221 of file RevisionDelete.php.

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

◆ setBits()

RevDel_RevisionItem::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_ArchivedRevisionItem, and RevDel_ArchiveItem.

Definition at line 185 of file RevisionDelete.php.

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

Member Data Documentation

◆ $revision

RevDel_RevisionItem::$revision

Definition at line 150 of file RevisionDelete.php.

Referenced by getApiData().


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