MediaWiki\RevisionList\RevisionListBase Class Reference

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

Inherits MediaWiki\Context\ContextSource, and Iterator.

Inherited by MediaWiki\ChangeTags\ChangeTagsList, MediaWiki\RevisionList\RevisionList, and RevDelList.

Collaboration diagram for MediaWiki\RevisionList\RevisionListBase:

Public Member Functions
	__construct (IContextSource $context, PageIdentity $page)
	Construct a revision list for a given page identity.
	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.
	getPage ()
	getPageName ()
	getType ()
	Get the internal type name of this list.
	key ()
	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.
	rewind ()
	valid ()
Public Member Functions inherited from MediaWiki\Context\ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.
	getActionName ()
	Get the action name for the current web request.
	getAuthority ()
	getConfig ()
	getContext ()
	Get the base IContextSource object.
	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.
	getLanguage ()
	getLanguageCode ()
	getOutput ()
	getRequest ()
	getSkin ()
	getTiming ()
	getTitle ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Protected Member Functions
	initCurrent ()
	Initialise the current iteration pointer.

Protected Attributes
RevisionItemBase false	$current
int[] null	$ids
PageIdentity	$page
IResultWrapper false	$res

Detailed Description

List for revision table items for a single page.

Definition at line 25 of file RevisionListBase.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\RevisionList\RevisionListBase::__construct	(	IContextSource	$context,
		PageIdentity	$page )

Construct a revision list for a given page identity.

Parameters

IContextSource	$context
PageIdentity	$page

Definition at line 45 of file RevisionListBase.php.

References MediaWiki\RevisionList\RevisionListBase\$page, and MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

current()

MediaWiki\RevisionList\RevisionListBase::current

(

)

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

Returns

RevisionItemBase

Definition at line 126 of file RevisionListBase.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsLogList\updateChangeTagsOnAll(), and MediaWiki\ChangeTags\ChangeTagsRevisionList\updateChangeTagsOnAll().

doQuery()

MediaWiki\RevisionList\RevisionListBase::doQuery ( $db )

abstract

Do the DB query to iterate through the objects.

Parameters

IReadableDatabase

$db

DB object to use for the query

Returns

IResultWrapper

Reimplemented in MediaWiki\ChangeTags\ChangeTagsLogList, MediaWiki\ChangeTags\ChangeTagsRevisionList, RevDelArchivedFileList, RevDelArchiveList, RevDelFileList, RevDelLogList, RevDelRevisionList, and MediaWiki\RevisionList\RevisionList.

Referenced by MediaWiki\ChangeTags\ChangeTagsList\reloadFromPrimary(), and RevDelList\setVisibility().

filterByIds()

MediaWiki\RevisionList\RevisionListBase::filterByIds

(

array

$ids

)

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

Parameters

int[]

$ids

Definition at line 77 of file RevisionListBase.php.

getPage()

MediaWiki\RevisionList\RevisionListBase::getPage

(

)

Definition at line 61 of file RevisionListBase.php.

Referenced by RevDelArchiveList\doQuery(), RevDelRevisionList\emitEvents(), and RevDelArchiveItem\initRevisionRecord().

getPageName()

MediaWiki\RevisionList\RevisionListBase::getPageName

(

)

Access: internal

for use by RevDelItems

Returns

string

Definition at line 69 of file RevisionListBase.php.

getType()

MediaWiki\RevisionList\RevisionListBase::getType

(

)

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns

string|null

Reimplemented in MediaWiki\ChangeTags\ChangeTagsLogList, MediaWiki\ChangeTags\ChangeTagsRevisionList, RevDelArchivedFileList, RevDelArchiveList, RevDelFileList, RevDelLogList, RevDelRevisionList, and MediaWiki\RevisionList\RevisionList.

Definition at line 86 of file RevisionListBase.php.

initCurrent()

MediaWiki\RevisionList\RevisionListBase::initCurrent ( )

protected

Initialise the current iteration pointer.

Definition at line 93 of file RevisionListBase.php.

key()

MediaWiki\RevisionList\RevisionListBase::key

(

)

Definition at line 142 of file RevisionListBase.php.

length()

MediaWiki\RevisionList\RevisionListBase::length

(

)

Get the number of items in the list.

Returns

int

Definition at line 154 of file RevisionListBase.php.

newItem()

MediaWiki\RevisionList\RevisionListBase::newItem ( $row )

abstract

Create an item object from a DB result row.

Parameters

stdClass

$row

Returns

RevisionItemBase

Reimplemented in MediaWiki\ChangeTags\ChangeTagsLogList, MediaWiki\ChangeTags\ChangeTagsRevisionList, RevDelArchivedFileList, RevDelArchiveList, RevDelFileList, RevDelLogList, RevDelRevisionList, and MediaWiki\RevisionList\RevisionList.

next()

MediaWiki\RevisionList\RevisionListBase::next

(

)

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

Returns

RevisionItemBase

Definition at line 136 of file RevisionListBase.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsLogList\updateChangeTagsOnAll(), and MediaWiki\ChangeTags\ChangeTagsRevisionList\updateChangeTagsOnAll().

reset()

MediaWiki\RevisionList\RevisionListBase::reset

(

)

Start iteration.

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

Returns

RevisionItemBase First list item

Definition at line 105 of file RevisionListBase.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsLogList\updateChangeTagsOnAll(), and MediaWiki\ChangeTags\ChangeTagsRevisionList\updateChangeTagsOnAll().

rewind()

MediaWiki\RevisionList\RevisionListBase::rewind

(

)

Definition at line 117 of file RevisionListBase.php.

valid()

MediaWiki\RevisionList\RevisionListBase::valid

(

)

Definition at line 146 of file RevisionListBase.php.

Member Data Documentation

$current

RevisionItemBase false MediaWiki\RevisionList\RevisionListBase::$current

protected

Definition at line 38 of file RevisionListBase.php.

$ids

int [] null MediaWiki\RevisionList\RevisionListBase::$ids

protected

Definition at line 32 of file RevisionListBase.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsList\__construct(), RevDelArchiveList\__construct(), RevDelRevisionList\__construct(), RevDelArchivedFileList\__construct(), RevDelFileList\__construct(), MediaWiki\ChangeTags\ChangeTagsLogList\doQuery(), MediaWiki\ChangeTags\ChangeTagsRevisionList\doQuery(), RevDelArchivedFileList\doQuery(), RevDelLogList\doQuery(), RevDelRevisionList\doQuery(), MediaWiki\ChangeTags\ChangeTagsList\factory(), and RevDelRevisionList\suggestTarget().

$page

PageIdentity MediaWiki\RevisionList\RevisionListBase::$page

protected

Definition at line 29 of file RevisionListBase.php.

Referenced by MediaWiki\RevisionList\RevisionListBase\__construct(), MediaWiki\ChangeTags\ChangeTagsList\__construct(), RevDelArchiveList\__construct(), RevDelRevisionList\__construct(), RevDelArchivedFileList\__construct(), RevDelFileList\__construct(), RevDelRevisionList\emitEvents(), and MediaWiki\ChangeTags\ChangeTagsList\factory().

$res

IResultWrapper false MediaWiki\RevisionList\RevisionListBase::$res

protected

Definition at line 35 of file RevisionListBase.php.

---

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

• includes/RevisionList/RevisionListBase.php