Abstract base class for revision items. More...

Inheritance diagram for RevisionItemBase:

[legend]

Collaboration diagram for RevisionItemBase:

[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 29 of file RevisionItemBase.php.

Constructor & Destructor Documentation

◆ __construct()

RevisionItemBase::__construct	(	RevisionListBase	$list,
			$row
	)

Parameters

RevisionListBase	$list
stdClass	$row	DB result row

Reimplemented in RevDelArchivedFileItem, RevDelFileItem, RevDelRevisionItem, and RevisionItem.

Definition at line 40 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.

Returns: bool

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

◆ canViewContent()

RevisionItemBase::canViewContent ( )

abstract

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

Returns: bool

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

◆ formatDate()

RevisionItemBase::formatDate ( )

Get the date, formatted in user's language.

Returns: string

Definition at line 104 of file RevisionItemBase.php.

References getTimestamp().

◆ formatTime()

RevisionItemBase::formatTime ( )

Get the time, formatted in user's language.

Returns: string

Definition at line 113 of file RevisionItemBase.php.

References getTimestamp().

◆ getAuthorActor()

RevisionItemBase::getAuthorActor ( )

Get the author actor ID.

Since: 1.31

Returns: string

Definition at line 150 of file RevisionItemBase.php.

References getAuthorActorField().

◆ getAuthorActorField()

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 87 of file RevisionItemBase.php.

Referenced by getAuthorActor().

◆ getAuthorId()

RevisionItemBase::getAuthorId ( )

Get the author user ID.

Returns: int

Definition at line 131 of file RevisionItemBase.php.

References getAuthorIdField().

◆ getAuthorIdField()

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 RevisionItem.

Definition at line 68 of file RevisionItemBase.php.

Referenced by getAuthorId().

◆ getAuthorName()

RevisionItemBase::getAuthorName ( )

Get the author user name.

Returns: string

Definition at line 140 of file RevisionItemBase.php.

References getAuthorNameField().

◆ getAuthorNameField()

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 RevisionItem.

Definition at line 77 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.

Returns: string HTML

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 95 of file RevisionItemBase.php.

References getIdField().

◆ getIdField()

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 RevisionItem.

Definition at line 50 of file RevisionItemBase.php.

Referenced by getId().

◆ getLinkRenderer()

RevisionItemBase::getLinkRenderer ( )

protected

Returns an instance of LinkRenderer.

Returns: LinkRenderer

Definition at line 178 of file RevisionItemBase.php.

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

◆ getTimestamp()

RevisionItemBase::getTimestamp ( )

Get the timestamp in MW 14-char form.

Returns: string|false

Definition at line 122 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: string|false

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

Definition at line 59 of file RevisionItemBase.php.

Referenced by getTimestamp().

Member Data Documentation

◆ $list

RevisionListBase RevisionItemBase::$list

protected

The parent.

Definition at line 31 of file RevisionItemBase.php.

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

◆ $row

stdClass RevisionItemBase::$row

protected

The database result row.

Definition at line 34 of file RevisionItemBase.php.

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

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

includes/revisionlist/RevisionItemBase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canView()

◆ canViewContent()

◆ formatDate()

◆ formatTime()

◆ getAuthorActor()

◆ getAuthorActorField()

◆ getAuthorId()

◆ getAuthorIdField()

◆ getAuthorName()

◆ getAuthorNameField()

◆ getHTML()

◆ getId()

◆ getIdField()

◆ getLinkRenderer()

◆ getTimestamp()

◆ getTimestampField()

Member Data Documentation

◆ $list

◆ $row