MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\RevisionList\RevisionItemBase Class Reference

Abstract base class for revision items. More...

Inherited by ChangeTagsLogItem, MediaWiki\RevisionList\RevisionItem, and RevDelItem.

Collaboration diagram for MediaWiki\RevisionList\RevisionItemBase:
Collaboration graph
[legend]

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.
 
 formatDate ()
 Get the date, formatted in user's language.
 
 formatTime ()
 Get the time, formatted in user's language.
 
 getAuthorActor ()
 Get the author actor ID.
 
 getAuthorActorField ()
 Get the DB field name storing actor ids.
 
 getAuthorId ()
 Get the author user ID.
 
 getAuthorIdField ()
 Get the DB field name storing user ids.
 
 getAuthorName ()
 Get the author user name.
 
 getAuthorNameField ()
 Get the DB field name storing user names.
 
 getHTML ()
 Get the HTML of the list item.
 
 getId ()
 Get the ID, as it would appear in the ids URL parameter.
 
 getIdField ()
 Get the DB field name associated with the ID list.
 
 getTimestamp ()
 Get the timestamp in MW 14-char form.
 
 getTimestampField ()
 Get the DB field name storing timestamps.
 

Protected Member Functions

 getLinkRenderer ()
 Returns an instance of LinkRenderer.
 

Protected Attributes

RevisionListBase $list
 The parent.
 
stdClass $row
 The database result row.
 

Detailed Description

Abstract base class for revision items.

Definition at line 32 of file RevisionItemBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RevisionList\RevisionItemBase::__construct ( RevisionListBase $list,
$row )
Parameters
RevisionListBase$list
stdClass$rowDB result row

Reimplemented in RevDelArchivedFileItem, RevDelFileItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

Definition at line 43 of file RevisionItemBase.php.

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

Member Function Documentation

◆ canView()

MediaWiki\RevisionList\RevisionItemBase::canView ( )
abstract

Returns true if the current user can view the item.

Returns
bool

Reimplemented in ChangeTagsLogItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

◆ canViewContent()

MediaWiki\RevisionList\RevisionItemBase::canViewContent ( )
abstract

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

Returns
bool

Reimplemented in ChangeTagsLogItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

◆ formatDate()

MediaWiki\RevisionList\RevisionItemBase::formatDate ( )

Get the date, formatted in user's language.

Returns
string

Definition at line 107 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getTimestamp().

◆ formatTime()

MediaWiki\RevisionList\RevisionItemBase::formatTime ( )

Get the time, formatted in user's language.

Returns
string

Definition at line 116 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getTimestamp().

◆ getAuthorActor()

MediaWiki\RevisionList\RevisionItemBase::getAuthorActor ( )

Get the author actor ID.

Since
1.31
Returns
string

Definition at line 153 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getAuthorActorField().

◆ getAuthorActorField()

MediaWiki\RevisionList\RevisionItemBase::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
string|false

Reimplemented in ChangeTagsLogItem, RevDelArchivedFileItem, RevDelArchiveItem, RevDelFileItem, RevDelLogItem, and RevDelRevisionItem.

Definition at line 90 of file RevisionItemBase.php.

Referenced by MediaWiki\RevisionList\RevisionItemBase\getAuthorActor().

◆ getAuthorId()

MediaWiki\RevisionList\RevisionItemBase::getAuthorId ( )

Get the author user ID.

Returns
int

Definition at line 134 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getAuthorIdField().

◆ getAuthorIdField()

MediaWiki\RevisionList\RevisionItemBase::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
string|false

Reimplemented in ChangeTagsLogItem, RevDelArchivedFileItem, RevDelArchiveItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

Definition at line 71 of file RevisionItemBase.php.

Referenced by MediaWiki\RevisionList\RevisionItemBase\getAuthorId().

◆ getAuthorName()

MediaWiki\RevisionList\RevisionItemBase::getAuthorName ( )

Get the author user name.

Returns
string

Definition at line 143 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getAuthorNameField().

