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

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

Inheritance diagram for RevisionItem:
Inheritance graph
[legend]
Collaboration diagram for RevisionItem:
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.
 
 getAuthorIdField ()
 Get the DB field name storing user ids.
 
 getAuthorNameField ()
 Get the DB field name storing user names.
 
 getHTML ()
 
 getIdField ()
 Get the DB field name associated with the ID list.
 
 getTimestampField ()
 Get the DB field name storing timestamps.
 
 isDeleted ()
 
- Public Member Functions inherited from 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.
 
- Protected Member Functions inherited from RevisionItemBase
 getLinkRenderer ()
 Returns an instance of LinkRenderer.
 

Protected Attributes

RequestContext $context
 
Revision $revision
 
- Protected Attributes inherited from RevisionItemBase
RevisionListBase $list
 The parent.
 
 $row
 The database result row.
 

Detailed Description

Item class for a live revision table row.

Definition at line 28 of file RevisionItem.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from RevisionItemBase.

Definition at line 35 of file RevisionItem.php.

References RevisionItemBase\$list, RevisionItemBase\$row, and ContextSource\getContext().

Member Function Documentation

◆ canView()

RevisionItem::canView ( )

Returns true if the current user can view the item.

Reimplemented from RevisionItemBase.

Definition at line 57 of file RevisionItem.php.

◆ canViewContent()

RevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 63 of file RevisionItem.php.

Referenced by getDiffLink(), and getRevisionLink().

◆ getAuthorIdField()

RevisionItem::getAuthorIdField ( )

Get the DB field name storing user ids.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 49 of file RevisionItem.php.

◆ getAuthorNameField()

RevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 53 of file RevisionItem.php.

◆ getDiffLink()

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

Definition at line 106 of file RevisionItem.php.

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

Referenced by ChangeTagsRevisionItem\getHTML(), and getHTML().

◆ getHTML()

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

Reimplemented from RevisionItemBase.

Reimplemented in ChangeTagsRevisionItem.

Definition at line 130 of file RevisionItem.php.

References getDiffLink(), getRevisionLink(), isDeleted(), Linker\revComment(), and Linker\revUserLink().

◆ getIdField()

RevisionItem::getIdField ( )

Get the DB field name associated with the ID list.

Override this function.

Returns
null

Reimplemented from RevisionItemBase.

Definition at line 41 of file RevisionItem.php.

◆ getRevisionLink()

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

Definition at line 80 of file RevisionItem.php.

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

Referenced by ChangeTagsRevisionItem\getHTML(), and getHTML().

◆ getTimestampField()

RevisionItem::getTimestampField ( )

Get the DB field name storing timestamps.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 45 of file RevisionItem.php.

◆ isDeleted()

RevisionItem::isDeleted ( )

Definition at line 69 of file RevisionItem.php.

Referenced by getDiffLink(), ChangeTagsRevisionItem\getHTML(), getHTML(), and getRevisionLink().

Member Data Documentation

◆ $context

RequestContext RevisionItem::$context
protected

Definition at line 33 of file RevisionItem.php.

◆ $revision

Revision RevisionItem::$revision
protected

Definition at line 30 of file RevisionItem.php.

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