Abstract base class for deletable items. More...
Public Member Functions | |
| getApiData (ApiResult $result) | |
| Get the return information about the revision for the API. | |
| getBits () | |
| Get the current deletion bitfield value. | |
| 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 ($newBits) | |
| Set the visibility of the item. | |
Detailed Description
Abstract base class for deletable items.
Definition at line 25 of file RevDelItem.php.
Member Function Documentation
| RevDelItem::getApiData | ( | ApiResult $ | result | ) | [abstract] |
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 in RevDelFileItem, RevDelRevisionItem, RevDelLogItem, and RevDelArchivedFileItem.
| RevDelItem::getBits | ( | ) | [abstract] |
Get the current deletion bitfield value.
Reimplemented in RevDelFileItem, RevDelRevisionItem, and RevDelLogItem.
| 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.
| 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 RevDelFileItem, RevDelRevisionItem, RevDelLogItem, RevDelArchiveItem, RevDelArchivedFileItem, and RevDelArchivedRevisionItem.
The documentation for this class was generated from the following file:
- includes/revisiondelete/RevDelItem.php
