MediaWiki  1.23.8
RevDel_Item Class Reference

Abstract base class for deletable items. More...

Inheritance diagram for RevDel_Item:
Collaboration diagram for RevDel_Item:

Public Member Functions

 getApiData (ApiResult $result)
 Get the return information about the revision for the API. More...
 
 getBits ()
 Get the current deletion bitfield value. More...
 
 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 ( $newBits)
 Set the visibility of the item. More...
 
- Public Member Functions inherited from RevisionItemBase
 __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...
 
 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...
 
 getAuthorIdField ()
 Get the DB field name storing user ids. More...
 
 getAuthorName ()
 Get the author user name. More...
 
 getAuthorNameField ()
 Get the DB field name storing user names. 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...
 
 getTimestamp ()
 Get the timestamp in MW 14-char form. More...
 
 getTimestampField ()
 Get the DB field name storing timestamps. More...
 

Additional Inherited Members

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

Detailed Description

Abstract base class for deletable items.

Definition at line 318 of file RevisionDeleteAbstracts.php.

Member Function Documentation

◆ getApiData()

RevDel_Item::getApiData ( ApiResult  $result)
abstract

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 in RevDel_LogItem, RevDel_FileItem, and RevDel_RevisionItem.

◆ getBits()

RevDel_Item::getBits ( )
abstract

Get the current deletion bitfield value.

Reimplemented in RevDel_LogItem, RevDel_FileItem, and RevDel_RevisionItem.

◆ isHideCurrentOp()

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.

Returns
bool

Reimplemented in RevDel_RevisionItem.

Definition at line 325 of file RevisionDeleteAbstracts.php.

◆ setBits()

RevDel_Item::setBits (   $newBits)
abstract

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 in RevDel_LogItem, RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchivedRevisionItem, RevDel_ArchiveItem, and RevDel_RevisionItem.


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