Link/unlink external accounts to the current user. More...

Inherits MediaWiki\SpecialPage\AuthManagerSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialLinkAccounts:

[legend]

Public Member Functions
	__construct (AuthManager $authManager)

	execute ( $subPage)

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

Public Member Functions inherited from MediaWiki\SpecialPage\AuthManagerSpecialPage
	getRequest ()
	Get the WebRequest being used for this instance.

	handleFormSubmit ( $data)
	Submit handler callback for HTMLForm.

	onAuthChangeFormFields (array $requests, array $fieldInfo, array &$formDescriptor, $action)
	Change the form descriptor that determines how a field will look in the authentication form.

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.

	doesWrites ()
	Indicates whether POST requests to this special page require write access to the wiki.

	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 canonical, unlocalized name of this special page without namespace.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getShortDescription (string $path='')
	Similar to getDescription, but takes into account subpages 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}}.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	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', bool $alwaysRedirectToLoginPage=false)
	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)

	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
	getAuthForm (array $requests, $action)

	getDefaultAction ( $subPage)
	Get the default action for this special page if none is given via URL/POST data.

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

	getRequestBlacklist ()
	Allows blacklisting certain request types.

	success ()
	Show a success message.

Protected Member Functions inherited from MediaWiki\SpecialPage\AuthManagerSpecialPage
	addTabIndex (&$formDescriptor)
	Adds a sequential tabindex starting from 1 to all form elements.

	beforeExecute ( $subPage)

	displayForm ( $status)
	Display the form.

	fieldInfoToFormDescriptor (array $requests, array $fieldInfo, $action)
	Turns a field info array into a form descriptor.

	getAuthFormDescriptor ( $requests, $action)
	Generates a HTMLForm descriptor array from a set of authentication requests.

	getContinueAction ( $action)
	Gets the _CONTINUE version of an action.

	getLoginSecurityLevel ()

	getPreservedParams ( $options=[])
	Returns URL query parameters which should be preserved between authentication requests.

	getToken ()
	Returns the CSRF token.

	getTokenName ()
	Returns the name of the CSRF token (under which it should be found in the POST or GET data).

	handleReauthBeforeExecute ( $subPage)
	Handle redirection when the user needs to (re)authenticate.

	handleReturnBeforeExecute ( $subPage)
	Handle redirection from the /return subpage.

	hasOwnSubmitButton (AuthenticationRequest $req)
	Checks whether the given AuthenticationRequest has its own submit button.

	isActionAllowed ( $action)
	Checks whether AuthManager is ready to perform the action.

	isContinued ()
	Returns true if this is not the first step of the authentication.

	loadAuth ( $subPage, $authAction=null, $reset=false)
	Load or initialize $authAction, $authRequests and $subPage.

	messageKey ( $defaultKey)
	Return custom message key.

	needsSubmitButton (array $requests)
	Returns true if the form built from the given AuthenticationRequests needs a submit button.

	performAuthenticationStep ( $action, array $requests)

	setRequest (array $data, $wasPosted=null)
	Override the POST data, GET data from the real request is preserved.

	trySubmit ()
	Attempts to do an authentication step with the submitted data.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

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

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

Static Protected Attributes
static	$allowedActions

Static Protected Attributes inherited from MediaWiki\SpecialPage\AuthManagerSpecialPage
static string[]	$allowedActions
	The list of actions this special page deals with.

static array	$messages = []
	Customized messages.

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\AuthManagerSpecialPage
static	getField (array $array, $fieldName, $default=null)
	Get an array value, or a default if it does not exist.

static	mapFieldInfoTypeToFormDescriptorType ( $type)
	Maps AuthenticationRequest::getFieldInfo() types to HTMLForm types.

static	mapSingleFieldInfo ( $singleFieldInfo, $fieldName)
	Maps an authentication field configuration for a single field (as returned by AuthenticationRequest::getFieldInfo()) to a HTMLForm field descriptor.

