MediaWiki\Revision\ArchivedRevisionLookup Class Reference

Public Member Functions
	__construct (IConnectionProvider $dbProvider, RevisionStore $revisionStore)
	getArchivedRevisionRecord (?PageIdentity $page, int $revId)
	Return the archived revision with the given ID.
	getLastRevisionId (PageIdentity $page)
	Returns the ID of the latest deleted revision.
	getPreviousRevisionRecord (PageIdentity $page, string $timestamp)
	Return the most-previous revision, either live or deleted, against the deleted revision given by timestamp.
	getRevisionRecordByTimestamp (PageIdentity $page, $timestamp)
	Return a RevisionRecord object containing data for the deleted revision.
	hasArchivedRevisions (PageIdentity $page)
	Quick check if any archived revisions are present for the page.
	listArchivedRevisions (PageIdentity $page, Authority $performer, array $extraConds=[], ?int $limit=null)
	List the revisions of the given page.
	listRevisions (PageIdentity $page, array $extraConds=[], ?int $limit=null, ?Authority $performer=null)
	List the revisions of the given page.

Detailed Description

Since

1.38

Definition at line 22 of file ArchivedRevisionLookup.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Revision\ArchivedRevisionLookup::__construct	(	IConnectionProvider	$dbProvider,
		RevisionStore	$revisionStore )

Definition at line 30 of file ArchivedRevisionLookup.php.

Member Function Documentation

getArchivedRevisionRecord()

MediaWiki\Revision\ArchivedRevisionLookup::getArchivedRevisionRecord	(	?PageIdentity	$page,
		int	$revId )

Return the archived revision with the given ID.

Parameters

PageIdentity | null	$page
int	$revId

Returns

RevisionRecord|null

Definition at line 124 of file ArchivedRevisionLookup.php.

getLastRevisionId()

MediaWiki\Revision\ArchivedRevisionLookup::getLastRevisionId

(

PageIdentity

$page

)

Returns the ID of the latest deleted revision.

Parameters

PageIdentity

$page

Returns

int|false The revision's ID, or false if there is no deleted revision.

Definition at line 220 of file ArchivedRevisionLookup.php.

References MediaWiki\Page\PageReference\getDBkey(), and MediaWiki\Page\PageReference\getNamespace().

getPreviousRevisionRecord()

MediaWiki\Revision\ArchivedRevisionLookup::getPreviousRevisionRecord	(	PageIdentity	$page,
		string	$timestamp )

Return the most-previous revision, either live or deleted, against the deleted revision given by timestamp.

May produce unexpected results in case of history merges or other unusual time issues.

Parameters

PageIdentity	$page
string	$timestamp

Returns

RevisionRecord|null Null when there is no previous revision

Definition at line 169 of file ArchivedRevisionLookup.php.

getRevisionRecordByTimestamp()

MediaWiki\Revision\ArchivedRevisionLookup::getRevisionRecordByTimestamp	(	PageIdentity	$page,
			$timestamp )

Return a RevisionRecord object containing data for the deleted revision.

Access: internal

only for use in SpecialUndelete

Parameters

PageIdentity	$page
string	$timestamp

Returns

RevisionRecord|null

Definition at line 110 of file ArchivedRevisionLookup.php.

hasArchivedRevisions()

MediaWiki\Revision\ArchivedRevisionLookup::hasArchivedRevisions

(

PageIdentity

$page

)

Quick check if any archived revisions are present for the page.

This says nothing about whether the page currently exists in the page table or not.

Parameters

PageIdentity

$page

Returns

bool

Definition at line 239 of file ArchivedRevisionLookup.php.

listArchivedRevisions()

MediaWiki\Revision\ArchivedRevisionLookup::listArchivedRevisions	(	PageIdentity	$page,
		Authority	$performer,
		array	$extraConds = [],
		?int	$limit = null )

List the revisions of the given page.

Returns result wrapper with various archive table fields.

Since

1.47

Parameters

PageIdentity	$page
Authority	$performer	Viewer, for restricted-tag access checks
array	$extraConds	Extra conditions to be added to the query
?int	$limit	The limit to be applied to the query, or null for no limit

Returns

IResultWrapper

Definition at line 50 of file ArchivedRevisionLookup.php.

listRevisions()

MediaWiki\Revision\ArchivedRevisionLookup::listRevisions	(	PageIdentity	$page,
		array	$extraConds = [],
		?int	$limit = null,
		?Authority	$performer = null )

List the revisions of the given page.

Returns result wrapper with various archive table fields.

Deprecated

since 1.47, use listArchivedRevisions() instead, passing an Authority

Parameters

PageIdentity	$page
array	$extraConds	Extra conditions to be added to the query
?int	$limit	The limit to be applied to the query, or null for no limit
Authority | null	$performer	Viewer, for restricted-tag access checks. Null hides all restricted tags.

Returns

IResultWrapper

Definition at line 88 of file ArchivedRevisionLookup.php.

---

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

• includes/Revision/ArchivedRevisionLookup.php