MediaWiki  master
RevDelLogItem Class Reference

Item class for a logging table row. More...

Inheritance diagram for RevDelLogItem:
Collaboration diagram for RevDelLogItem:

Public Member Functions

 __construct (RevisionListBase $list, $row, CommentStore $commentStore)
 
 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...
 
 getAuthorActorField ()
 Get the DB field name storing actor ids. 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 (RevisionListBase $list, $row)
 
 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...
 
 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...
 

Private Attributes

CommentStore $commentStore
 

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...
 
stdClass $row
 The database result row. More...
 

Detailed Description

Item class for a logging table row.

Definition at line 27 of file RevDelLogItem.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelLogItem::__construct ( RevisionListBase  $list,
  $row,
CommentStore  $commentStore 
)
Parameters
RevisionListBase$list
stdClass$rowDB result row
CommentStore$commentStore

Definition at line 37 of file RevDelLogItem.php.

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

Member Function Documentation

◆ canView()

RevDelLogItem::canView ( )

Returns true if the current user can view the item.

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 66 of file RevDelLogItem.php.

References LogEventsList\userCan().

◆ canViewContent()

RevDelLogItem::canViewContent ( )

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

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 72 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
Returns
array Data for the API result

Reimplemented from RevDelItem.

Definition at line 142 of file RevDelLogItem.php.

References LogPage\DELETED_ACTION, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, LogFormatter\newFromEntry(), DatabaseLogEntry\newFromRow(), and LogEventsList\userCan().

◆ getAuthorActorField()

RevDelLogItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
string|false

Reimplemented from RevisionItemBase.

Definition at line 62 of file RevDelLogItem.php.

◆ getAuthorIdField()

RevDelLogItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Definition at line 54 of file RevDelLogItem.php.

◆ getAuthorNameField()

RevDelLogItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Definition at line 58 of file RevDelLogItem.php.

◆ getBits()

RevDelLogItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from RevDelItem.

Definition at line 76 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.

Returns
string HTML

Reimplemented from RevisionItemBase.

Definition at line 112 of file RevDelLogItem.php.

References $title, Linker\commentBlock(), LogPage\DELETED_COMMENT, LogFormatter\FOR_THIS_USER, RevisionItemBase\getLinkRenderer(), SpecialPage\getTitleFor(), LogEventsList\isDeleted(), Title\makeTitle(), and LogFormatter\newFromRow().

◆ getIdField()

RevDelLogItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented from RevisionItemBase.

Definition at line 46 of file RevDelLogItem.php.

◆ getTimestampField()

RevDelLogItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Definition at line 50 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 80 of file RevDelLogItem.php.

References DB_PRIMARY, RecentChange\PRC_AUTOPATROLLED, and wfGetDB().

Member Data Documentation

◆ $commentStore

CommentStore RevDelLogItem::$commentStore
private

Definition at line 30 of file RevDelLogItem.php.

Referenced by __construct().


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