MediaWiki REL1_30
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.
 
 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 319 of file RevisionList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from RevisionItemBase.

Definition at line 326 of file RevisionList.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 348 of file RevisionList.php.

References Revision\DELETED_RESTRICTED.

◆ canViewContent()

RevisionItem::canViewContent ( )

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

Reimplemented from RevisionItemBase.

Definition at line 352 of file RevisionList.php.

References Revision\DELETED_TEXT.

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 340 of file RevisionList.php.

◆ getAuthorNameField()

RevisionItem::getAuthorNameField ( )

Get the DB field name storing user names.

Override this function.

Returns
bool

Reimplemented from RevisionItemBase.

Definition at line 344 of file RevisionList.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 393 of file RevisionList.php.

References $linkRenderer, 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 417 of file RevisionList.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 332 of file RevisionList.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 367 of file RevisionList.php.

References $linkRenderer, 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 336 of file RevisionList.php.

◆ isDeleted()

RevisionItem::isDeleted ( )

Definition at line 356 of file RevisionList.php.

References Revision\DELETED_TEXT.

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

Member Data Documentation

◆ $context

RequestContext RevisionItem::$context
protected

Definition at line 324 of file RevisionList.php.

◆ $revision

Revision RevisionItem::$revision
protected

Definition at line 321 of file RevisionList.php.

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