Item class for a logging table row. More...
Public Member Functions | |
| 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... | |
| setBits ( $bits) | |
| Set the visibility of the item. More... | |
 Public Member Functions inherited from 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. More... | |
| lock () | |
| Lock the item against changes outside of the DB. More... | |
| unlock () | |
| Unlock the item against changes outside of the DB. More... | |
| Public Member Functions inherited from RevisionItemBase | |
| __construct ( $list, $row) | |
| 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... | |
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
Item class for a logging table row.
Definition at line 25 of file RevDelLogItem.php.
Member Function Documentation
◆ canView()
| RevDelLogItem::canView | ( | ) |
Returns true if the current user can view the item.
Reimplemented from RevisionItemBase.
Definition at line 42 of file RevDelLogItem.php.
References Revision\DELETED_RESTRICTED, list, and LogEventsList\userCan().
◆ canViewContent()
| RevDelLogItem::canViewContent | ( | ) |
Returns true if the current user can view the item text/file.
Reimplemented from RevisionItemBase.
Definition at line 46 of file RevDelLogItem.php.
◆ getApiData()
| RevDelLogItem::getApiData | ( | ApiResult | $result | ) |
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 from RevDelItem.
Definition at line 116 of file RevDelLogItem.php.
References $ret, $user, LogPage\DELETED_ACTION, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, list, LogFormatter\newFromEntry(), DatabaseLogEntry\newFromRow(), CommentStore\newKey(), and LogEventsList\userCan().
◆ getAuthorIdField()
| RevDelLogItem::getAuthorIdField | ( | ) |
Get the DB field name storing user ids.
Override this function.
- Returns
- bool
Reimplemented from RevisionItemBase.
Definition at line 34 of file RevDelLogItem.php.
◆ getAuthorNameField()
| RevDelLogItem::getAuthorNameField | ( | ) |
Get the DB field name storing user names.
Override this function.
- Returns
- bool
Reimplemented from RevisionItemBase.
Definition at line 38 of file RevDelLogItem.php.
◆ getBits()
| RevDelLogItem::getBits | ( | ) |
Get the current deletion bitfield value.
- Returns
- int
Reimplemented from RevDelItem.
Definition at line 50 of file RevDelLogItem.php.
◆ getHTML()
| RevDelLogItem::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 86 of file RevDelLogItem.php.
References $title, Linker\commentBlock(), LogPage\DELETED_COMMENT, LogFormatter\FOR_THIS_USER, RevisionItemBase\getLinkRenderer(), SpecialPage\getTitleFor(), LogEventsList\isDeleted(), list, Title\makeTitle(), LogFormatter\newFromRow(), and CommentStore\newKey().
◆ getIdField()
| RevDelLogItem::getIdField | ( | ) |
Get the DB field name associated with the ID list.
Override this function.
- Returns
- null
Reimplemented from RevisionItemBase.
Definition at line 26 of file RevDelLogItem.php.
◆ getTimestampField()
| RevDelLogItem::getTimestampField | ( | ) |
Get the DB field name storing timestamps.
Override this function.
- Returns
- bool
Reimplemented from RevisionItemBase.
Definition at line 30 of file RevDelLogItem.php.
◆ setBits()
| RevDelLogItem::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.
Definition at line 54 of file RevDelLogItem.php.
The documentation for this class was generated from the following file:
- includes/revisiondelete/RevDelLogItem.php