◆ getAuthorNameField()

MediaWiki\RevisionList\RevisionItemBase::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
string|false

Reimplemented in ChangeTagsLogItem, RevDelArchivedFileItem, RevDelArchiveItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

Definition at line 80 of file RevisionItemBase.php.

Referenced by MediaWiki\RevisionList\RevisionItemBase\getAuthorName().

◆ getHTML()

MediaWiki\RevisionList\RevisionItemBase::getHTML ( )
abstract

Get the HTML of the list item.

Should be include "<li></li>" tags. This is used to show the list in HTML form, by the special page.

Returns
string HTML

Reimplemented in ChangeTagsLogItem, ChangeTagsRevisionItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

◆ getId()

MediaWiki\RevisionList\RevisionItemBase::getId ( )

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

Returns
int|string

Reimplemented in RevDelArchivedFileItem, RevDelArchivedRevisionItem, RevDelArchiveItem, and RevDelFileItem.

Definition at line 98 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getIdField().

◆ getIdField()

MediaWiki\RevisionList\RevisionItemBase::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
string|null

Reimplemented in ChangeTagsLogItem, RevDelArchivedFileItem, RevDelArchivedRevisionItem, RevDelArchiveItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

Definition at line 53 of file RevisionItemBase.php.

Referenced by MediaWiki\RevisionList\RevisionItemBase\getId().

◆ getLinkRenderer()

MediaWiki\RevisionList\RevisionItemBase::getLinkRenderer ( )
protected

Returns an instance of LinkRenderer.

Returns
LinkRenderer

Definition at line 181 of file RevisionItemBase.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by RevDelArchiveItem\getDiffLink(), RevDelLogItem\getHTML(), RevDelArchivedFileItem\getLink(), RevDelFileItem\getLink(), and RevDelArchiveItem\getRevisionLink().

◆ getTimestamp()

MediaWiki\RevisionList\RevisionItemBase::getTimestamp ( )

Get the timestamp in MW 14-char form.

Returns
string|false

Definition at line 125 of file RevisionItemBase.php.

References MediaWiki\RevisionList\RevisionItemBase\getTimestampField(), and wfTimestamp().

Referenced by MediaWiki\RevisionList\RevisionItemBase\formatDate(), and MediaWiki\RevisionList\RevisionItemBase\formatTime().

◆ getTimestampField()

MediaWiki\RevisionList\RevisionItemBase::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
string|false

Reimplemented in ChangeTagsLogItem, RevDelArchivedFileItem, RevDelArchiveItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and MediaWiki\RevisionList\RevisionItem.

Definition at line 62 of file RevisionItemBase.php.

Referenced by MediaWiki\RevisionList\RevisionItemBase\getTimestamp().

Member Data Documentation

◆ $list

RevisionListBase MediaWiki\RevisionList\RevisionItemBase::$list
protected

The parent.

Definition at line 34 of file RevisionItemBase.php.

Referenced by RevDelRevisionItem\__construct(), MediaWiki\RevisionList\RevisionItem\__construct(), MediaWiki\RevisionList\RevisionItemBase\__construct(), RevDelLogItem\__construct(), RevDelArchivedRevisionItem\__construct(), and RevDelArchiveItem\initRevisionRecord().

◆ $row

stdClass MediaWiki\RevisionList\RevisionItemBase::$row
protected

The database result row.

Definition at line 37 of file RevisionItemBase.php.

Referenced by RevDelArchivedFileItem\__construct(), RevDelFileItem\__construct(), RevDelRevisionItem\__construct(), MediaWiki\RevisionList\RevisionItem\__construct(), MediaWiki\RevisionList\RevisionItemBase\__construct(), RevDelLogItem\__construct(), RevDelArchivedRevisionItem\__construct(), RevDelArchivedFileItem\initFile(), RevDelFileItem\initFile(), RevDelArchiveItem\initRevisionRecord(), and RevDelRevisionItem\initRevisionRecord().

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