RevisionListBase Class Reference

List for revision table items for a single page. More...

Inheritance diagram for RevisionListBase:

Collaboration diagram for RevisionListBase:

List of all members.

Public Member Functions
	__construct (IContextSource $context, Title $title)
	Construct a revision list for a given title.
	current ()
	Get the current list item, or false if we are at the end.
	doQuery ($db)
	Do the DB query to iterate through the objects.
	filterByIds (array $ids)
	Select items only where the ID is any of the specified values.
	getType ()
	Get the internal type name of this list.
	length ()
	Get the number of items in the list.
	newItem ($row)
	Create an item object from a DB result row.
	next ()
	Move the iteration pointer to the next list item, and return it.
	reset ()
	Start iteration.
Public Attributes
	$current
	$ids
	$res
Title	$title
Protected Member Functions
	initCurrent ()
	Initialise the current iteration pointer.

---

Detailed Description

List for revision table items for a single page.

Definition at line 26 of file RevisionList.php.

---

Constructor & Destructor Documentation

RevisionListBase::__construct	(	IContextSource $	context,
		Title $	title
	)

Construct a revision list for a given title.

Parameters:

$context	IContextSource
$title	Title

Definition at line 38 of file RevisionList.php.

---

Member Function Documentation

RevisionListBase::current

(

)

Get the current list item, or false if we are at the end.

Definition at line 89 of file RevisionList.php.

Referenced by RevDel_List\setVisibility().

RevisionListBase::doQuery

(

$

db

)

[abstract]

Do the DB query to iterate through the objects.

Parameters:

$db	DatabaseBase object to use for the query

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

Referenced by RevDel_List\reloadFromMaster(), and RevDel_List\setVisibility().

RevisionListBase::filterByIds

(

array $

ids

)

Select items only where the ID is any of the specified values.

Parameters:

$ids

Array

Definition at line 47 of file RevisionList.php.

RevisionListBase::getType

(

)

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns:

null

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

Definition at line 56 of file RevisionList.php.

Referenced by RevDel_List\getLogParams(), and RevDel_List\updateLog().

RevisionListBase::initCurrent

(

)

[protected]

Initialise the current iteration pointer.

Definition at line 63 of file RevisionList.php.

RevisionListBase::length

(

)

Get the number of items in the list.

Returns:

int

Definition at line 106 of file RevisionList.php.

RevisionListBase::newItem

(

$

row

)

[abstract]

Create an item object from a DB result row.

Parameters:

$row

stdclass

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

RevisionListBase::next

(

)

Move the iteration pointer to the next list item, and return it.

Definition at line 96 of file RevisionList.php.

Referenced by RevDel_List\setVisibility().

RevisionListBase::reset

(

)

Start iteration.

This must be called before current() or next().

Returns:

First list item

Definition at line 76 of file RevisionList.php.

Referenced by RevDel_List\setVisibility().

---

Member Data Documentation

RevisionListBase::$current

Definition at line 31 of file RevisionList.php.

RevisionListBase::$ids

Definition at line 31 of file RevisionList.php.

Referenced by RevDel_List\__construct(), and RevDel_RevisionList\doQuery().

RevisionListBase::$res

Definition at line 31 of file RevisionList.php.

Title RevisionListBase::$title

Definition at line 29 of file RevisionList.php.

---

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

• includes/RevisionList.php