MediaWiki master
MediaWiki\Specials\SpecialMergeHistory Class Reference

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

Inherits MediaWiki\SpecialPage\SpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialMergeHistory:

Public Member Functions

 __construct (MergeHistoryFactory $mergeHistoryFactory, LinkBatchFactory $linkBatchFactory, IConnectionProvider $dbProvider, RevisionStore $revisionStore, CommentFormatter $commentFormatter)
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 execute ( $par)
 Default execute method Checks user permissions.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\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.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 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.
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 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,... $params)
 Wrapper around wfMessage that sets the current context.
 
 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.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time.
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

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 MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 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.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 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.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 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 null $mDestObj
 
bool $mMerge
 Was posted?
 
bool $mSubmitted
 Was submitted?
 
string $mTarget
 
int $mTargetID
 
Title null $mTargetObj
 
string $mTimestamp
 
- Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\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 newSearchPage (User $user)
 Get the users preferred search page.
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\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 45 of file SpecialMergeHistory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialMergeHistory::__construct ( MergeHistoryFactory  $mergeHistoryFactory,
LinkBatchFactory  $linkBatchFactory,
IConnectionProvider  $dbProvider,
RevisionStore  $revisionStore,
CommentFormatter  $commentFormatter 
)
Parameters
MergeHistoryFactory$mergeHistoryFactory
LinkBatchFactory$linkBatchFactory
IConnectionProvider$dbProvider
RevisionStore$revisionStore
CommentFormatter$commentFormatter

Definition at line 95 of file SpecialMergeHistory.php.

Member Function Documentation

◆ doesWrites()

MediaWiki\Specials\SpecialMergeHistory::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 110 of file SpecialMergeHistory.php.

◆ execute()

MediaWiki\Specials\SpecialMergeHistory::execute (   $subPage)

Default execute method Checks user permissions.

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

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 145 of file SpecialMergeHistory.php.

References MediaWiki\SpecialPage\SpecialPage\checkPermissions(), MediaWiki\SpecialPage\SpecialPage\checkReadOnly(), MediaWiki\SpecialPage\SpecialPage\outputHeader(), MediaWiki\SpecialPage\SpecialPage\setHeaders(), MediaWiki\SpecialPage\SpecialPage\useTransactionalTimeLimit(), and wfEscapeWikiText().

◆ getGroupName()

MediaWiki\Specials\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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 404 of file SpecialMergeHistory.php.

Member Data Documentation

◆ $mAction

string MediaWiki\Specials\SpecialMergeHistory::$mAction
protected

Definition at line 47 of file SpecialMergeHistory.php.

◆ $mComment

string MediaWiki\Specials\SpecialMergeHistory::$mComment
protected

Definition at line 65 of file SpecialMergeHistory.php.

◆ $mDest

string MediaWiki\Specials\SpecialMergeHistory::$mDest
protected

Definition at line 53 of file SpecialMergeHistory.php.

◆ $mDestID

int MediaWiki\Specials\SpecialMergeHistory::$mDestID
protected

Definition at line 62 of file SpecialMergeHistory.php.

◆ $mDestObj

Title null MediaWiki\Specials\SpecialMergeHistory::$mDestObj
protected

Definition at line 77 of file SpecialMergeHistory.php.

◆ $mMerge

bool MediaWiki\Specials\SpecialMergeHistory::$mMerge
protected

Was posted?

Definition at line 68 of file SpecialMergeHistory.php.

◆ $mSubmitted

bool MediaWiki\Specials\SpecialMergeHistory::$mSubmitted
protected

Was submitted?

Definition at line 71 of file SpecialMergeHistory.php.

◆ $mTarget

string MediaWiki\Specials\SpecialMergeHistory::$mTarget
protected

Definition at line 50 of file SpecialMergeHistory.php.

◆ $mTargetID

int MediaWiki\Specials\SpecialMergeHistory::$mTargetID
protected

Definition at line 59 of file SpecialMergeHistory.php.

◆ $mTargetObj

Title null MediaWiki\Specials\SpecialMergeHistory::$mTargetObj
protected

Definition at line 74 of file SpecialMergeHistory.php.

◆ $mTimestamp

string MediaWiki\Specials\SpecialMergeHistory::$mTimestamp
protected

Definition at line 56 of file SpecialMergeHistory.php.


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