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

Inherits MediaWiki\Context\ContextSource, and Iterator.

Inherited by ChangeTagsList, RevDelList, and RevisionList.

Collaboration diagram for RevisionListBase:

[legend]

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 34 of file RevisionListBase.php.

Constructor & Destructor Documentation

◆ __construct()

RevisionListBase::__construct	(	IContextSource	$context,
		PageIdentity	$page )

Construct a revision list for a given page identity.

Parameters

IContextSource	$context
PageIdentity	$page

Definition at line 54 of file RevisionListBase.php.

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

Member Function Documentation

◆ current()

RevisionListBase::current ( )

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

Returns: RevisionItemBase|false

Definition at line 139 of file RevisionListBase.php.

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

◆ doQuery()

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 ChangeTagsLogList, ChangeTagsRevisionList, RevDelArchivedFileList, RevDelArchiveList, RevDelFileList, RevDelLogList, RevDelRevisionList, and RevisionList.

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

◆ filterByIds()

RevisionListBase::filterByIds ( array $ids )

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

Parameters

int[] $ids

Definition at line 89 of file RevisionListBase.php.

◆ getPage()

RevisionListBase::getPage ( )

Returns: PageIdentity

Definition at line 73 of file RevisionListBase.php.

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

◆ getPageName()

RevisionListBase::getPageName ( )

Access: internal: for use by RevDelItems

Returns: string

Definition at line 81 of file RevisionListBase.php.

◆ getType()

RevisionListBase::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns: string|null

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

Definition at line 98 of file RevisionListBase.php.

Referenced by RevDelList\getLogParams().

◆ initCurrent()

RevisionListBase::initCurrent ( )

protected

Initialise the current iteration pointer.

Definition at line 105 of file RevisionListBase.php.

◆ key()

RevisionListBase::key ( )

Definition at line 155 of file RevisionListBase.php.

◆ length()

RevisionListBase::length ( )

Get the number of items in the list.

Returns: int

Definition at line 167 of file RevisionListBase.php.

◆ newItem()

RevisionListBase::newItem ( $row )

abstract

Create an item object from a DB result row.

Parameters

stdClass $row

Returns: RevisionItemBase

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

◆ next()

RevisionListBase::next ( )

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

Returns: RevisionItemBase

Definition at line 149 of file RevisionListBase.php.

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

◆ reset()

RevisionListBase::reset ( )

Start iteration.

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

Returns: RevisionItemBase First list item

Definition at line 118 of file RevisionListBase.php.

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

◆ rewind()

RevisionListBase::rewind ( )

Definition at line 130 of file RevisionListBase.php.

◆ valid()

RevisionListBase::valid ( )

Definition at line 159 of file RevisionListBase.php.

Member Data Documentation

◆ $current

RevisionItemBase false RevisionListBase::$current

protected

Definition at line 47 of file RevisionListBase.php.

◆ $ids

int [] null RevisionListBase::$ids

protected

Definition at line 41 of file RevisionListBase.php.

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

◆ $page

PageIdentity RevisionListBase::$page

protected

Definition at line 38 of file RevisionListBase.php.

Referenced by __construct(), RevDelLogList\__construct(), RevDelArchiveList\__construct(), RevDelRevisionList\__construct(), RevDelArchivedFileList\__construct(), and RevDelFileList\__construct().

◆ $res

IResultWrapper false RevisionListBase::$res

protected

Definition at line 44 of file RevisionListBase.php.

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

includes/revisionlist/RevisionListBase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ current()

◆ doQuery()

◆ filterByIds()

◆ getPage()

◆ getPageName()

◆ getType()

◆ initCurrent()

◆ key()

◆ length()

◆ newItem()

◆ next()

◆ reset()

◆ rewind()

◆ valid()

Member Data Documentation

◆ $current

◆ $ids

◆ $page

◆ $res