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

Collaboration diagram for MediaWiki\Page\MergeHistory:

[legend]

Public Member Functions
	__construct (PageIdentity $source, PageIdentity $dest, ?string $timestamp, ILoadBalancer $loadBalancer, IContentHandlerFactory $contentHandlerFactory, RevisionStore $revisionStore, WatchedItemStoreInterface $watchedItemStore, SpamChecker $spamChecker, HookContainer $hookContainer, WikiPageFactory $wikiPageFactory, TitleFormatter $titleFormatter, TitleFactory $titleFactory)

	authorizeMerge (Authority $performer, string $reason=null)
	Authorize the merge by $performer. More...

	getMergedRevisionCount ()
	Get the number of revisions that were moved Used in the SpecialMergeHistory success message. More...

	getRevisionCount ()
	Get the number of revisions that will be moved. More...

	isValidMerge ()
	Does various checks that the merge is valid. More...

	merge (Authority $performer, $reason='')
	Actually attempt the history move. More...

	probablyCanMerge (Authority $performer, string $reason=null)
	Check whether $performer can execute the merge. More...

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

Protected Attributes
IDatabase	$dbw
	Database that we are using. More...

PageIdentity	$dest
	Page to which history will be merged. More...

MWTimestamp false	$maxTimestamp = false
	Maximum timestamp that we can use (oldest timestamp of dest). More...

int	$revisionsMerged
	Number of revisions merged (for Special:MergeHistory success message) More...

PageIdentity	$source
	Page from which history will be merged. More...

MWTimestamp false null	$timestampLimit = false
	Timestamp upto which history from the source will be merged. More...

string false null	$timeWhere = false
	SQL WHERE condition that selects source revisions to insert into destination. More...

Detailed Description

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

Since: 1.27

Definition at line 57 of file MergeHistory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\MergeHistory::__construct	(	PageIdentity	$source,
		PageIdentity	$dest,
		?string	$timestamp,
		ILoadBalancer	$loadBalancer,
		IContentHandlerFactory	$contentHandlerFactory,
		RevisionStore	$revisionStore,
		WatchedItemStoreInterface	$watchedItemStore,
		SpamChecker	$spamChecker,
		HookContainer	$hookContainer,
		WikiPageFactory	$wikiPageFactory,
		TitleFormatter	$titleFormatter,
		TitleFactory	$titleFactory
	)

Parameters

PageIdentity	$source	Page from which history will be merged
PageIdentity	$dest	Page to which history will be merged
	?string	$timestamp Timestamp up to which history from the source will be merged
ILoadBalancer	$loadBalancer
IContentHandlerFactory	$contentHandlerFactory
RevisionStore	$revisionStore
WatchedItemStoreInterface	$watchedItemStore
SpamChecker	$spamChecker
HookContainer	$hookContainer
WikiPageFactory	$wikiPageFactory
TitleFormatter	$titleFormatter
TitleFactory	$titleFactory

Definition at line 133 of file MergeHistory.php.

References MediaWiki\Page\MergeHistory\$dest, MediaWiki\Page\MergeHistory\$source, DB_PRIMARY, and Wikimedia\Rdbms\ILoadBalancer\getConnectionRef().

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 252 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 186 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 169 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 269 of file MergeHistory.php.

References Message\numParam().

◆ 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 317 of file MergeHistory.php.

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

◆ 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 231 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 69 of file MergeHistory.php.

◆ $dest

PageIdentity MediaWiki\Page\MergeHistory::$dest

protected

Page to which history will be merged.

Definition at line 66 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 78 of file MergeHistory.php.

◆ $revisionsMerged

int MediaWiki\Page\MergeHistory::$revisionsMerged

protected

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

Definition at line 93 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 63 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 90 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 84 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 60 of file MergeHistory.php.

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

includes/page/MergeHistory.php

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authorizeMerge()

◆ getMergedRevisionCount()

◆ getRevisionCount()

◆ isValidMerge()

◆ merge()

◆ probablyCanMerge()

Member Data Documentation

◆ $dbw

◆ $dest

◆ $maxTimestamp

◆ $revisionsMerged

◆ $source

◆ $timestampLimit

◆ $timeWhere

◆ REVISION_LIMIT