MediaWiki  master
RevDelItem Class Reference

Abstract base class for deletable items. More...

Inheritance diagram for RevDelItem:
Collaboration diagram for RevDelItem:

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...
 
 lock ()
 Lock the item against changes outside of the DB. More...
 
 setBits ( $newBits)
 Set the visibility of the item. More...
 
 unlock ()
 Unlock the item against changes outside of the DB. More...
 
- Public Member Functions inherited from RevisionItemBase
 __construct (RevisionListBase $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...
 
 getAuthorActor ()
 Get the author actor ID. More...
 
 getAuthorActorField ()
 Get the DB field name storing actor ids. 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

- Protected Member Functions inherited from RevisionItemBase
 getLinkRenderer ()
 Returns an instance of LinkRenderer. More...
 
- Protected Attributes inherited from RevisionItemBase
RevisionListBase $list
 The parent. More...
 
 $row
 The database result row. More...
 

Detailed Description

Abstract base class for deletable items.

Definition at line 25 of file RevDelItem.php.

Member Function Documentation

◆ getApiData()

RevDelItem::getApiData ( ApiResult  $result)
abstract

Get the return information about the revision for the API.

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

Reimplemented in RevDelRevisionItem, RevDelFileItem, RevDelLogItem, and RevDelArchivedFileItem.

◆ getBits()

RevDelItem::getBits ( )
abstract

Get the current deletion bitfield value.

Returns
int

Reimplemented in RevDelRevisionItem, RevDelFileItem, and RevDelLogItem.

◆ isHideCurrentOp()

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

Definition at line 33 of file RevDelItem.php.

◆ lock()

RevDelItem::lock ( )

Lock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented in RevDelFileItem, and RevDelArchivedFileItem.

Definition at line 70 of file RevDelItem.php.

References StatusValue\newGood().

◆ setBits()

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

Parameters
int$newBits
Returns
bool Success

Reimplemented in RevDelRevisionItem, RevDelFileItem, RevDelArchivedFileItem, RevDelArchiveItem, RevDelLogItem, and RevDelArchivedRevisionItem.

◆ unlock()

RevDelItem::unlock ( )

Unlock the item against changes outside of the DB.

Returns
Status
Since
1.28

Reimplemented in RevDelFileItem, and RevDelArchivedFileItem.

Definition at line 79 of file RevDelItem.php.

References StatusValue\newGood().


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