Used to show archived pages and eventually restore them. More...

Collaboration diagram for PageArchive:

[legend]

Public Member Functions
	__construct ( $title, Config $config=null)

	doesWrites ()

	getArchivedRevision ( $revId)
	Return the archived revision with the given ID.

	getFileStatus ()

	getLastRevisionId ()
	Returns the ID of the latest deleted revision.

	getLastRevisionText ()
	Fetch (and decompress if necessary) the stored text of the most recently edited deleted revision of the page.

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

	getRevision ( $timestamp)
	Return a Revision object containing data for the deleted revision.

	getRevisionStatus ()

	getTextFromRow ( $row)
	Get the text from an archive row containing ar_text_id.

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

	listFiles ()
	List the deleted file revisions for this page, if it's a file page.

	listRevisions ()
	List the revisions of the given page.

	undelete ( $timestamps, $comment='', $fileVersions=[], $unsuppress=false, User $user=null, $tags=null)
	Restore the given (or all) text and file revisions for the page.

Static Public Member Functions
static	listAllPages ()
	List all deleted pages recorded in the archive table.

static	listPagesByPrefix ( $prefix)
	List deleted pages recorded in the archive table matching the given title prefix.

static	listPagesBySearch ( $term)
	List deleted pages recorded in the archive matching the given term, using search engine archive.

Static Protected Member Functions
static	listPages ( $dbr, $condition)

Protected Attributes
Config	$config

Status	$fileStatus

Status	$revisionStatus

Title	$title

Private Member Functions
	getRevisionByConditions (array $conditions, array $options=[])

	getRevisionStore ()

	undeleteRevisions ( $timestamps, $unsuppress=false, $comment='')
	This is the meaty bit – It restores archived revisions of the given page to the revision table.

Detailed Description

Used to show archived pages and eventually restore them.

Definition at line 32 of file PageArchive.php.

Constructor & Destructor Documentation

◆ __construct()

PageArchive::__construct	(		$title,
		Config	$config = `null`
	)

Definition at line 45 of file PageArchive.php.

References $config, $title, title, and wfDebug().

Member Function Documentation

◆ doesWrites()

PageArchive::doesWrites ( )

Definition at line 68 of file PageArchive.php.

◆ getArchivedRevision()

PageArchive::getArchivedRevision ( $revId )

Return the archived revision with the given ID.

Parameters

int $revId

Returns: Revision|null

Definition at line 278 of file PageArchive.php.

References getRevisionByConditions().

Referenced by getLastRevisionText(), and getPreviousRevision().

◆ getFileStatus()

PageArchive::getFileStatus ( )

Returns: Status

Definition at line 843 of file PageArchive.php.

References $fileStatus.

◆ getLastRevisionId()

PageArchive::getLastRevisionId ( )

Returns the ID of the latest deleted revision.

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

Definition at line 431 of file PageArchive.php.

References $dbr, DB_REPLICA, title, and wfGetDB().

Referenced by getLastRevisionText().

◆ getLastRevisionText()

PageArchive::getLastRevisionText ( )

Fetch (and decompress if necessary) the stored text of the most recently edited deleted revision of the page.

If there are no archived revisions for the page, returns NULL.

Note: this bypasses any audience checks.

Deprecated:: since 1.32. For compatibility with the MCR schema, calling code should switch to getLastRevisionId() and getArchiveRevision().

Todo:: remove in 1.33

Returns: string|null

Definition at line 412 of file PageArchive.php.

References $content, $rev, getArchivedRevision(), getLastRevisionId(), and wfDeprecated().

◆ getPreviousRevision()

