MediaWiki  REL1_31
RevDelRevisionItem Class Reference

Item class for a live revision table row. More...

Inheritance diagram for RevDelRevisionItem:
Collaboration diagram for RevDelRevisionItem:

Public Member Functions

 __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...
 
 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 ()
 
 getIdField ()
 Get the DB field name associated with the ID list. More...
 
 getTags ()
 
 getTimestampField ()
 Get the DB field name storing timestamps. More...
 
 isDeleted ()
 
 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 ( $bits)
 Set the visibility of the item. More...
 
- Public Member Functions inherited from RevDelItem
 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
 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...
 

Public Attributes

Revision $revision
 

Protected Member Functions

 getDiffLink ()
 Get the HTML link to the diff. More...
 
 getRevisionLink ()
 Get the HTML link to the revision text. More...
 
- Protected Member Functions inherited from RevisionItemBase
 getLinkRenderer ()
 Returns an instance of LinkRenderer. More...
 

Additional Inherited Members

- Protected Attributes inherited from RevisionItemBase
RevisionListBase $list
 The parent. More...
 
 $row
 The database result row. More...
 

Detailed Description

Item class for a live revision table row.

Definition at line 25 of file RevDelRevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

RevDelRevisionItem::__construct (   $list,
  $row 
)
Parameters
RevisionListBase$list
object$rowDB result row

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem, and RevDelArchivedRevisionItem.

Definition at line 29 of file RevDelRevisionItem.php.

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

Member Function Documentation

◆ canView()

RevDelRevisionItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 54 of file RevDelRevisionItem.php.

References Revision\DELETED_RESTRICTED, and list.

◆ canViewContent()

RevDelRevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 58 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, and list.

Referenced by RevDelArchiveItem\getDiffLink(), getDiffLink(), RevDelArchiveItem\getRevisionLink(), and getRevisionLink().

◆ getApiData()

RevDelRevisionItem::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 189 of file RevDelRevisionItem.php.

References $ret, $rev, $revision, $user, Revision\DELETED_COMMENT, Revision\DELETED_TEXT, Revision\DELETED_USER, Revision\FOR_THIS_USER, list, and wfTimestamp().

◆ getAuthorActorField()

RevDelRevisionItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 50 of file RevDelRevisionItem.php.

◆ getAuthorIdField()

RevDelRevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 42 of file RevDelRevisionItem.php.

◆ getAuthorNameField()

RevDelRevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 46 of file RevDelRevisionItem.php.

◆ getBits()

RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from RevDelItem.

Definition at line 62 of file RevDelRevisionItem.php.

◆ getDiffLink()

RevDelRevisionItem::getDiffLink ( )
protected

Get the HTML link to the diff.

Overridden by RevDelArchiveItem

Returns
string

Reimplemented in RevDelArchiveItem.

Definition at line 137 of file RevDelRevisionItem.php.

References canViewContent(), RevisionItemBase\getLinkRenderer(), isDeleted(), and list.

Referenced by getHTML().

◆ getHTML()

RevDelRevisionItem::getHTML ( )
Returns
string A HTML element representing this revision, showing change tags and everything

Reimplemented from RevisionItemBase.

Definition at line 158 of file RevDelRevisionItem.php.

References $attribs, ChangeTags\formatSummaryRow(), getDiffLink(), getRevisionLink(), getTags(), isDeleted(), list, Linker\revComment(), Linker\revUserLink(), and Xml\tags().

◆ getIdField()

RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem, and RevDelArchivedRevisionItem.

Definition at line 34 of file RevDelRevisionItem.php.

◆ getRevisionLink()

RevDelRevisionItem::getRevisionLink ( )
protected

Get the HTML link to the revision text.

Overridden by RevDelArchiveItem.

Returns
string

Reimplemented in RevDelArchiveItem.

Definition at line 113 of file RevDelRevisionItem.php.

References canViewContent(), RevisionItemBase\getLinkRenderer(), isDeleted(), and list.

Referenced by getHTML().

◆ getTags()

RevDelRevisionItem::getTags ( )
Returns
string Comma-separated list of tags

Definition at line 185 of file RevDelRevisionItem.php.

Referenced by getHTML().

◆ getTimestampField()

RevDelRevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 38 of file RevDelRevisionItem.php.

◆ isDeleted()

RevDelRevisionItem::isDeleted ( )

◆ isHideCurrentOp()

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

Definition at line 103 of file RevDelRevisionItem.php.

References Revision\DELETED_TEXT, RevisionItemBase\getId(), and list.

◆ setBits()

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

Reimplemented in RevDelArchiveItem, and RevDelArchivedRevisionItem.

Definition at line 66 of file RevDelRevisionItem.php.

References DB_MASTER, RecentChange\PRC_PATROLLED, and wfGetDB().

Member Data Documentation

◆ $revision

Revision RevDelRevisionItem::$revision

Definition at line 27 of file RevDelRevisionItem.php.

Referenced by getApiData().


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