MediaWiki  REL1_31
PageArchive Class Reference

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

Collaboration diagram for PageArchive:

Public Member Functions

 __construct ( $title, Config $config=null)
 
 doesWrites ()
 
 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_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=[], $unsuppress=false, User $user=null, $tags=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 listPagesBySearch ( $term)
 List deleted pages recorded in the archive matching the given term, using search engine archive. More...
 

Static Protected Member Functions

static listPages ( $dbr, $condition)
 

Protected Attributes

Config $config
 
Status $fileStatus
 
Status $revisionStatus
 
Title $title
 

Private Member Functions

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

Detailed Description

Used to show archived pages and eventually restore them.

Definition at line 28 of file PageArchive.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 41 of file PageArchive.php.

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

Member Function Documentation

◆ doesWrites()

PageArchive::doesWrites ( )

Definition at line 53 of file PageArchive.php.

◆ getFileStatus()

PageArchive::getFileStatus ( )
Returns
Status

Definition at line 742 of file PageArchive.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 342 of file PageArchive.php.

References $dbr, DB_REPLICA, Revision\getRevisionText(), 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 274 of file PageArchive.php.

References $dbr, DB_REPLICA, getRevision(), Revision\newFromId(), title, 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 240 of file PageArchive.php.

References $dbr, DB_REPLICA, Revision\getArchiveQueryInfo(), Revision\newFromArchiveRow(), title, and wfGetDB().

Referenced by getPreviousRevision().

◆ getRevisionStatus()

PageArchive::getRevisionStatus ( )
Returns
Status

Definition at line 749 of file PageArchive.php.

References $revisionStatus.

◆ getTextFromRow()

PageArchive::getTextFromRow (   $row)

Get the text from an archive row containing ar_text_id.

Deprecated:
since 1.31
Parameters
object$rowDatabase row
Returns
string

Definition at line 324 of file PageArchive.php.

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

◆ isDeleted()

PageArchive::isDeleted ( )

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

Returns
bool

Definition at line 366 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.

Returns
ResultWrapper

Definition at line 64 of file PageArchive.php.

References $dbr, DB_REPLICA, 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 216 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|ResultWrapper

Definition at line 154 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$prefixTitle prefix
Returns
ResultWrapper

Definition at line 128 of file PageArchive.php.

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

Referenced by listPagesBySearch(), SpecialUndelete\showSearchForm(), and PageArchiveTest\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$termSearch term
Returns
ResultWrapper

Definition at line 78 of file PageArchive.php.

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

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

◆ listRevisions()

PageArchive::listRevisions ( )

List the revisions of the given page.

Returns result wrapper with various archive table fields.

Returns
ResultWrapper

Definition at line 178 of file PageArchive.php.

References $dbr, $options, DB_REPLICA, 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$timestampsPass an empty array to restore all revisions, otherwise list the ones to undelete.
string$comment
array$fileVersions
bool$unsuppress
User$userUser performing the action, or null to use $wgUser
string | string[]$tagsChange 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 396 of file PageArchive.php.

References $user, $wgUser, global, NS_FILE, Hooks\run(), 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$timestampsPass an empty array to restore all revisions, otherwise list the ones to undelete.
bool$unsuppressRemove 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 473 of file PageArchive.php.

References $article, $user, DeferredUpdates\addUpdate(), as, DB_MASTER, Revision\DELETED_TEXT, WikiPage\factory(), StatusValue\newFatal(), Revision\newFromArchiveRow(), User\newFromName(), StatusValue\newGood(), NS_FILE, Revision\RAW, Hooks\run(), title, true, wfDebug(), wfGetDB(), wfMessage(), and wfReadOnly().

Referenced by undelete().

Member Data Documentation

◆ $config

Config PageArchive::$config
protected

Definition at line 39 of file PageArchive.php.

Referenced by __construct().

◆ $fileStatus

Status PageArchive::$fileStatus
protected

Definition at line 33 of file PageArchive.php.

Referenced by getFileStatus().

◆ $revisionStatus

Status PageArchive::$revisionStatus
protected

Definition at line 36 of file PageArchive.php.

Referenced by getRevisionStatus().

◆ $title

Title PageArchive::$title
protected

Definition at line 30 of file PageArchive.php.

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


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