PageArchive::getPreviousRevision ( $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

string $timestamp

Returns: Revision|null Null when there is no previous revision

Definition at line 327 of file PageArchive.php.

References $dbr, DB_REPLICA, getArchivedRevision(), getRevisionStore(), title, wfGetDB(), and wfTimestamp().

◆ getRevision()

PageArchive::getRevision ( $timestamp )

Return a Revision object containing data for the deleted revision.

Deprecated:: since 1.32, use getArchivedRevision() instead.

Parameters

string $timestamp

Returns: Revision|null

Definition at line 264 of file PageArchive.php.

References $dbr, DB_REPLICA, getRevisionByConditions(), and wfGetDB().

◆ getRevisionByConditions()

PageArchive::getRevisionByConditions	(	array	$conditions,
		array	$options = `[]`
	)

private

Parameters

array	$conditions
array	$options

Returns: RevisionRecord|null

Definition at line 292 of file PageArchive.php.

References $dbr, $options, DB_REPLICA, getRevisionStore(), title, and wfGetDB().

Referenced by getArchivedRevision(), and getRevision().

◆ getRevisionStatus()

PageArchive::getRevisionStatus ( )

Returns: Status

Definition at line 850 of file PageArchive.php.

References $revisionStatus.

◆ getRevisionStore()

PageArchive::getRevisionStore ( )

private

Returns: RevisionStore

Definition at line 60 of file PageArchive.php.

Referenced by getPreviousRevision(), getRevisionByConditions(), listRevisions(), and undeleteRevisions().

◆ getTextFromRow()

PageArchive::getTextFromRow ( $row )

Get the text from an archive row containing ar_text_id.

Deprecated:: since 1.32. In the MCR schema, ar_text_id no longer exists. Calling code should switch to getArchiveRevision().

Todo:: remove in 1.33

Parameters

object $row Database row

Returns: string

Definition at line 384 of file PageArchive.php.

References wfDeprecated().

◆ isDeleted()

PageArchive::isDeleted ( )

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.

Returns: bool

Definition at line 451 of file PageArchive.php.

References $dbr, DB_REPLICA, title, and wfGetDB().

◆ listAllPages()

static PageArchive::listAllPages ( )

static

List all deleted pages recorded in the archive table.

Returns result wrapper with (ar_namespace, ar_title, count) fields, ordered by page namespace/title.

Deprecated:: since 1.32.

Returns: IResultWrapper

Definition at line 81 of file PageArchive.php.

References $dbr, DB_REPLICA, listPages(), wfDeprecated(), and wfGetDB().

◆ listFiles()

PageArchive::listFiles ( )

List the deleted file revisions for this page, if it's a file page.

Returns a result wrapper with various filearchive fields, or null if not a file page.

Returns: IResultWrapper

Todo:: Does this belong in Image for fuller encapsulation?

Definition at line 239 of file PageArchive.php.

References $dbr, DB_REPLICA, ArchivedFile\getQueryInfo(), NS_FILE, title, and wfGetDB().

◆ listPages()

static PageArchive::listPages	(	$dbr,
		$condition
	)

staticprotected

Parameters

IDatabase	$dbr
string \| array	$condition

Returns: bool|IResultWrapper

Definition at line 173 of file PageArchive.php.

References $dbr.

Referenced by listAllPages(), listPagesByPrefix(), and listPagesBySearch().

◆ listPagesByPrefix()

static PageArchive::listPagesByPrefix ( $prefix )

static

List deleted pages recorded in the archive table matching the given title prefix.

Returns result wrapper with (ar_namespace, ar_title, count) fields.

Parameters

string $prefix Title prefix

Returns: IResultWrapper

Definition at line 147 of file PageArchive.php.

References $dbr, $title, DB_REPLICA, Title\getDBkey(), Title\getNamespace(), listPages(), and wfGetDB().

Referenced by listPagesBySearch(), SpecialUndelete\showSearchForm(), and PageArchiveTestBase\testListPagesByPrefix().

◆ listPagesBySearch()

static PageArchive::listPagesBySearch ( $term )

static

List deleted pages recorded in the archive matching the given term, using search engine archive.

Returns result wrapper with (ar_namespace, ar_title, count) fields.

Parameters

string $term Search term

Returns: IResultWrapper

Definition at line 97 of file PageArchive.php.

References $dbr, $engine, $t, $term, $title, DB_REPLICA, Title\getDBkey(), Title\getNamespace(), Title\getText(), LIST_OR, listPages(), listPagesByPrefix(), and wfGetDB().

Referenced by SpecialUndelete\showSearchForm(), and PageArchiveTestBase\testListPagesBySearch().

◆ listRevisions()

PageArchive::listRevisions ( )

List the revisions of the given page.

Returns result wrapper with various archive table fields.

Returns: IResultWrapper

Definition at line 197 of file PageArchive.php.

References $dbr, $options, DB_REPLICA, getRevisionStore(), ChangeTags\modifyDisplayQuery(), title, and wfGetDB().

◆ undelete()

PageArchive::undelete	(		$timestamps,
			$comment = `''`,
			$fileVersions = `[]`,
			$unsuppress = `false`,
		User	$user = `null`,
			$tags = `null`
	)

Restore the given (or all) text and file revisions for the page.

Once restored, the items will be removed from the archive tables. The deletion log will be updated with an undeletion notice.

This also sets Status objects, $this->fileStatus and $this->revisionStatus (depending what operations are attempted).

Parameters

array	$timestamps	Pass an empty array to restore all revisions, otherwise list the ones to undelete.
string	$comment
array	$fileVersions
bool	$unsuppress
User \| null	$user	User performing the action, or null to use $wgUser
string \| string[] \| null	$tags	Change tags to add to log entry ($user should be able to add the specified tags before this is called)

Returns: array|bool array(number of file revisions restored, number of image revisions restored, log message) on success, false on failure.

Definition at line 483 of file PageArchive.php.

References $user, NS_FILE, title, undeleteRevisions(), wfDebug(), and wfLocalFile().

◆ undeleteRevisions()

PageArchive::undeleteRevisions	(	$timestamps,
		$unsuppress = `false`,
		$comment = `''`
	)

private

This is the meaty bit – It restores archived revisions of the given page to the revision table.

Parameters

array	$timestamps	Pass an empty array to restore all revisions, otherwise list the ones to undelete.
bool	$unsuppress	Remove all ar_deleted/fa_deleted restrictions of seletected revs
string	$comment

Exceptions

ReadOnlyError

Returns: Status Status object containing the number of revisions restored on success

Definition at line 560 of file PageArchive.php.

References $article, $content, $user, as, DB_MASTER, getRevisionStore(), User\newFromName(), NS_FILE, title, true, wfDebug(), wfGetDB(), wfMessage(), and wfReadOnly().

Referenced by undelete().

Member Data Documentation

◆ $config

Config PageArchive::$config

protected

Definition at line 43 of file PageArchive.php.

Referenced by __construct().

◆ $fileStatus

Status PageArchive::$fileStatus

protected

Definition at line 37 of file PageArchive.php.

Referenced by getFileStatus().

◆ $revisionStatus

Status PageArchive::$revisionStatus

protected

Definition at line 40 of file PageArchive.php.

Referenced by getRevisionStatus().

◆ $title

Title PageArchive::$title

protected

Definition at line 34 of file PageArchive.php.

Referenced by __construct(), listPagesByPrefix(), and listPagesBySearch().

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

includes/page/PageArchive.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ getArchivedRevision()

◆ getFileStatus()

◆ getLastRevisionId()

◆ getLastRevisionText()

◆ getPreviousRevision()

◆ getRevision()

◆ getRevisionByConditions()

◆ getRevisionStatus()

◆ getRevisionStore()

◆ getTextFromRow()

◆ isDeleted()

◆ listAllPages()

◆ listFiles()

◆ listPages()

◆ listPagesByPrefix()

◆ listPagesBySearch()

◆ listRevisions()

◆ undelete()

◆ undeleteRevisions()

Member Data Documentation

◆ $config

◆ $fileStatus

◆ $revisionStatus

◆ $title