Inheritance diagram for SpecialInterwiki:

[legend]

Collaboration diagram for SpecialInterwiki:

[legend]

Public Member Functions
	__construct ()
	Constructor - sets up the new special page.

	canModify ( $out=false)
	Returns boolean whether the user can modify the data.

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

	execute ( $par)
	Show the special page.

	getDescription ()
	Different description will be shown on Special:SpecialPage depending on whether the user can modify the data.

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

	onSubmit (array $data)

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.

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

Protected Member Functions
	error (... $args)

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

	makeTable ( $canModify, $iwPrefixes)

	showForm ( $action)

	showList ()

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.

	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.

	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.

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

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Implements Special:Interwiki.

Definition at line 9 of file SpecialInterwiki.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialInterwiki::__construct ( )

Constructor - sets up the new special page.

Definition at line 13 of file SpecialInterwiki.php.

Member Function Documentation

◆ canModify()

SpecialInterwiki::canModify ( $out = false )

Returns boolean whether the user can modify the data.

Parameters

OutputPage | bool $out If $wgOut object given, it adds the respective error message.

Exceptions

PermissionsError|ReadOnlyError

Returns: bool

Definition at line 66 of file SpecialInterwiki.php.

References $out, $wgInterwikiCache, and(), SpecialPage\getUser(), and wfReadOnly().

Referenced by execute(), getDescription(), and showList().

◆ doesWrites()

SpecialInterwiki::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 17 of file SpecialInterwiki.php.

◆ error()

SpecialInterwiki::error ( $args )

protected

Parameters

string ...$args

Definition at line 505 of file SpecialInterwiki.php.

References $args, and SpecialPage\getOutput().

◆ execute()

SpecialInterwiki::execute ( $par )

Show the special page.

Parameters

string | null $par parameter passed to the page or null

Reimplemented from SpecialPage.

Definition at line 41 of file SpecialInterwiki.php.

References $out, $request, and(), canModify(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showForm(), and showList().

◆ getDescription()

SpecialInterwiki::getDescription ( )

Different description will be shown on Special:SpecialPage depending on whether the user can modify the data.

Returns: String

Reimplemented from SpecialPage.

Definition at line 26 of file SpecialInterwiki.php.

References canModify(), SpecialPage\msg(), and plain.

◆ getGroupName()

SpecialInterwiki::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 509 of file SpecialInterwiki.php.

◆ getSubpagesForPrefixSearch()

SpecialInterwiki::getSubpagesForPrefixSearch ( )

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

If this method requires a query you might instead want to implement prefixSearchSubpages() directly so you can support $limit and $offset. This method is better for static-ish lists of things.

Returns: string[] subpages to search from

Reimplemented from SpecialPage.

Definition at line 31 of file SpecialInterwiki.php.

◆ makeTable()

SpecialInterwiki::makeTable	(		$canModify,
			$iwPrefixes )

protected

Definition at line 418 of file SpecialInterwiki.php.

References $attribs, $out, and(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\msg(), and text.

Referenced by showList().

◆ onSubmit()

SpecialInterwiki::onSubmit ( array $data )

Definition at line 222 of file SpecialInterwiki.php.

References $data, $request, $rows, $wgContLang, $wgLegalTitleChars, and(), DB_MASTER, SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), wfGetDB(), and wfParseUrl().

◆ showForm()

SpecialInterwiki::showForm ( $action )

protected

Parameters

string $action The action of the form

Definition at line 92 of file SpecialInterwiki.php.

References $dbr, $formDescriptor, $request, and(), DB_REPLICA, SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\msg(), and wfGetDB().

Referenced by execute().

◆ showList()

SpecialInterwiki::showList ( )

protected

Definition at line 304 of file SpecialInterwiki.php.

References $res, and(), array(), canModify(), DB_REPLICA, error, SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getTitleFor(), makeTable(), SpecialPage\msg(), text, wfGetDB(), and wfWikiID().

Referenced by execute().

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

extensions/Interwiki/includes/SpecialInterwiki.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canModify()

◆ doesWrites()

◆ error()

◆ execute()

◆ getDescription()

◆ getGroupName()

◆ getSubpagesForPrefixSearch()

◆ makeTable()

◆ onSubmit()

◆ showForm()

◆ showList()