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
Title	$title
	*
Protected Member Functions
	initCurrent ()
	Initialise the current iteration pointer.
Protected Attributes
bool object	$current
	*
array	$ids
	*
	$res

---

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:

IContextSource	$context
Title	$title

Definition at line 40 of file RevisionList.php.

---

Member Function Documentation

RevisionListBase::current

(

)

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

Returns:

Revision

Definition at line 92 of file RevisionList.php.

Referenced by RevDelList\setVisibility().

RevisionListBase::doQuery

(

$

db

)

[abstract]

Do the DB query to iterate through the objects.

Parameters:

DatabaseBase

$db

DatabaseBase object to use for the query

Reimplemented in RevisionList, RevDelLogList, RevDelRevisionList, RevDelFileList, RevDelArchivedFileList, and RevDelArchiveList.

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

RevisionListBase::filterByIds

(

array $

ids

)

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

Parameters:

array

$ids

Definition at line 49 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 RevisionList, RevDelRevisionList, RevDelFileList, RevDelArchivedFileList, RevDelArchiveList, and RevDelLogList.

Definition at line 58 of file RevisionList.php.

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

RevisionListBase::initCurrent

(

)

[protected]

Initialise the current iteration pointer.

Definition at line 65 of file RevisionList.php.

RevisionListBase::length

(

)

Get the number of items in the list.

Returns:

int

Definition at line 110 of file RevisionList.php.

RevisionListBase::newItem

(

$

row

)

[abstract]

Create an item object from a DB result row.

Parameters:

object

$row

Reimplemented in RevisionList, RevDelRevisionList, RevDelLogList, RevDelFileList, RevDelArchiveList, and RevDelArchivedFileList.

RevisionListBase::next

(

)

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

Returns:

Revision

Definition at line 100 of file RevisionList.php.

Referenced by RevDelList\setVisibility().

RevisionListBase::reset

(

)

Start iteration.

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

Returns:

Revision First list item

Definition at line 78 of file RevisionList.php.

Referenced by RevDelList\setVisibility().

---

Member Data Documentation

bool object RevisionListBase::$current [protected]

*

Definition at line 33 of file RevisionList.php.

array RevisionListBase::$ids [protected]

*

Definition at line 29 of file RevisionList.php.

Referenced by RevDelList\__construct(), RevDelArchivedFileList\doQuery(), and RevDelLogList\doQuery().

RevisionListBase::$res [protected]

Definition at line 31 of file RevisionList.php.

Title RevisionListBase::$title

*

Definition at line 27 of file RevisionList.php.

---

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

• includes/RevisionList.php