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

Collaboration diagram for PageArchive:

Public Member Functions
	__construct ( $title)

	getFileStatus ()

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

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

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

	getRevisionStatus ()

	getTextFromRow ( $row)
	Get the text from an archive row containing ar_text, ar_flags and ar_text_id. More...

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

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

	listRevisions ()
	List the revisions of the given page. More...

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

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

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

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

Protected Attributes
Status	$fileStatus

Status	$revisionStatus

Title	$title

Private Member Functions
	undeleteRevisions ( $timestamps, $unsuppress=false, $comment='')
	This is the meaty bit – restores archived revisions of the given page to the cur/old tables. More...

Detailed Description

Used to show archived pages and eventually restore them.

Definition at line 29 of file SpecialUndelete.php.

Constructor & Destructor Documentation

◆ __construct()

PageArchive::__construct ( $title )

Definition at line 36 of file SpecialUndelete.php.

References $title, and title.

Member Function Documentation

◆ getFileStatus()

PageArchive::getFileStatus ( )

Returns: Status

Definition at line 655 of file SpecialUndelete.php.

References $fileStatus.

◆ 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.

Returns: string|null

Definition at line 312 of file SpecialUndelete.php.

References $dbr, array(), DB_SLAVE, getTextFromRow(), title, and wfGetDB().

◆ 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 238 of file SpecialUndelete.php.

References $dbr, $timestamp, array(), DB_SLAVE, getRevision(), Revision\newFromId(), title, TS_MW, wfGetDB(), and wfTimestamp().

◆ getRevision()

PageArchive::getRevision ( $timestamp )

Return a Revision object containing data for the deleted revision.

Note that the result may or may not have a null page ID.

Parameters

string $timestamp

Returns: Revision|null

Definition at line 189 of file SpecialUndelete.php.

References $dbr, $timestamp, array(), DB_SLAVE, global, Revision\newFromArchiveRow(), title, and wfGetDB().

Referenced by getPreviousRevision().

◆ getRevisionStatus()

PageArchive::getRevisionStatus ( )

Returns: Status

Definition at line 662 of file SpecialUndelete.php.

References $revisionStatus.

◆ getTextFromRow()

PageArchive::getTextFromRow ( $row )

Get the text from an archive row containing ar_text, ar_flags and ar_text_id.

Parameters

object $row Database row

Returns: string

Definition at line 287 of file SpecialUndelete.php.

References $dbr, array(), DB_SLAVE, Revision\getRevisionText(), and wfGetDB().

Referenced by getLastRevisionText().

◆ isDeleted()

PageArchive::isDeleted ( )

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

Returns: boolean

Definition at line 333 of file SpecialUndelete.php.

References $dbr, $n, array(), DB_SLAVE, 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.

Returns: ResultWrapper

Definition at line 50 of file SpecialUndelete.php.

References $dbr, DB_SLAVE, listPages(), 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: ResultWrapper

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

Definition at line 165 of file SpecialUndelete.php.

References $dbr, $res, array(), DB_SLAVE, NS_FILE, ArchivedFile\selectFields(), title, and wfGetDB().

◆ listPages()

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

staticprotected

Parameters

DatabaseBase	$dbr
string \| array	$condition

Returns: bool|ResultWrapper

Definition at line 90 of file SpecialUndelete.php.

References $dbr, and array().

Referenced by listAllPages(), and listPagesByPrefix().

◆ 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: ResultWrapper

Definition at line 64 of file SpecialUndelete.php.

References $dbr, $title, array(), DB_SLAVE, Title\getDBkey(), Title\getNamespace(), listPages(), Title\newFromText(), and wfGetDB().

Referenced by SpecialUndelete\showSearchForm().

◆ listRevisions()

PageArchive::listRevisions ( )

List the revisions of the given page.

Returns result wrapper with (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.

Returns: ResultWrapper

Definition at line 114 of file SpecialUndelete.php.

References $dbr, $options, $res, $tables, array(), DB_SLAVE, global, ChangeTags\modifyDisplayQuery(), title, and wfGetDB().

◆ undelete()

PageArchive::undelete	(		$timestamps,
			$comment = `''`,
			$fileVersions = `array()`,
			$unsuppress = `false`,
		User	$user = `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.

Parameters

array	$timestamps	Pass an empty array to restore all revisions, otherwise list the ones to undelete.
string	$comment
array	$fileVersions
bool	$unsuppress
User	$user	User performing the action, or null to use $wgUser

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

Definition at line 358 of file SpecialUndelete.php.

References $comment, $user, $wgUser, array(), global, NS_FILE, title, undeleteRevisions(), wfDebug(), wfLocalFile(), wfMessage(), and wfRunHooks().

◆ undeleteRevisions()

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

private

This is the meaty bit – restores archived revisions of the given page to the cur/old tables.

If the page currently exists, all revisions will be stuffed into old, otherwise the most recent will go into cur.

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 Object containing the number of revisions restored on success

Definition at line 441 of file SpecialUndelete.php.

References $article, $comment, $ret, $user, array(), as, DB_MASTER, Revision\DELETED_TEXT, WikiPage\factory(), false, global, Status\newFatal(), Revision\newFromArchiveRow(), User\newFromName(), Status\newGood(), NS_FILE, Revision\RAW, title, wfDebug(), wfGetDB(), wfReadOnly(), and wfRunHooks().

Referenced by undelete().

Member Data Documentation

◆ $fileStatus

Status PageArchive::$fileStatus

protected

Definition at line 32 of file SpecialUndelete.php.

Referenced by getFileStatus().

◆ $revisionStatus

Status PageArchive::$revisionStatus

protected

Definition at line 34 of file SpecialUndelete.php.

Referenced by getRevisionStatus().

◆ $title

Title PageArchive::$title

protected

Definition at line 30 of file SpecialUndelete.php.

Referenced by __construct(), and listPagesByPrefix().

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

includes/specials/SpecialUndelete.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

◆ getFileStatus()

◆ getLastRevisionText()

◆ getPreviousRevision()

◆ getRevision()

◆ getRevisionStatus()

◆ getTextFromRow()

◆ isDeleted()

◆ listAllPages()

◆ listFiles()

◆ listPages()

◆ listPagesByPrefix()

◆ listRevisions()

◆ undelete()

◆ undeleteRevisions()

Member Data Documentation

◆ $fileStatus

◆ $revisionStatus

◆ $title