A special page that allows users to change page titles. More...

Inheritance diagram for MovePageForm:

[legend]

Collaboration diagram for MovePageForm:

[legend]

Public Member Functions
	__construct (MovePageFactory $movePageFactory=null, PermissionManager $permManager=null, UserOptionsLookup $userOptionsLookup=null, ILoadBalancer $loadBalancer=null, IContentHandlerFactory $contentHandlerFactory=null, NamespaceInfo $nsInfo=null, LinkBatchFactory $linkBatchFactory=null, RepoGroup $repoGroup=null, WikiPageFactory $wikiPageFactory=null, SearchEngineFactory $searchEngineFactory=null, WatchlistManager $watchlistManager=null)

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

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

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

Public Member Functions inherited from UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')

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

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.

	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.

	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}}.

	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.

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

	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'.

	showForm ( $err, $isPermError=false)
	Show the form.

Protected Member Functions inherited from 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 ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	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
bool	$deleteAndMove

bool	$fixRedirects

bool	$leaveRedirect

bool	$moveOverShared

bool	$moveSubpages

bool	$moveTalk

Title	$newTitle

Title	$oldTitle = null

string	$reason
	Text input.

Protected Attributes inherited from 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 for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Private Member Functions
	doSubmit ()

	showLogFragment ( $title)

	showSubpages ( $title)
	Show subpages of the page being moved.

	showSubpagesList ( $subpages, $pagecount, $wikiMsg, $noSubpageMsg=false)

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

A special page that allows users to change page titles.

Definition at line 39 of file SpecialMovepage.php.

Constructor & Destructor Documentation

◆ __construct()

MovePageForm::__construct	(	MovePageFactory	$movePageFactory = `null`,
		PermissionManager	$permManager = `null`,
		UserOptionsLookup	$userOptionsLookup = `null`,
		ILoadBalancer	$loadBalancer = `null`,
		IContentHandlerFactory	$contentHandlerFactory = `null`,
		NamespaceInfo	$nsInfo = `null`,
		LinkBatchFactory	$linkBatchFactory = `null`,
		RepoGroup	$repoGroup = `null`,
		WikiPageFactory	$wikiPageFactory = `null`,
		SearchEngineFactory	$searchEngineFactory = `null`,
		WatchlistManager	$watchlistManager = `null`
	)

Parameters

MovePageFactory \| null	$movePageFactory
PermissionManager \| null	$permManager
UserOptionsLookup \| null	$userOptionsLookup
ILoadBalancer \| null	$loadBalancer
IContentHandlerFactory \| null	$contentHandlerFactory
NamespaceInfo \| null	$nsInfo
LinkBatchFactory \| null	$linkBatchFactory
RepoGroup \| null	$repoGroup
WikiPageFactory \| null	$wikiPageFactory
SearchEngineFactory \| null	$searchEngineFactory
WatchlistManager \| null	$watchlistManager

Definition at line 117 of file SpecialMovepage.php.

References $searchEngineFactory, $userOptionsLookup, and $watchlistManager.

Member Function Documentation

◆ doesWrites()

MovePageForm::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 146 of file SpecialMovepage.php.

◆ doSubmit()

MovePageForm::doSubmit ( )

private

◆ execute()

MovePageForm::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 SpecialPage.

Definition at line 150 of file SpecialMovepage.php.

