MediaWiki  master
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 ()
 
 getArchivedRevision ( $revId)
 Return the archived revision with the given ID. More...
 
 getFileStatus ()
 
 getLastRevisionId ()
 Returns the ID of the latest deleted revision. 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 ()
 
 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 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

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

Detailed Description

Used to show archived pages and eventually restore them.

Definition at line 31 of file PageArchive.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 44 of file PageArchive.php.

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

Member Function Documentation

◆ doesWrites()

PageArchive::doesWrites ( )

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

References getRevisionByConditions().

Referenced by getPreviousRevision().

◆ getFileStatus()

PageArchive::getFileStatus ( )
Returns
Status

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

References $dbr, DB_REPLICA, 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 309 of file PageArchive.php.

References $dbr, DB_REPLICA, getArchivedRevision(), getRevisionStore(), 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 246 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 274 of file PageArchive.php.

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

Referenced by getArchivedRevision(), and getRevision().

◆ getRevisionStatus()

PageArchive::getRevisionStatus ( )
Returns
Status

Definition at line 785 of file PageArchive.php.

References $revisionStatus.

◆ getRevisionStore()

PageArchive::getRevisionStore ( )
private
Returns
RevisionStore

Definition at line 59 of file PageArchive.php.

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

◆ 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 380 of file PageArchive.php.

References $dbr, DB_REPLICA, 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 221 of file PageArchive.php.

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

◆ listPages()

static PageArchive::listPages (   $dbr,
  $condition 
)
staticprotected
Parameters
IDatabase$dbr
string | array$condition
Returns
bool|IResultWrapper

Definition at line 155 of file PageArchive.php.

References $dbr.

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

Definition at line 129 of file PageArchive.php.

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

Referenced by SpecialUndelete\showSearchForm().

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

Definition at line 79 of file PageArchive.php.

References $dbr, $t, DB_REPLICA, Title\getDBkey(), Title\getNamespace(), Title\getText(), LIST_OR, Title\newFromText(), and wfGetDB().

Referenced by SpecialUndelete\showSearchForm().

◆ listRevisions()

PageArchive::listRevisions ( )

List the revisions of the given page.

Returns result wrapper with various archive table fields.

Returns
IResultWrapper

Definition at line 179 of file PageArchive.php.

References $dbr, DB_REPLICA, getRevisionStore(), ChangeTags\modifyDisplayQuery(), 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 | null$userUser 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 [ number of file revisions restored, number of image revisions restored, log message ] on success, false on failure.

Definition at line 412 of file PageArchive.php.

References NS_FILE, Hooks\run(), undeleteRevisions(), and wfDebug().

◆ 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 491 of file PageArchive.php.

References $job, DB_MASTER, WikiPage\factory(), getRevisionStore(), StatusValue\newFatal(), HTMLCacheUpdateJob\newForBacklinks(), User\newFromName(), StatusValue\newGood(), NS_FILE, Hooks\run(), JobQueueGroup\singleton(), wfDebug(), wfGetDB(), wfMessage(), and wfReadOnly().

Referenced by undelete().

Member Data Documentation

◆ $config

Config PageArchive::$config
protected

Definition at line 42 of file PageArchive.php.

Referenced by __construct().

◆ $fileStatus

Status PageArchive::$fileStatus
protected

Definition at line 36 of file PageArchive.php.

Referenced by getFileStatus().

◆ $revisionStatus

Status PageArchive::$revisionStatus
protected

Definition at line 39 of file PageArchive.php.

Referenced by getRevisionStatus().

◆ $title

Title PageArchive::$title
protected

Definition at line 33 of file PageArchive.php.

Referenced by __construct().


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