static	mergeDefaultFormDescriptor (array $fieldInfo, array $formDescriptor, array $defaultFormDescriptor)
	Apply defaults to a form descriptor, without creating non-existent fields.

static	sortFormDescriptorFields (array &$formDescriptor)
	Sort the fields of a form descriptor by their 'weight' property.

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

Protected Attributes inherited from MediaWiki\SpecialPage\AuthManagerSpecialPage
string	$authAction
	one of the AuthManager::ACTION_* constants.

AuthenticationRequest[]	$authRequests

bool	$isReturn
	True if the current request is a result of returning from a redirect flow.

WebRequest null	$savedRequest
	If set, will be used instead of the real request.

string	$subPage
	Subpage of the special page.

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.

Detailed Description

Link/unlink external accounts to the current user.

To interact with this page, account providers need to register themselves with AuthManager.

Definition at line 23 of file SpecialLinkAccounts.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialLinkAccounts::__construct ( AuthManager $authManager )

Parameters

AuthManager $authManager

Definition at line 32 of file SpecialLinkAccounts.php.

References MediaWiki\SpecialPage\SpecialPage\setAuthManager().

Member Function Documentation

◆ execute()

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

Parameters

null | string $subPage

Exceptions

ErrorPageError

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 53 of file SpecialLinkAccounts.php.

◆ getAuthForm()

MediaWiki\Specials\SpecialLinkAccounts::getAuthForm	(	array	$requests,
			$action )

protected

Parameters

AuthenticationRequest[]	$requests
string	$action	AuthManager action name, should be ACTION_LINK or ACTION_LINK_CONTINUE

Returns: HTMLForm

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 113 of file SpecialLinkAccounts.php.

◆ getDefaultAction()

MediaWiki\Specials\SpecialLinkAccounts::getDefaultAction ( $subPage )

protected

Get the default action for this special page if none is given via URL/POST data.

Subclasses should override this (or override loadAuth() so this is never called).

Stability: stable: to override

Parameters

string $subPage Subpage of the special page.

Returns: string an AuthManager::ACTION_* constant.

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 104 of file SpecialLinkAccounts.php.

◆ getGroupName()

MediaWiki\Specials\SpecialLinkAccounts::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 37 of file SpecialLinkAccounts.php.

◆ getRequestBlacklist()

MediaWiki\Specials\SpecialLinkAccounts::getRequestBlacklist ( )

protected

Allows blacklisting certain request types.

Stability: stable: to override

Returns: array A list of AuthenticationRequest subclass names

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 45 of file SpecialLinkAccounts.php.

References MediaWiki\MainConfigNames\ChangeCredentialsBlacklist, and MediaWiki\SpecialPage\SpecialPage\getConfig().

◆ isListed()

MediaWiki\Specials\SpecialLinkAccounts::isListed ( )

Whether this special page is listed in Special:SpecialPages.

Stability: stable: to override

Since: 1.3 (r3583)

Returns: bool

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 41 of file SpecialLinkAccounts.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthManager().

◆ success()

MediaWiki\Specials\SpecialLinkAccounts::success ( )

protected

Show a success message.

Definition at line 122 of file SpecialLinkAccounts.php.

References MediaWiki\SpecialPage\AuthManagerSpecialPage\displayForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\loadAuth(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialLinkAccounts\execute().

Member Data Documentation

◆ $allowedActions

MediaWiki\Specials\SpecialLinkAccounts::$allowedActions

staticprotected

Initial value:

= [
        AuthManager::ACTION_LINK, AuthManager::ACTION_LINK_CONTINUE,
    ]

Definition at line 25 of file SpecialLinkAccounts.php.

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

includes/specials/SpecialLinkAccounts.php

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getAuthForm()

◆ getDefaultAction()

◆ getGroupName()

◆ getRequestBlacklist()

◆ isListed()

◆ success()

Member Data Documentation

◆ $allowedActions