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

Item class for a live revision table row. More...

Inherits MediaWiki\RevisionList\RevisionItemBase.

Inherited by MediaWiki\ChangeTags\ChangeTagsRevisionItem.

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

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

 
 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

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

 
 isDeleted ()
 
- 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.
 
 getAuthorActorField ()
 Get the DB field name storing actor ids.
 
 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.
 

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.
 

Protected Attributes

IContextSource $context
 
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 live revision table row.

Definition at line 19 of file RevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RevisionList\RevisionItem::__construct ( RevisionListBase $list,
$row )

Parameters
RevisionListBase$list
stdClass$rowDB result row

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 27 of file RevisionItem.php.

References MediaWiki\RevisionList\RevisionItemBase\$list, MediaWiki\RevisionList\RevisionItemBase\$row, MediaWiki\Context\ContextSource\getContext(), and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ canView()

MediaWiki\RevisionList\RevisionItem::canView ( )

Returns true if the current user can view the item.

Returns
bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 63 of file RevisionItem.php.

◆ canViewContent()

MediaWiki\RevisionList\RevisionItem::canViewContent ( )

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

Returns
bool

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 71 of file RevisionItem.php.

◆ getAuthorIdField()

MediaWiki\RevisionList\RevisionItem::getAuthorIdField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 53 of file RevisionItem.php.

◆ getAuthorNameField()

MediaWiki\RevisionList\RevisionItem::getAuthorNameField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 58 of file RevisionItem.php.

◆ getDiffLink()

MediaWiki\RevisionList\RevisionItem::getDiffLink ( )
protected

Get the HTML link to the diff.

Todo
Essentially a copy of RevDelRevisionItem::getDiffLink. That class should inherit from this one, and implement an appropriate interface instead of extending RevDelItem
Returns
string HTML

Definition at line 119 of file RevisionItem.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsRevisionItem\getHTML().

◆ getHTML()

MediaWiki\RevisionList\RevisionItem::getHTML ( )
Todo
Essentially a copy of RevDelRevisionItem::getHTML. That class should inherit from this one, and implement an appropriate interface instead of extending RevDelItem
Returns
string HTML

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Reimplemented in MediaWiki\ChangeTags\ChangeTagsRevisionItem.

Definition at line 143 of file RevisionItem.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getIdField()

MediaWiki\RevisionList\RevisionItem::getIdField ( )

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

Returns
string|null

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 43 of file RevisionItem.php.

◆ getRevisionLink()

MediaWiki\RevisionList\RevisionItem::getRevisionLink ( )
protected

Get the HTML link to the revision text.

Todo
Essentially a copy of RevDelRevisionItem::getRevisionLink. That class should inherit from this one, and implement an appropriate interface instead of extending RevDelItem
Returns
string HTML

Definition at line 92 of file RevisionItem.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsRevisionItem\getHTML().

◆ getRevisionRecord()

MediaWiki\RevisionList\RevisionItem::getRevisionRecord ( )
protected

Get the RevisionRecord for the item.

Definition at line 38 of file RevisionItem.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsRevisionItem\getHTML().

◆ getTimestampField()

MediaWiki\RevisionList\RevisionItem::getTimestampField ( )

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

Returns
string|false

Reimplemented from MediaWiki\RevisionList\RevisionItemBase.

Definition at line 48 of file RevisionItem.php.

◆ isDeleted()

MediaWiki\RevisionList\RevisionItem::isDeleted ( )
Returns
bool

Definition at line 81 of file RevisionItem.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsRevisionItem\getHTML().

Member Data Documentation

◆ $context

IContextSource MediaWiki\RevisionList\RevisionItem::$context
protected

Definition at line 24 of file RevisionItem.php.

◆ $revisionRecord

RevisionRecord MediaWiki\RevisionList\RevisionItem::$revisionRecord
protected

Definition at line 21 of file RevisionItem.php.

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