Special page allowing users with the appropriate permissions to merge article histories, with some restrictions. More...

Inheritance diagram for SpecialMergeHistory:

[legend]

Collaboration diagram for SpecialMergeHistory:

[legend]

Public Member Functions
	__construct ()

	doesWrites ()
	Indicates whether this special page may perform database writes.

	execute ( $par)
	Default execute method Checks user permissions.

	formatRevisionRow ( $row)

	merge ()
	Actually attempt the history move.

	showMergeForm ()

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getConfig ()
	Shortcut to get main config object.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getTitle ( $subpage=false)
	Get a self-referential title object.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key)
	Wrapper around wfMessage that sets the current context.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Public Attributes
int[]	$prevId

Protected Member Functions
	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	getCacheTTL ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
string	$mAction

string	$mComment

string	$mDest

int	$mDestID

Title	$mDestObj

bool	$mMerge
	Was posted?

bool	$mSubmitted
	Was submitted?

string	$mTarget

int	$mTargetID

Title	$mTargetObj

string	$mTimestamp

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	loadRequestParams ()

	showHistory ()

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

Special page allowing users with the appropriate permissions to merge article histories, with some restrictions.

Definition at line 30 of file SpecialMergeHistory.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialMergeHistory::__construct ( )

Definition at line 67 of file SpecialMergeHistory.php.

Member Function Documentation

◆ doesWrites()

SpecialMergeHistory::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 71 of file SpecialMergeHistory.php.

◆ execute()

SpecialMergeHistory::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 106 of file SpecialMergeHistory.php.

References SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), SpecialPage\getOutput(), loadRequestParams(), merge(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showHistory(), showMergeForm(), SpecialPage\useTransactionalTimeLimit(), and wfEscapeWikiText().

◆ formatRevisionRow()

SpecialMergeHistory::formatRevisionRow ( $row )

Definition at line 277 of file SpecialMergeHistory.php.

References $last, SpecialPage\$linkRenderer, $rev, Linker\formatRevisionSize(), SpecialPage\getLinkRenderer(), SpecialPage\getUser(), SpecialPage\msg(), Linker\revComment(), Linker\revUserTools(), and wfTimestamp().

◆ getGroupName()

SpecialMergeHistory::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 382 of file SpecialMergeHistory.php.

◆ loadRequestParams()

SpecialMergeHistory::loadRequestParams ( )

private

Returns: void

Definition at line 78 of file SpecialMergeHistory.php.

References $request, SpecialPage\getRequest(), and SpecialPage\getUser().

Referenced by execute().

◆ merge()

SpecialMergeHistory::merge ( )

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 target page of merges?

Returns: bool Success

Definition at line 340 of file SpecialMergeHistory.php.

References SpecialPage\$linkRenderer, SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by execute().

◆ showHistory()

SpecialMergeHistory::showHistory ( )

private

Definition at line 190 of file SpecialMergeHistory.php.

References $out, SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), SpecialPage\msg(), LogEventsList\showLogExtract(), showMergeForm(), and text.

Referenced by execute().

◆ showMergeForm()

SpecialMergeHistory::showMergeForm ( )

Definition at line 158 of file SpecialMergeHistory.php.

References $out, SpecialPage\addHelpLink(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\msg(), text, and wfScript().

Referenced by execute(), and showHistory().

Member Data Documentation

◆ $mAction

string SpecialMergeHistory::$mAction

protected

Definition at line 32 of file SpecialMergeHistory.php.

◆ $mComment

string SpecialMergeHistory::$mComment

protected

Definition at line 50 of file SpecialMergeHistory.php.

◆ $mDest

string SpecialMergeHistory::$mDest

protected

Definition at line 38 of file SpecialMergeHistory.php.

◆ $mDestID

int SpecialMergeHistory::$mDestID

protected

Definition at line 47 of file SpecialMergeHistory.php.

◆ $mDestObj

Title SpecialMergeHistory::$mDestObj

protected

Definition at line 62 of file SpecialMergeHistory.php.

◆ $mMerge

bool SpecialMergeHistory::$mMerge

protected

Was posted?

Definition at line 53 of file SpecialMergeHistory.php.

◆ $mSubmitted

bool SpecialMergeHistory::$mSubmitted

protected

Was submitted?

Definition at line 56 of file SpecialMergeHistory.php.

◆ $mTarget

string SpecialMergeHistory::$mTarget

protected

Definition at line 35 of file SpecialMergeHistory.php.

◆ $mTargetID

int SpecialMergeHistory::$mTargetID

protected

Definition at line 44 of file SpecialMergeHistory.php.

◆ $mTargetObj

Title SpecialMergeHistory::$mTargetObj

protected

Definition at line 59 of file SpecialMergeHistory.php.

◆ $mTimestamp

string SpecialMergeHistory::$mTimestamp

protected

Definition at line 41 of file SpecialMergeHistory.php.

◆ $prevId

int [] SpecialMergeHistory::$prevId

Definition at line 65 of file SpecialMergeHistory.php.

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

includes/specials/SpecialMergeHistory.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ execute()

◆ formatRevisionRow()

◆ getGroupName()

◆ loadRequestParams()

◆ merge()

◆ showHistory()

◆ showMergeForm()

Member Data Documentation

◆ $mAction

◆ $mComment

◆ $mDest

◆ $mDestID

◆ $mDestObj

◆ $mMerge

◆ $mSubmitted

◆ $mTarget

◆ $mTargetID

◆ $mTargetObj

◆ $mTimestamp

◆ $prevId