MediaWiki 1.42.1
RevDelRevisionItem Class Reference

Inherits RevDelItem.

Inherited by RevDelArchiveItem.

Collaboration diagram for RevDelRevisionItem:

Public Member Functions

 __construct (RevisionListBase $list, $row)
 
 canView ()
 Returns true if the current user can view the item.
 
 canViewContent ()
 Returns true if the current user can view the item text/file.
 
 getApiData (ApiResult $result)
 Get the return information about the revision for the API.
 
 getAuthorActorField ()
 Get the DB field name storing actor ids.
 
 getAuthorIdField ()
 Get the DB field name storing user ids.
 
 getAuthorNameField ()
 Get the DB field name storing user names.
 
 getBits ()
 Get the current deletion bitfield value.
 
 getHTML ()
 
 getIdField ()
 Get the DB field name associated with the ID list.
 
 getTags ()
 
 getTimestampField ()
 Get the DB field name storing timestamps.
 
 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.
 
 setBits ( $bits)
 Set the visibility of the item.
 
- Public Member Functions inherited from RevDelItem
 lock ()
 Lock the item against changes outside of the DB.
 
 unlock ()
 Unlock the item against changes outside of the DB.
 
- Public Member Functions inherited from RevisionItemBase
 formatDate ()
 Get the date, formatted in user's language.
 
 formatTime ()
 Get the time, formatted in user's language.
 
 getAuthorActor ()
 Get the author actor ID.
 
 getAuthorId ()
 Get the author user ID.
 
 getAuthorName ()
 Get the author user name.
 
 getId ()
 Get the ID, as it would appear in the ids URL parameter.
 
 getTimestamp ()
 Get the timestamp in MW 14-char form.
 

Public Attributes

RevisionRecord $revisionRecord
 

Protected Member Functions

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

Static Protected Member Functions

static initRevisionRecord ( $list, $row)
 Create RevisionRecord object from $row sourced from $list.
 

Additional Inherited Members

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

Detailed Description

Definition at line 31 of file RevDelRevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from RevisionItemBase.

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

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 82 of file RevDelRevisionItem.php.

◆ canViewContent()

RevDelRevisionItem::canViewContent ( )

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

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 89 of file RevDelRevisionItem.php.

Referenced by RevDelArchiveItem\getDiffLink(), and RevDelArchiveItem\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 228 of file RevDelRevisionItem.php.

References wfTimestamp().

◆ getAuthorActorField()

RevDelRevisionItem::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
string|false

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 78 of file RevDelRevisionItem.php.

◆ getAuthorIdField()

RevDelRevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 70 of file RevDelRevisionItem.php.

◆ getAuthorNameField()

RevDelRevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 74 of file RevDelRevisionItem.php.

◆ getBits()

RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from RevDelItem.

Definition at line 96 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 172 of file RevDelRevisionItem.php.

◆ getHTML()

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

Reimplemented from RevisionItemBase.

Definition at line 193 of file RevDelRevisionItem.php.

References ChangeTags\formatSummaryRow().

◆ getIdField()

RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 62 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 146 of file RevDelRevisionItem.php.

References getTimestamp().

◆ getRevisionRecord()

RevDelRevisionItem::getRevisionRecord ( )
protected

Get the RevisionRecord for the item.

Returns
RevisionRecord

Definition at line 58 of file RevDelRevisionItem.php.

◆ getTags()

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

Definition at line 224 of file RevDelRevisionItem.php.

◆ getTimestampField()

RevDelRevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
string|false

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem.

Definition at line 66 of file RevDelRevisionItem.php.

◆ initRevisionRecord()

static RevDelRevisionItem::initRevisionRecord ( $list,
$row )
staticprotected

Create RevisionRecord object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
RevisionRecord

Reimplemented in RevDelArchiveItem.

Definition at line 47 of file RevDelRevisionItem.php.

References RevisionItemBase\$row.

◆ 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 136 of file RevDelRevisionItem.php.

◆ 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 RevDelArchivedRevisionItem, and RevDelArchiveItem.

Definition at line 100 of file RevDelRevisionItem.php.

Member Data Documentation

◆ $revisionRecord

RevisionRecord RevDelRevisionItem::$revisionRecord

Definition at line 33 of file RevDelRevisionItem.php.


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