MediaWiki master
MediaWiki\Page\MergeHistory Class Reference

Handles the backend logic of merging the histories of two pages. More...

Collaboration diagram for MediaWiki\Page\MergeHistory:

Public Member Functions

 __construct (PageIdentity $source, PageIdentity $dest, ?string $timestamp, IConnectionProvider $dbProvider, IContentHandlerFactory $contentHandlerFactory, RevisionStore $revisionStore, WatchedItemStoreInterface $watchedItemStore, SpamChecker $spamChecker, HookContainer $hookContainer, WikiPageFactory $wikiPageFactory, TitleFormatter $titleFormatter, TitleFactory $titleFactory, LinkTargetLookup $linkTargetLookup)
 
 authorizeMerge (Authority $performer, string $reason=null)
 Authorize the merge by $performer.
 
 getMergedRevisionCount ()
 Get the number of revisions that were moved Used in the SpecialMergeHistory success message.
 
 getRevisionCount ()
 Get the number of revisions that will be moved.
 
 isValidMerge ()
 Does various checks that the merge is valid.
 
 merge (Authority $performer, $reason='')
 Actually attempt the history move.
 
 probablyCanMerge (Authority $performer, string $reason=null)
 Check whether $performer can execute the merge.
 

Public Attributes

const REVISION_LIMIT = 5000
 Maximum number of revisions that can be merged at once.
 

Protected Attributes

IDatabase $dbw
 Database that we are using.
 
PageIdentity $dest
 Page to which history will be merged.
 
MWTimestamp false $maxTimestamp = false
 Maximum timestamp that we can use (oldest timestamp of dest).
 
int $revisionsMerged
 Number of revisions merged (for Special:MergeHistory success message)
 
PageIdentity $source
 Page from which history will be merged.
 
MWTimestamp false null $timestampLimit = false
 Timestamp upto which history from the source will be merged.
 
string false null $timeWhere = false
 SQL WHERE condition that selects source revisions to insert into destination.
 

Detailed Description

Handles the backend logic of merging the histories of two pages.

Since
1.27

Definition at line 61 of file MergeHistory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\MergeHistory::__construct ( PageIdentity $source,
PageIdentity $dest,
?string $timestamp,
IConnectionProvider $dbProvider,
IContentHandlerFactory $contentHandlerFactory,
RevisionStore $revisionStore,
WatchedItemStoreInterface $watchedItemStore,
SpamChecker $spamChecker,
HookContainer $hookContainer,
WikiPageFactory $wikiPageFactory,
TitleFormatter $titleFormatter,
TitleFactory $titleFactory,
LinkTargetLookup $linkTargetLookup )
Parameters
PageIdentity$sourcePage from which history will be merged
PageIdentity$destPage to which history will be merged
?string$timestampTimestamp up to which history from the source will be merged
IConnectionProvider$dbProvider
IContentHandlerFactory$contentHandlerFactory
RevisionStore$revisionStore
WatchedItemStoreInterface$watchedItemStore
SpamChecker$spamChecker
HookContainer$hookContainer
WikiPageFactory$wikiPageFactory
TitleFormatter$titleFormatter
TitleFactory$titleFactory
LinkTargetLookup$linkTargetLookup

Definition at line 129 of file MergeHistory.php.

References MediaWiki\Page\MergeHistory\$dest, MediaWiki\Page\MergeHistory\$source, and Wikimedia\Rdbms\IConnectionProvider\getPrimaryDatabase().

Member Function Documentation

◆ authorizeMerge()

MediaWiki\Page\MergeHistory::authorizeMerge ( Authority $performer,
string $reason = null )

Authorize the merge by $performer.

Note
this method should be used right before the actual merge is performed. To check whether a current performer has the potential to merge the history, use self::probablyCanMerge instead.
Parameters
Authority$performer
string | null$reason
Returns
PermissionStatus

Definition at line 249 of file MergeHistory.php.

References MediaWiki\Permissions\Authority\authorizeWrite().

