MediaWiki  master
RevDelRevisionItem Class Reference
Inheritance diagram for RevDelRevisionItem:
Collaboration diagram for RevDelRevisionItem:

Public Member Functions

 __construct (RevisionListBase $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

RevisionRecord $revisionRecord
 

Protected Member Functions

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

Static Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

Definition at line 30 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 34 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 81 of file RevDelRevisionItem.php.

References getRevisionRecord().

◆ canViewContent()

RevDelRevisionItem::canViewContent ( )

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

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 88 of file RevDelRevisionItem.php.

References getRevisionRecord().

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

References getRevisionRecord(), and 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 77 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 69 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 73 of file RevDelRevisionItem.php.

◆ getBits()

RevDelRevisionItem::getBits ( )

Get the current deletion bitfield value.

Returns
int

Reimplemented from RevDelItem.

Definition at line 95 of file RevDelRevisionItem.php.

References getRevisionRecord().

◆ 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.

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

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

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

◆ getIdField()

RevDelRevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented from RevisionItemBase.

Reimplemented in RevDelArchiveItem, and RevDelArchivedRevisionItem.

Definition at line 61 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 canViewContent(), RevisionItemBase\getLinkRenderer(), getRevisionRecord(), RevisionItemBase\getTimestamp(), and isDeleted().

Referenced by getHTML().

◆ getRevisionRecord()

RevDelRevisionItem::getRevisionRecord ( )
protected

Get the RevisionRecord for the item.

Returns
RevisionRecord

Definition at line 57 of file RevDelRevisionItem.php.

References $revisionRecord.

Referenced by canView(), canViewContent(), getApiData(), getBits(), getHTML(), RevDelArchivedRevisionItem\getId(), getRevisionLink(), isDeleted(), and setBits().

◆ getTags()

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

Definition at line 222 of file RevDelRevisionItem.php.

Referenced by getHTML().

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

◆ initRevisionRecord()

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

Create revision object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
RevisionRecord

Reimplemented in RevDelArchiveItem.

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

References RevisionItemBase\getId().

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

References DB_MASTER, getRevisionRecord(), RecentChange\PRC_AUTOPATROLLED, and wfGetDB().

Member Data Documentation

◆ $revisionRecord

RevisionRecord RevDelRevisionItem::$revisionRecord

Definition at line 32 of file RevDelRevisionItem.php.

Referenced by getRevisionRecord().


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