Special page for changing the content language of a page. More...

Collaboration diagram for SpecialPageLanguage:

[legend]

Public Member Functions
	__construct (IContentHandlerFactory $contentHandlerFactory, LanguageNameUtils $languageNameUtils, ILoadBalancer $loadBalancer, SearchEngineFactory $searchEngineFactory)

	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

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

	onSubmit (array $data)

	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.

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

Public Member Functions inherited from FormSpecialPage
	execute ( $par)
	Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

	requiresPost ()
	Whether this action should using POST method to submit, default to true.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user, default to requiresPost()

	requiresWrite ()
	Whether this action requires the wiki not to be locked, default to requiresPost()

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.

	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.

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

Static Public Member Functions
static	changePageLanguage (IContextSource $context, Title $title, $newLanguage, $reason="", array $tags=[], IDatabase $dbw=null)

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	newSearchPage (User $user)
	Get the users preferred search page.

Protected Member Functions
	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

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

	postHtml ()
	Add post-HTML to the form.

	preHtml ()
	Add pre-HTML to the form.

Protected Member Functions inherited from FormSpecialPage
	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	getShowAlways ()
	Whether the form should always be shown despite the success of submission.

	getSubpageField ()
	Override this function to set the field name used in the subpage syntax.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

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!

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

Additional Inherited Members
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).

Protected Attributes inherited from FormSpecialPage
string null	$par = null
	The sub-page of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

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.

Detailed Description

Special page for changing the content language of a page.

Definition at line 40 of file SpecialPageLanguage.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPageLanguage::__construct	(	IContentHandlerFactory	$contentHandlerFactory,
		LanguageNameUtils	$languageNameUtils,
		ILoadBalancer	$loadBalancer,
		SearchEngineFactory	$searchEngineFactory )

Parameters

IContentHandlerFactory	$contentHandlerFactory
LanguageNameUtils	$languageNameUtils
ILoadBalancer	$loadBalancer
SearchEngineFactory	$searchEngineFactory

Definition at line 64 of file SpecialPageLanguage.php.

Member Function Documentation

◆ alterForm()

SpecialPageLanguage::alterForm ( HTMLForm $form )

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 159 of file SpecialPageLanguage.php.

References SpecialPage\getHookRunner(), SpecialPage\getOutput(), and HTMLForm\setSubmitTextMsg().

◆ changePageLanguage()

static SpecialPageLanguage::changePageLanguage	(	IContextSource	$context,
		Title	$title,
			$newLanguage,
			$reason = "",
		array	$tags = [],
		IDatabase	$dbw = null )

static

Since: 1.36 Added $dbw parameter

Parameters

IContextSource	$context
Title	$title
string	$newLanguage	Language code
string	$reason	Reason for the change
string[]	$tags	Change tags to apply to the log entry
IDatabase \| null	$dbw

Returns: Status

Definition at line 218 of file SpecialPageLanguage.php.

References $title, DB_PRIMARY, IContextSource\getConfig(), IContextSource\getUser(), wfEscapeWikiText(), and wfGetDB().

Referenced by ApiSetPageLanguage\execute(), and onSubmit().

◆ doesWrites()

SpecialPageLanguage::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 77 of file SpecialPageLanguage.php.

◆ getDisplayFormat()

SpecialPageLanguage::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 155 of file SpecialPageLanguage.php.

◆ getFormFields()

SpecialPageLanguage::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 86 of file SpecialPageLanguage.php.

References FormSpecialPage\$par, $title, SpecialPage\getConfig(), SpecialPage\getLanguage(), and SpecialPage\msg().

◆ getGroupName()

SpecialPageLanguage::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 335 of file SpecialPageLanguage.php.

◆ onSubmit()

SpecialPageLanguage::onSubmit ( array $data )

Parameters

array $data

Returns: Status

Reimplemented from FormSpecialPage.

Definition at line 168 of file SpecialPageLanguage.php.

References $title, changePageLanguage(), SpecialPage\getAuthority(), SpecialPage\getContext(), MalformedTitleException\getMessageObject(), and SpecialPage\getOutput().

◆ onSuccess()

SpecialPageLanguage::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since: 1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 310 of file SpecialPageLanguage.php.

References SpecialPage\getOutput().

◆ postHtml()

SpecialPageLanguage::postHtml ( )

protected

Add post-HTML to the form.

Returns: string HTML which will be sent to $form->addPostHtml()

Since: 1.38

Reimplemented from FormSpecialPage.

Definition at line 148 of file SpecialPageLanguage.php.

◆ prefixSearchSubpages()

SpecialPageLanguage::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 331 of file SpecialPageLanguage.php.

References SpecialPage\prefixSearchString().

◆ preHtml()

SpecialPageLanguage::preHtml ( )

protected

Add pre-HTML to the form.

Returns: string HTML which will be sent to $form->addPreHtml()

Since: 1.38

Reimplemented from FormSpecialPage.

Definition at line 81 of file SpecialPageLanguage.php.

References SpecialPage\getOutput().

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

includes/specials/SpecialPageLanguage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ changePageLanguage()

◆ doesWrites()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ onSubmit()

◆ onSuccess()

◆ postHtml()

◆ prefixSearchSubpages()

◆ preHtml()