RevisionItemBase Class Reference

Abstract base class for revision items. More...

Inheritance diagram for RevisionItemBase:

List of all members.

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.
	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.
Public Attributes
	$list
	The parent RevisionListBase.
	$row
	The DB result row.

---

Detailed Description

Abstract base class for revision items.

Definition at line 130 of file RevisionList.php.

---

Constructor & Destructor Documentation

RevisionItemBase::__construct	(	$	list,
		$	row
	)

Parameters:

$list	RevisionListBase
$row	DB result row

Reimplemented in RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchivedRevisionItem, RevDel_ArchiveItem, RevisionItem, and RevDel_RevisionItem.

Definition at line 141 of file RevisionList.php.

---

Member Function Documentation

RevisionItemBase::canView

(

)

[abstract]

Returns true if the current user can view the item.

Reimplemented in RevDel_LogItem, RevDel_FileItem, RevisionItem, and RevDel_RevisionItem.

RevisionItemBase::canViewContent

(

)

[abstract]

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

Reimplemented in RevDel_LogItem, RevDel_FileItem, RevisionItem, and RevDel_RevisionItem.

RevisionItemBase::formatDate

(

)

Get the date, formatted in user's language.

Returns:

String

Definition at line 195 of file RevisionList.php.

RevisionItemBase::formatTime

(

)

Get the time, formatted in user's language.

Returns:

String

Definition at line 204 of file RevisionList.php.

RevisionItemBase::getAuthorId

(

)

Get the author user ID.

Returns:

int

Definition at line 222 of file RevisionList.php.

RevisionItemBase::getAuthorIdField

(

)

Get the DB field name storing user ids.

Override this function.

Returns:

bool

Reimplemented in RevDel_LogItem, RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchiveItem, RevisionItem, and RevDel_RevisionItem.

Definition at line 169 of file RevisionList.php.

RevisionItemBase::getAuthorName

(

)

Get the author user name.

Returns:

string

Definition at line 231 of file RevisionList.php.

RevisionItemBase::getAuthorNameField

(

)

Get the DB field name storing user names.

Override this function.

Returns:

bool

Reimplemented in RevDel_LogItem, RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchiveItem, RevisionItem, and RevDel_RevisionItem.

Definition at line 178 of file RevisionList.php.

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 RevDel_LogItem, RevDel_FileItem, RevisionItem, and RevDel_RevisionItem.

RevisionItemBase::getId

(

)

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

Returns:

Reimplemented in RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchivedRevisionItem, and RevDel_ArchiveItem.

Definition at line 186 of file RevisionList.php.

Referenced by RevDel_RevisionItem\isHideCurrentOp().

RevisionItemBase::getIdField

(

)

Get the DB field name associated with the ID list.

Override this function.

Returns:

null

Reimplemented in RevDel_LogItem, RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchivedRevisionItem, RevDel_ArchiveItem, RevisionItem, and RevDel_RevisionItem.

Definition at line 151 of file RevisionList.php.

RevisionItemBase::getTimestamp

(

)

Get the timestamp in MW 14-char form.

Returns:

Mixed

Definition at line 213 of file RevisionList.php.

RevisionItemBase::getTimestampField

(

)

Get the DB field name storing timestamps.

Override this function.

Returns:

bool

Reimplemented in RevDel_LogItem, RevDel_ArchivedFileItem, RevDel_FileItem, RevDel_ArchiveItem, RevisionItem, and RevDel_RevisionItem.

Definition at line 160 of file RevisionList.php.

---

Member Data Documentation

RevisionItemBase::$list

The parent RevisionListBase.

Definition at line 132 of file RevisionList.php.

Referenced by RevDel_RevisionItem\__construct(), RevisionItem\__construct(), RevDel_ArchiveItem\__construct(), RevDel_ArchivedRevisionItem\__construct(), RevDel_FileItem\__construct(), and RevDel_ArchivedFileItem\__construct().

RevisionItemBase::$row

The DB result row.

Definition at line 135 of file RevisionList.php.

Referenced by RevDel_RevisionItem\__construct(), RevisionItem\__construct(), RevDel_ArchiveItem\__construct(), RevDel_ArchivedRevisionItem\__construct(), RevDel_FileItem\__construct(), and RevDel_ArchivedFileItem\__construct().

---

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

• includes/RevisionList.php