MediaWiki master
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
MediaWiki\RevisionDelete\RevDelArchiveItem Class Reference

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

Inherits MediaWiki\RevisionDelete\RevDelRevisionItem.

Inherited by MediaWiki\RevisionDelete\RevDelArchivedRevisionItem.

Collaboration diagram for MediaWiki\RevisionDelete\RevDelArchiveItem:
Collaboration graph
[legend]

Public Member Functions

 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

 
 getId ()
 Get the ID, as it would appear in the ids URL parameter.
Returns
int|string

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

Returns
string|null

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

Returns
string|false

 
 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\RevDelRevisionItem
 __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

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

 
 getHTML ()
 
 getTags ()
 
 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

 
- 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.
 
 getTimestamp ()
 Get the timestamp in MW 14-char form.
 

Protected Member Functions

 getDiffLink ()
 Get the HTML link to the diff.Overridden by RevDelArchiveItem

Returns
string

 
 getRevisionLink ()
 Get the HTML link to the revision text.Overridden by RevDelArchiveItem.

Returns
string

 
- Protected Member Functions inherited from MediaWiki\RevisionDelete\RevDelRevisionItem
 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.
Parameters
RevisionListBase$list
mixed$row
Returns
RevisionRecord

 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\RevisionDelete\RevDelRevisionItem
RevisionRecord $revisionRecord
 
- Protected Attributes inherited from MediaWiki\RevisionList\RevisionItemBase
RevisionListBase $list
 The parent.
 
stdClass $row
 The database result row.
 

Detailed Description

Item class for a archive table row.

Definition at line 17 of file RevDelArchiveItem.php.

Member Function Documentation

◆ getAuthorActorField()

MediaWiki\RevisionDelete\RevDelArchiveItem::getAuthorActorField ( )

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

Since
1.31
Returns
string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 53 of file RevDelArchiveItem.php.

◆ getAuthorIdField()

MediaWiki\RevisionDelete\RevDelArchiveItem::getAuthorIdField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 43 of file RevDelArchiveItem.php.

◆ getAuthorNameField()

MediaWiki\RevisionDelete\RevDelArchiveItem::getAuthorNameField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 48 of file RevDelArchiveItem.php.

◆ getDiffLink()

MediaWiki\RevisionDelete\RevDelArchiveItem::getDiffLink ( )
protected

Get the HTML link to the diff.Overridden by RevDelArchiveItem

Returns
string

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 103 of file RevDelArchiveItem.php.

References MediaWiki\RevisionDelete\RevDelRevisionItem\canViewContent(), MediaWiki\RevisionList\RevisionItemBase\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\RevisionDelete\RevDelRevisionItem\isDeleted().

◆ getId()

MediaWiki\RevisionDelete\RevDelArchiveItem::getId ( )

Get the ID, as it would appear in the ids URL parameter.

Returns
int|string

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedRevisionItem.

Definition at line 58 of file RevDelArchiveItem.php.

◆ getIdField()

MediaWiki\RevisionDelete\RevDelArchiveItem::getIdField ( )

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

Returns
string|null

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedRevisionItem.

Definition at line 33 of file RevDelArchiveItem.php.

◆ getRevisionLink()

MediaWiki\RevisionDelete\RevDelArchiveItem::getRevisionLink ( )
protected

Get the HTML link to the revision text.Overridden by RevDelArchiveItem.

Returns
string

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 83 of file RevDelArchiveItem.php.

References MediaWiki\RevisionDelete\RevDelRevisionItem\canViewContent(), MediaWiki\RevisionList\RevisionItemBase\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\RevisionDelete\RevDelRevisionItem\isDeleted().

◆ getTimestampField()

MediaWiki\RevisionDelete\RevDelArchiveItem::getTimestampField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 38 of file RevDelArchiveItem.php.

◆ initRevisionRecord()

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

Create RevisionRecord object from $row sourced from $list.

Parameters
RevisionListBase$list
mixed$row
Returns
RevisionRecord

Reimplemented from MediaWiki\RevisionDelete\RevDelRevisionItem.

Definition at line 19 of file RevDelArchiveItem.php.

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

◆ setBits()

MediaWiki\RevisionDelete\RevDelArchiveItem::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\RevDelRevisionItem.

Reimplemented in MediaWiki\RevisionDelete\RevDelArchivedRevisionItem.

Definition at line 64 of file RevDelArchiveItem.php.

References MediaWiki\MediaWikiServices\getInstance().

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