MediaWiki master
MediaWiki\RevisionDelete\RevDelRevisionItem Class Reference

Inherits MediaWiki\RevisionDelete\RevDelItem.

Inherited by MediaWiki\RevisionDelete\RevDelArchiveItem.

Collaboration diagram for MediaWiki\RevisionDelete\RevDelRevisionItem:

Public Member Functions

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

 
 canView ()
 Returns true if the current user can view the item.
Returns
bool

 
 canViewContent ()
 Returns true if the current user can view the item text/file.
Returns
bool

 
 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

 
 getAuthorActorField ()
 Get the DB field name storing actor ids.Override this function.

Since
1.31
Returns
string|false

 
 getAuthorIdField ()
 Get the DB field name storing user ids.Override this function.

Returns
string|false

 
 getAuthorNameField ()
 Get the DB field name storing user names.Override this function.

Returns
string|false

 
 getBits ()
 Get the current deletion bitfield value.
Returns
int

 
 getHTML ()
 
 getIdField ()
 Get the DB field name associated with the ID list.Override this function.

Returns
string|null

 
 getTags ()
 
 getTimestampField ()
 Get the DB field name storing timestamps.Override this function.

Returns
string|false

 
 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.
Parameters
int$newBits
Returns
bool

 
 setBits ( $bits)
 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

 
- Public Member Functions inherited from MediaWiki\RevisionDelete\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 MediaWiki\RevisionList\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 MediaWiki\RevisionList\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 MediaWiki\RevisionList\RevisionItemBase
RevisionListBase $list
 The parent.
 
stdClass $row
 The database result row.
 

Detailed Description

Definition at line 25 of file RevDelRevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RevisionDelete\RevDelRevisionItem::__construct ( RevisionListBase $list,
$row )

Member Function Documentation

◆ canView()

MediaWiki\RevisionDelete\RevDelRevisionItem::canView ( )

Returns true if the current user can view the item.

Returns
bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 81 of file RevDelRevisionItem.php.

◆ canViewContent()

MediaWiki\RevisionDelete\RevDelRevisionItem::canViewContent ( )

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

Returns
bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 89 of file RevDelRevisionItem.php.

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

◆ getApiData()

MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelItem.

Definition at line 235 of file RevDelRevisionItem.php.

References wfTimestamp().

◆ getAuthorActorField()

MediaWiki\RevisionDelete\RevDelRevisionItem::getAuthorActorField ( )

Get the DB field name storing actor ids.Override this function.

Since
1.31
Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 76 of file RevDelRevisionItem.php.

◆ getAuthorIdField()

MediaWiki\RevisionDelete\RevDelRevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.Override this function.

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 66 of file RevDelRevisionItem.php.

◆ getAuthorNameField()

MediaWiki\RevisionDelete\RevDelRevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.Override this function.

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 71 of file RevDelRevisionItem.php.

◆ getBits()

MediaWiki\RevisionDelete\RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from MediaWiki\RevisionDelete\RevDelItem.

Definition at line 97 of file RevDelRevisionItem.php.

◆ getDiffLink()

MediaWiki\RevisionDelete\RevDelRevisionItem::getDiffLink ( )
protected

Get the HTML link to the diff.

Overridden by RevDelArchiveItem

Returns
string

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 178 of file RevDelRevisionItem.php.

◆ getHTML()

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

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 199 of file RevDelRevisionItem.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getIdField()

MediaWiki\RevisionDelete\RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.Override this function.

Returns
string|null

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedRevisionItem, and MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 56 of file RevDelRevisionItem.php.

◆ getRevisionLink()

MediaWiki\RevisionDelete\RevDelRevisionItem::getRevisionLink ( )
protected

Get the HTML link to the revision text.

Overridden by RevDelArchiveItem.

Returns
string

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 152 of file RevDelRevisionItem.php.

◆ getRevisionRecord()

MediaWiki\RevisionDelete\RevDelRevisionItem::getRevisionRecord ( )
protected

Get the RevisionRecord for the item.

Definition at line 51 of file RevDelRevisionItem.php.

◆ getTags()

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

Definition at line 230 of file RevDelRevisionItem.php.

◆ getTimestampField()

MediaWiki\RevisionDelete\RevDelRevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.Override this function.

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 61 of file RevDelRevisionItem.php.

◆ initRevisionRecord()

static MediaWiki\RevisionDelete\RevDelRevisionItem::initRevisionRecord ( $list,
$row )
staticprotected

Create RevisionRecord object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
RevisionRecord

Reimplemented in MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 42 of file RevDelRevisionItem.php.

References MediaWiki\RevisionList\RevisionItemBase\$row, and MediaWiki\MediaWikiServices\getInstance().

◆ isDeleted()

MediaWiki\RevisionDelete\RevDelRevisionItem::isDeleted ( )

◆ isHideCurrentOp()

MediaWiki\RevisionDelete\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 MediaWiki\RevisionDelete\RevDelItem.

Definition at line 142 of file RevDelRevisionItem.php.

◆ setBits()

MediaWiki\RevisionDelete\RevDelRevisionItem::setBits ( $bits)

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 MediaWiki\RevisionDelete\RevDelItem.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedRevisionItem, and MediaWiki\RevisionDelete\RevDelArchiveItem.

Definition at line 102 of file RevDelRevisionItem.php.

References MediaWiki\MediaWikiServices\getInstance().

Member Data Documentation

◆ $revisionRecord

RevisionRecord MediaWiki\RevisionDelete\RevDelRevisionItem::$revisionRecord

Definition at line 27 of file RevDelRevisionItem.php.


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