RevisionItemBase Class Reference

Abstract base class for revision items. More...

Inheritance diagram for RevisionItemBase:

Collaboration 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.
Protected Attributes
RevisionListBase	$list
	The parent *.
	$row
	The database result row.

---

Detailed Description

Abstract base class for revision items.

Definition at line 134 of file RevisionList.php.

---

Constructor & Destructor Documentation

RevisionItemBase::__construct	(	$	list,
		$	row
	)

Parameters:

RevisionListBase	$list
object	$row	DB result row

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

Definition at line 144 of file RevisionList.php.

---

Member Function Documentation

RevisionItemBase::canView

(

)

[abstract]

Returns true if the current user can view the item.

Reimplemented in RevisionItem, RevDelFileItem, RevDelRevisionItem, and RevDelLogItem.

RevisionItemBase::canViewContent

(

)

[abstract]

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

Reimplemented in RevisionItem, RevDelFileItem, RevDelRevisionItem, and RevDelLogItem.

RevisionItemBase::formatDate

(

)

Get the date, formatted in user's language.

Returns:

string

Definition at line 198 of file RevisionList.php.

RevisionItemBase::formatTime

(

)

Get the time, formatted in user's language.

Returns:

string

Definition at line 207 of file RevisionList.php.

RevisionItemBase::getAuthorId

(

)

Get the author user ID.

Returns:

int

Definition at line 225 of file RevisionList.php.

RevisionItemBase::getAuthorIdField

(

)

Get the DB field name storing user ids.

Override this function.

Returns:

bool

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

Definition at line 172 of file RevisionList.php.

RevisionItemBase::getAuthorName

(

)

Get the author user name.

Returns:

string

Definition at line 234 of file RevisionList.php.

RevisionItemBase::getAuthorNameField

(

)

Get the DB field name storing user names.

Override this function.

Returns:

bool

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

Definition at line 181 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 RevisionItem, RevDelFileItem, RevDelRevisionItem, and RevDelLogItem.

RevisionItemBase::getId

(

)

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

Returns:

int

Reimplemented in RevDelFileItem, RevDelArchiveItem, RevDelArchivedFileItem, and RevDelArchivedRevisionItem.

Definition at line 189 of file RevisionList.php.

Referenced by RevDelRevisionItem\isHideCurrentOp().

RevisionItemBase::getIdField

(

)

Get the DB field name associated with the ID list.

Override this function.

Returns:

null

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

Definition at line 154 of file RevisionList.php.

RevisionItemBase::getTimestamp

(

)

Get the timestamp in MW 14-char form.

Returns:

mixed

Definition at line 216 of file RevisionList.php.

RevisionItemBase::getTimestampField

(

)

Get the DB field name storing timestamps.

Override this function.

Returns:

bool

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

Definition at line 163 of file RevisionList.php.

---

Member Data Documentation

RevisionListBase RevisionItemBase::$list [protected]

The parent *.

Definition at line 135 of file RevisionList.php.

Referenced by RevDelArchivedFileItem\__construct(), RevDelArchiveItem\__construct(), RevDelArchivedRevisionItem\__construct(), RevDelFileItem\__construct(), RevDelRevisionItem\__construct(), and RevisionItem\getIdField().

RevisionItemBase::$row [protected]

The database result row.

Definition at line 138 of file RevisionList.php.

Referenced by RevDelArchivedFileItem\__construct(), RevDelArchiveItem\__construct(), RevDelArchivedRevisionItem\__construct(), RevDelFileItem\__construct(), RevDelRevisionItem\__construct(), and RevisionItem\getIdField().

---

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

• includes/RevisionList.php