MediaWiki  master
SpecialPageLanguage Class Reference

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

Inheritance diagram for SpecialPageLanguage:
Collaboration diagram for SpecialPageLanguage:

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. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 onSubmit (array $data)
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 requiresPost ()
 Whether this action should using POST method to submit, default to true. More...
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user, default to requiresPost() More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked, default to requiresPost() More...
 
- 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. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 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. More...
 
 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. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

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. More...
 
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. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
static newSearchPage (User $user)
 Get the users preferred search page. More...
 

Protected Member Functions

 getDisplayFormat ()
 Get display format for the form. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 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'. More...
 
 postHtml ()
 Add post-HTML to the form. More...
 
 preHtml ()
 Add pre-HTML to the form. More...
 
- Protected Member Functions inherited from FormSpecialPage
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 getShowAlways ()
 Whether the form should always be shown despite the success of submission. More...
 
 getSubpageField ()
 Override this function to set the field name used in the subpage syntax. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 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. More...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

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). More...
 
- Protected Attributes inherited from FormSpecialPage
string null $par = null
 The sub-page of the special page. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Detailed Description

Special page for changing the content language of a page.

Definition at line 39 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 63 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 158 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$newLanguageLanguage code
string$reasonReason for the change
string[]$tagsChange tags to apply to the log entry
IDatabase | null$dbw
Returns
Status

Definition at line 217 of file SpecialPageLanguage.php.

References $title, ApiMessage\create(), DB_PRIMARY, IContextSource\getConfig(), IContextSource\getUser(), StatusValue\newFatal(), StatusValue\newGood(), 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 76 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 154 of file SpecialPageLanguage.php.

◆ getFormFields()

SpecialPageLanguage::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from FormSpecialPage.

Definition at line 85 of file SpecialPageLanguage.php.

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

◆ 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 334 of file SpecialPageLanguage.php.

◆ onSubmit()

◆ 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 309 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 147 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$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 330 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 80 of file SpecialPageLanguage.php.

References SpecialPage\getOutput().


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