◆ getMergedRevisionCount()

MediaWiki\Page\MergeHistory::getMergedRevisionCount ( )

Get the number of revisions that were moved Used in the SpecialMergeHistory success message.

Returns
int

Definition at line 183 of file MergeHistory.php.

References MediaWiki\Page\MergeHistory\$revisionsMerged.

◆ getRevisionCount()

MediaWiki\Page\MergeHistory::getRevisionCount ( )

Get the number of revisions that will be moved.

Returns
int

Definition at line 167 of file MergeHistory.php.

◆ isValidMerge()

MediaWiki\Page\MergeHistory::isValidMerge ( )

Does various checks that the merge is valid.

Only things based on the two pages should be checked here.

Returns
Status

Definition at line 266 of file MergeHistory.php.

◆ merge()

MediaWiki\Page\MergeHistory::merge ( Authority $performer,
$reason = '' )

Actually attempt the history move.

Todo
if all versions of page A are moved to B and then a user tries to do a reverse-merge via the "unmerge" log link, then page A will still be a redirect (as it was after the original merge), though it will have the old revisions back from before (as expected). The user may have to "undo" the redirect manually to finish the "unmerge". Maybe this should delete redirects at the source page of merges?
Parameters
Authority$performer
string$reason
Returns
Status status of the history merge

Definition at line 314 of file MergeHistory.php.

References MediaWiki\Permissions\Authority\getUser(), and wfMessage().

◆ probablyCanMerge()

MediaWiki\Page\MergeHistory::probablyCanMerge ( Authority $performer,
string $reason = null )

Check whether $performer can execute the merge.

Note
this method does not guarantee full permissions check, so it should only be used to to decide whether to show a merge form. To authorize the merge action use self::authorizeMerge instead.
Parameters
Authority$performer
string | null$reason
Returns
PermissionStatus

Definition at line 228 of file MergeHistory.php.

References MediaWiki\Permissions\Authority\probablyCan().

Member Data Documentation

◆ $dbw

IDatabase MediaWiki\Page\MergeHistory::$dbw
protected

Database that we are using.

Definition at line 73 of file MergeHistory.php.

◆ $dest

PageIdentity MediaWiki\Page\MergeHistory::$dest
protected

Page to which history will be merged.

Definition at line 70 of file MergeHistory.php.

Referenced by MediaWiki\Page\MergeHistory\__construct().

◆ $maxTimestamp

MWTimestamp false MediaWiki\Page\MergeHistory::$maxTimestamp = false
protected

Maximum timestamp that we can use (oldest timestamp of dest).

Use ::getMaxTimestamp to lazily initialize.

Definition at line 82 of file MergeHistory.php.

◆ $revisionsMerged

int MediaWiki\Page\MergeHistory::$revisionsMerged
protected

Number of revisions merged (for Special:MergeHistory success message)

Definition at line 102 of file MergeHistory.php.

Referenced by MediaWiki\Page\MergeHistory\getMergedRevisionCount().

◆ $source

PageIdentity MediaWiki\Page\MergeHistory::$source
protected

Page from which history will be merged.

Definition at line 67 of file MergeHistory.php.

Referenced by MediaWiki\Page\MergeHistory\__construct().

◆ $timestampLimit

MWTimestamp false null MediaWiki\Page\MergeHistory::$timestampLimit = false
protected

Timestamp upto which history from the source will be merged.

Use getTimestampLimit to lazily initialize.

Definition at line 94 of file MergeHistory.php.

◆ $timeWhere

string false null MediaWiki\Page\MergeHistory::$timeWhere = false
protected

SQL WHERE condition that selects source revisions to insert into destination.

Use ::getTimeWhere to lazy-initialize.

Definition at line 88 of file MergeHistory.php.

◆ REVISION_LIMIT

const MediaWiki\Page\MergeHistory::REVISION_LIMIT = 5000

Maximum number of revisions that can be merged at once.

Definition at line 64 of file MergeHistory.php.


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