References SpecialPage\checkReadOnly(), doSubmit(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showForm(), and SpecialPage\useTransactionalTimeLimit().

◆ getGroupName()

MovePageForm::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 SpecialPage.

Definition at line 987 of file SpecialMovepage.php.

◆ prefixSearchSubpages()

MovePageForm::prefixSearchSubpages	(	$search,
		$limit,
		$offset
	)

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 983 of file SpecialMovepage.php.

References SpecialPage\prefixSearchString().

◆ showForm()

MovePageForm::showForm	(	$err,
		$isPermError = `false`
	)

protected

Show the form.

Parameters

	(string\|array)[]	$err Error messages. Each item is an error message. It may either be a string message name or array message name and parameters, like the second argument to OutputPage::wrapWikiMsg().
bool	$isPermError	Whether the error message is about user permissions.

Definition at line 225 of file SpecialMovepage.php.

References $dbr, SpecialPage\addHelpLink(), SpecialPage\getConfig(), SpecialPage\getLanguage(), Title\getNamespace(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Title\getPrefixedText(), SpecialPage\getSkin(), Title\getTalkPage(), Title\getText(), SpecialPage\getUser(), SpecialPage\msg(), NS_CATEGORY, NS_USER, showLogFragment(), and showSubpages().

Referenced by doSubmit(), and execute().

◆ showLogFragment()

MovePageForm::showLogFragment ( $title )

private

Definition at line 910 of file SpecialMovepage.php.

References $title, and SpecialPage\getOutput().

Referenced by showForm().

◆ showSubpages()

MovePageForm::showSubpages ( $title )

private

Show subpages of the page being moved.

Section is not shown if both current namespace does not support subpages and no talk subpages were found.

Parameters

Title $title Page being moved.

Definition at line 923 of file SpecialMovepage.php.

References $title, SpecialPage\getOutput(), and showSubpagesList().

Referenced by showForm().

◆ showSubpagesList()

MovePageForm::showSubpagesList	(	$subpages,
		$pagecount,
		$wikiMsg,
		$noSubpageMsg = `false`
	)

private

Definition at line 951 of file SpecialMovepage.php.

References SpecialPage\$linkRenderer, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), and MediaWiki\Linker\LinkRenderer\makeLink().

Referenced by showSubpages().

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory MovePageForm::$contentHandlerFactory

private

Definition at line 84 of file SpecialMovepage.php.

◆ $deleteAndMove

bool MovePageForm::$deleteAndMove

protected

Definition at line 55 of file SpecialMovepage.php.

◆ $fixRedirects

bool MovePageForm::$fixRedirects

protected

Definition at line 61 of file SpecialMovepage.php.

◆ $leaveRedirect

bool MovePageForm::$leaveRedirect

protected

Definition at line 64 of file SpecialMovepage.php.

◆ $linkBatchFactory

LinkBatchFactory MovePageForm::$linkBatchFactory

private

Definition at line 90 of file SpecialMovepage.php.

◆ $loadBalancer

ILoadBalancer MovePageForm::$loadBalancer

private

Definition at line 81 of file SpecialMovepage.php.

◆ $moveOverShared

bool MovePageForm::$moveOverShared

protected

Definition at line 67 of file SpecialMovepage.php.

◆ $movePageFactory

MovePageFactory MovePageForm::$movePageFactory

private

Definition at line 72 of file SpecialMovepage.php.

◆ $moveSubpages

bool MovePageForm::$moveSubpages

protected

Definition at line 58 of file SpecialMovepage.php.

◆ $moveTalk

bool MovePageForm::$moveTalk

protected

Definition at line 52 of file SpecialMovepage.php.

◆ $newTitle

Title MovePageForm::$newTitle

protected

Definition at line 44 of file SpecialMovepage.php.

◆ $nsInfo

NamespaceInfo MovePageForm::$nsInfo

private

Definition at line 87 of file SpecialMovepage.php.

◆ $oldTitle

Title MovePageForm::$oldTitle = null

protected

Definition at line 41 of file SpecialMovepage.php.

◆ $permManager

PermissionManager MovePageForm::$permManager

private

Definition at line 75 of file SpecialMovepage.php.

◆ $reason

string MovePageForm::$reason

protected

Text input.

Definition at line 47 of file SpecialMovepage.php.

◆ $repoGroup

RepoGroup MovePageForm::$repoGroup

private

Definition at line 93 of file SpecialMovepage.php.

◆ $searchEngineFactory

SearchEngineFactory MovePageForm::$searchEngineFactory

private

Definition at line 99 of file SpecialMovepage.php.

◆ $userOptionsLookup

UserOptionsLookup MovePageForm::$userOptionsLookup

private

Definition at line 78 of file SpecialMovepage.php.

◆ $watch

MovePageForm::$watch = false

private

Definition at line 69 of file SpecialMovepage.php.

◆ $watchlistManager

WatchlistManager MovePageForm::$watchlistManager

private

Definition at line 102 of file SpecialMovepage.php.

◆ $wikiPageFactory

WikiPageFactory MovePageForm::$wikiPageFactory

private

Definition at line 96 of file SpecialMovepage.php.

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

includes/specials/SpecialMovepage.php

Private Attributes
IContentHandlerFactory	$contentHandlerFactory

LinkBatchFactory	$linkBatchFactory

ILoadBalancer	$loadBalancer

MovePageFactory	$movePageFactory

NamespaceInfo	$nsInfo

PermissionManager	$permManager

RepoGroup	$repoGroup

SearchEngineFactory	$searchEngineFactory

UserOptionsLookup	$userOptionsLookup

	$watch = false

WatchlistManager	$watchlistManager

WikiPageFactory	$wikiPageFactory

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ doSubmit()

◆ execute()

◆ getGroupName()

◆ prefixSearchSubpages()

◆ showForm()

◆ showLogFragment()

◆ showSubpages()

◆ showSubpagesList()

Member Data Documentation

◆ $contentHandlerFactory

◆ $deleteAndMove

◆ $fixRedirects

◆ $leaveRedirect

◆ $linkBatchFactory

◆ $loadBalancer

◆ $moveOverShared

◆ $movePageFactory

◆ $moveSubpages

◆ $moveTalk

◆ $newTitle

◆ $nsInfo

◆ $oldTitle

◆ $permManager

◆ $reason

◆ $repoGroup

◆ $searchEngineFactory

◆ $userOptionsLookup

◆ $watch

◆ $watchlistManager

◆ $wikiPageFactory