MediaWiki REL1_34
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RevisionItemBase Class Reference

Abstract base class for revision items. More...

Inheritance diagram for RevisionItemBase:
Inheritance graph
[legend]
Collaboration diagram for RevisionItemBase:
Collaboration graph
[legend]

Public Member Functions

 __construct ( $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.
 
 $row
 The database result row.
 

Detailed Description

Abstract base class for revision items.

Definition at line 28 of file RevisionItemBase.php.

Constructor & Destructor Documentation

◆ __construct()

RevisionItemBase::__construct ( $list,
$row )
Parameters
RevisionListBase$list
object$rowDB result row

Reimplemented in RevDelArchivedFileItem, RevDelFileItem, RevDelRevisionItem, and RevisionItem.

Definition at line 39 of file RevisionItemBase.php.

References $list, and $row.

Member Function Documentation

◆ canView()

RevisionItemBase::canView ( )
abstract

Returns true if the current user can view the item.

Reimplemented in ChangeTagsLogItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and RevisionItem.

◆ canViewContent()

RevisionItemBase::canViewContent ( )
abstract

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

Reimplemented in ChangeTagsLogItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and RevisionItem.

◆ formatDate()

RevisionItemBase::formatDate ( )

Get the date, formatted in user's language.

Returns
string

Definition at line 103 of file RevisionItemBase.php.

References getTimestamp().

◆ formatTime()

RevisionItemBase::formatTime ( )

Get the time, formatted in user's language.

Returns
string

Definition at line 112 of file RevisionItemBase.php.

References getTimestamp().

◆ getAuthorActor()

RevisionItemBase::getAuthorActor ( )

Get the author actor ID.

Since
1.31
Returns
string

Definition at line 149 of file RevisionItemBase.php.

References getAuthorActorField().

◆ getAuthorActorField()

RevisionItemBase::getAuthorActorField ( )

Get the DB field name storing actor ids.

Override this function.

Since
1.31
Returns
bool

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

Definition at line 86 of file RevisionItemBase.php.

Referenced by getAuthorActor().

◆ getAuthorId()

RevisionItemBase::getAuthorId ( )

Get the author user ID.

Returns
int

Definition at line 130 of file RevisionItemBase.php.

References getAuthorIdField().

◆ getAuthorIdField()

RevisionItemBase::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
bool

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

Definition at line 67 of file RevisionItemBase.php.

Referenced by getAuthorId().

◆ getAuthorName()

RevisionItemBase::getAuthorName ( )

Get the author user name.

Returns
string

Definition at line 139 of file RevisionItemBase.php.

References getAuthorNameField().

◆ getAuthorNameField()

RevisionItemBase::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
bool

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

Definition at line 76 of file RevisionItemBase.php.

Referenced by getAuthorName().

◆ getHTML()

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.

Reimplemented in ChangeTagsLogItem, ChangeTagsRevisionItem, RevDelFileItem, RevDelLogItem, RevDelRevisionItem, and RevisionItem.

◆ getId()

RevisionItemBase::getId ( )

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

Returns
int

Reimplemented in RevDelArchivedFileItem, RevDelArchivedRevisionItem, RevDelArchiveItem, and RevDelFileItem.

Definition at line 94 of file RevisionItemBase.php.

References getIdField().

Referenced by RevDelRevisionItem\isHideCurrentOp().

◆ getIdField()

RevisionItemBase::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
null

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

Definition at line 49 of file RevisionItemBase.php.

Referenced by getId().

◆ getLinkRenderer()

RevisionItemBase::getLinkRenderer ( )
protected

Returns an instance of LinkRenderer.

Returns
\MediaWiki\Linker\LinkRenderer

Definition at line 174 of file RevisionItemBase.php.

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

◆ getTimestamp()

RevisionItemBase::getTimestamp ( )

Get the timestamp in MW 14-char form.

Returns
mixed

Definition at line 121 of file RevisionItemBase.php.

References getTimestampField(), and wfTimestamp().

Referenced by formatDate(), and formatTime().

◆ getTimestampField()

RevisionItemBase::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
bool

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

Definition at line 58 of file RevisionItemBase.php.

Referenced by getTimestamp().

Member Data Documentation

◆ $list

RevisionListBase RevisionItemBase::$list
protected

The parent.

Definition at line 30 of file RevisionItemBase.php.

Referenced by RevDelRevisionItem\__construct(), RevisionItem\__construct(), __construct(), and RevDelArchiveItem\initRevision().

◆ $row

RevisionItemBase::$row
protected

The database result row.

Definition at line 33 of file RevisionItemBase.php.

Referenced by RevDelArchivedFileItem\__construct(), RevDelFileItem\__construct(), RevDelRevisionItem\__construct(), RevisionItem\__construct(), __construct(), RevDelArchivedFileItem\initFile(), RevDelFileItem\initFile(), RevDelArchiveItem\initRevision(), and RevDelRevisionItem\initRevision().

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