MergeHistory Class Reference

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

Collaboration diagram for MergeHistory:

Public Member Functions
	__construct (Title $source, Title $dest, $timestamp=false, ILoadBalancer $loadBalancer=null, PermissionManager $permManager=null, IContentHandlerFactory $contentHandlerFactory=null, RevisionStore $revisionStore=null, WatchedItemStoreInterface $watchedItemStore=null, SpamChecker $spamChecker=null)
	Since 1.35 dependencies are injected and not providing them is hard deprecated; use the MergeHistoryFactory service.
	checkPermissions (User $user, $reason)
	Check if the merge is possible.
	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 sanity checks that the merge is valid.
	merge (User $user, $reason='')
	Actually attempt the history move.

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.
Title	$dest
	Page to which history will be merged.
MWTimestamp	$maxTimestamp
	Maximum timestamp that we can use (oldest timestamp of dest)
int	$revisionsMerged
	Number of revisions merged (for Special:MergeHistory success message)
Title	$source
	Page from which history will be merged.
MWTimestamp bool	$timestampLimit
	Timestamp upto which history from the source will be merged.
string	$timeWhere
	SQL WHERE condition that selects source revisions to insert into destination.

Private Attributes
IContentHandlerFactory	$contentHandlerFactory
PermissionManager	$permManager
RevisionStore	$revisionStore
SpamChecker	$spamChecker
WatchedItemStoreInterface	$watchedItemStore

Detailed Description

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

Since

1.27

Definition at line 41 of file MergeHistory.php.

Constructor & Destructor Documentation

__construct()

MergeHistory::__construct	(	Title	$source,
		Title	$dest,
			$timestamp = false,
		ILoadBalancer	$loadBalancer = null,
		PermissionManager	$permManager = null,
		IContentHandlerFactory	$contentHandlerFactory = null,
		RevisionStore	$revisionStore = null,
		WatchedItemStoreInterface	$watchedItemStore = null,
		SpamChecker	$spamChecker = null
	)

Since 1.35 dependencies are injected and not providing them is hard deprecated; use the MergeHistoryFactory service.

Parameters

Title	$source	Page from which history will be merged
Title	$dest	Page to which history will be merged
string | bool	$timestamp	Timestamp up to which history from the source will be merged
ILoadBalancer | null	$loadBalancer
PermissionManager | null	$permManager
IContentHandlerFactory | null	$contentHandlerFactory
RevisionStore | null	$revisionStore
WatchedItemStoreInterface | null	$watchedItemStore
SpamChecker | null	$spamChecker

Definition at line 96 of file MergeHistory.php.

References $source, DB_MASTER, and wfDeprecatedMsg().

Member Function Documentation

checkPermissions()

MergeHistory::checkPermissions	(	User	$user,
			$reason
	)

Check if the merge is possible.

Parameters

User	$user
string	$reason

Returns

Status

Definition at line 219 of file MergeHistory.php.

References wfMergeErrorArrays().

Referenced by merge().

getMergedRevisionCount()

MergeHistory::getMergedRevisionCount

(

)

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

Returns

int

Definition at line 209 of file MergeHistory.php.

getRevisionCount()

MergeHistory::getRevisionCount

(

)

Get the number of revisions that will be moved.

Returns

int

Definition at line 194 of file MergeHistory.php.

Referenced by isValidMerge().

isValidMerge()

MergeHistory::isValidMerge

(

)

Does various sanity checks that the merge is valid.

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

Returns

Status

Definition at line 257 of file MergeHistory.php.

References getRevisionCount(), and Message\numParam().

Referenced by merge().

merge()

MergeHistory::merge	(	User	$user,
			$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

User	$user
string	$reason

Returns

Status status of the history merge

Definition at line 305 of file MergeHistory.php.

References checkPermissions(), isValidMerge(), wfMessage(), and wfTimestampNow().

Member Data Documentation

$contentHandlerFactory

IContentHandlerFactory MergeHistory::$contentHandlerFactory

private

Definition at line 71 of file MergeHistory.php.

$dbw

IDatabase MergeHistory::$dbw

protected

Database that we are using.

Definition at line 53 of file MergeHistory.php.

$dest

Title MergeHistory::$dest

protected

Page to which history will be merged.

Definition at line 50 of file MergeHistory.php.

$maxTimestamp

MWTimestamp MergeHistory::$maxTimestamp

protected

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

Definition at line 56 of file MergeHistory.php.

$permManager

PermissionManager MergeHistory::$permManager

private

Definition at line 68 of file MergeHistory.php.

$revisionsMerged

int MergeHistory::$revisionsMerged

protected

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

Definition at line 65 of file MergeHistory.php.

$revisionStore

RevisionStore MergeHistory::$revisionStore

private

Definition at line 74 of file MergeHistory.php.

$source

Title MergeHistory::$source

protected

Page from which history will be merged.

Definition at line 47 of file MergeHistory.php.

$spamChecker

SpamChecker MergeHistory::$spamChecker

private

Definition at line 80 of file MergeHistory.php.

$timestampLimit

MWTimestamp bool MergeHistory::$timestampLimit

protected

Timestamp upto which history from the source will be merged.

Definition at line 62 of file MergeHistory.php.

$timeWhere

string MergeHistory::$timeWhere

protected

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

Definition at line 59 of file MergeHistory.php.

$watchedItemStore

WatchedItemStoreInterface MergeHistory::$watchedItemStore

private

Definition at line 77 of file MergeHistory.php.

REVISION_LIMIT

const MergeHistory::REVISION_LIMIT = 5000

Maximum number of revisions that can be merged at once.

Definition at line 44 of file MergeHistory.php.

---

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

• includes/MergeHistory.php