Holds shared logic for login and account creation pages. More...

Inherits MediaWiki\SpecialPage\AuthManagerSpecialPage.

Inherited by MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Collaboration diagram for MediaWiki\SpecialPage\LoginSignupSpecialPage:

[legend]

Public Member Functions

execute ( $subPage)

onAuthChangeFormFields (array $requests, array $fieldInfo, array &$formDescriptor, $action)

Change the form descriptor that determines how a field will look in the authentication form.Called from fieldInfoToFormDescriptor().

Stability: stable: to override

Parameters

AuthenticationRequest[]	$requests
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses).
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	Authentication type (one of the AuthManager::ACTION_* constants)

showReturnToPage ( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)

Add a "return to" link or redirect to it.

Public Member Functions inherited from MediaWiki\SpecialPage\AuthManagerSpecialPage

getRequest ()

Get the WebRequest being used for this instance.

handleFormSubmit ( $data)

Submit handler callback for HTMLForm.

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 this special page may perform database writes.

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

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

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
	beforeExecute ( $subPage)

	getAuthForm (array $requests, $action)
	Generates a form from the given request.

	getBenefitsContainerHtml ()
	The HTML to be shown in the "benefits to signing in / creating an account" section of the signup/login page.

	getFieldDefinitions (array $fieldInfo)
	Create a HTMLForm descriptor for the core login fields.

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

	getNoticeHtml ()
	Generates the HTML for a notice box to be displayed to a temporary user.

	getPageHtml ( $formHtml)
	Add page elements which are outside the form.

	getPreservedParams ( $withToken=false)
	Returns URL query parameters which can be used to reload the page (or leave and return) while preserving all information that is necessary for authentication to continue.

	getReturnToQueryStringFragment ()
	Returns a string that can be appended to the URL (without encoding) to preserve the return target.

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

	hasSessionCookie ()
	Check if a session cookie is present.

	isSignup ()

	load ( $subPage)
	Load data from request.

	logAuthResult ( $success, $status=null)
	Logs to the authmanager-stats channel.

	mainLoginForm (array $requests, $msg='', $msgtype='error')

	makeLanguageSelector ()
	Produce a bar of links which allow the user to select another language during login/registration but retain "returnto".

	makeLanguageSelectorLink ( $text, $lang)
	Create a language selector link for a particular language Links back to this page preserving type and returnto.

	postProcessFormDescriptor (&$formDescriptor, $requests)

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

	setSessionUserForCurrentRequest ()
	Replace some globals to make sure the fact that the user has just been logged in is reflected in the current request.

	showExtraInformation ()
	Show extra information such as password recovery information, link from login to signup, CTA etc? Such information should only be shown on the "landing page", ie.

	showSuccessPage ( $type, $title, $msgname, $injected_html, $extraMessages)
	Show the success page.

	successfulAction ( $direct=false, $extraMessages=null)

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

	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.

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

	getLoginSecurityLevel ()

	getRequestBlacklist ()
	Allows blacklisting certain request types.

	getToken ()
	Returns the CSRF token.

	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)

	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 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
HTMLForm null	$authForm

	$mAction

	$mEntryError = ''

	$mEntryErrorType = 'error'

	$mFromHTTP

	$mLanguage

	$mLoaded = false

	$mLoadedRequest = false

	$mPosted

	$mReturnTo

	$mReturnToQuery

	$mSecureLoginUrl

	$mStickHTTPS

	$mToken

	$mVariant

bool	$proxyAccountCreation
	True if the user if creating an account for someone else.

string	$securityLevel

User	$targetUser
	FIXME another flag for passing data.

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.

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

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.

Detailed Description

Holds shared logic for login and account creation pages.

Definition at line 61 of file LoginSignupSpecialPage.php.

Member Function Documentation

◆ beforeExecute()

MediaWiki\SpecialPage\LoginSignupSpecialPage::beforeExecute ( $subPage )

protected

Stability: stable: to override

Parameters

string | null $subPage

Returns: bool|void

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Reimplemented in MediaWiki\Specials\SpecialUserLogin.

Definition at line 221 of file LoginSignupSpecialPage.php.

References MediaWiki\SpecialPage\AuthManagerSpecialPage\$subPage.

◆ execute()

MediaWiki\SpecialPage\LoginSignupSpecialPage::execute ( $subPage )

Parameters

string | null $subPage

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 231 of file LoginSignupSpecialPage.php.

◆ getAuthForm()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getAuthForm	(	array	$requests,
			$action )

protected

Generates a form from the given request.

Parameters

AuthenticationRequest[]	$requests
string	$action	AuthManager action name

Returns: HTMLForm

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 751 of file LoginSignupSpecialPage.php.

References MediaWiki\MainConfigNames\ForceHTTPS, getContext(), getRequest(), and MediaWiki\MainConfigNames\SecureLogin.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm().

◆ getBenefitsContainerHtml()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getBenefitsContainerHtml ( )

protected

The HTML to be shown in the "benefits to signing in / creating an account" section of the signup/login page.

Stability: unstable: Experimental method added in 1.38. As noted in the comment from 2015 for getPageHtml, this should use a template.

Returns: string

Definition at line 667 of file LoginSignupSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getUser(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml().

◆ getFieldDefinitions()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getFieldDefinitions ( array $fieldInfo )

protected

Create a HTMLForm descriptor for the core login fields.

Parameters

array $fieldInfo

Returns: array

Definition at line 831 of file LoginSignupSpecialPage.php.

References $params, MediaWiki\Html\element(), MediaWiki\MainConfigNames\EmailConfirmToEdit, MediaWiki\MediaWikiServices\getInstance(), getRequest(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), getUser(), and Skin\makeInternalOrExternalUrl().

◆ getGroupName()

MediaWiki\SpecialPage\LoginSignupSpecialPage::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.

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 1292 of file LoginSignupSpecialPage.php.

◆ getNoticeHtml()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getNoticeHtml ( )

protected

Generates the HTML for a notice box to be displayed to a temporary user.

Returns: string HTML representing the notice box

Definition at line 1344 of file LoginSignupSpecialPage.php.

References getUser().

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml().

◆ getPageHtml()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getPageHtml ( $formHtml )

protected

Add page elements which are outside the form.

FIXME this should probably be a template, but use a sensible language (handlebars?)

Parameters

string $formHtml

Returns: string

Definition at line 611 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm().

◆ getPreservedParams()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getPreservedParams ( $withToken = false )

protected

Returns URL query parameters which can be used to reload the page (or leave and return) while preserving all information that is necessary for authentication to continue.

These parameters will be preserved in the action URL of the form and in the return URL for redirect flow.

Stability: stable: to override

Parameters

bool $withToken Include CSRF token

Returns: array

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 209 of file LoginSignupSpecialPage.php.

References $params, MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\LoginSignupSpecialPage\isSignup(), and MediaWiki\MainConfigNames\SecureLogin.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ getReturnToQueryStringFragment()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getReturnToQueryStringFragment ( )

protected

Returns a string that can be appended to the URL (without encoding) to preserve the return target.

Does not include leading '?'/'&'.

Returns: string

Definition at line 1207 of file LoginSignupSpecialPage.php.

References wfUrlencode().

◆ getTokenName()

MediaWiki\SpecialPage\LoginSignupSpecialPage::getTokenName ( )

protected

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

Stability: stable: to override

Returns: string

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 1228 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), and MediaWiki\SpecialPage\LoginSignupSpecialPage\load().

◆ hasSessionCookie()

MediaWiki\SpecialPage\LoginSignupSpecialPage::hasSessionCookie ( )

protected

Check if a session cookie is present.

This will not pick up a cookie set during this request, but is meant to ensure that the client is returning the cookie which was set on a previous pass through the system.

Returns: bool

Definition at line 1196 of file LoginSignupSpecialPage.php.

References getRequest().

Referenced by MediaWiki\Specials\SpecialCreateAccount\successfulAction(), and MediaWiki\Specials\SpecialUserLogin\successfulAction().

◆ isSignup()

MediaWiki\SpecialPage\LoginSignupSpecialPage::isSignup ( )

abstractprotected

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPreservedParams(), and MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm().

◆ load()

MediaWiki\SpecialPage\LoginSignupSpecialPage::load ( $subPage )

protected

Load data from request.

Access: internal

Parameters

string $subPage Subpage of Special:Userlogin

Definition at line 142 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ logAuthResult()

MediaWiki\SpecialPage\LoginSignupSpecialPage::logAuthResult	(		$success,
			$status = null )

abstractprotected

Logs to the authmanager-stats channel.

Parameters

bool	$success
string \| null	$status	Error message key

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ mainLoginForm()

MediaWiki\SpecialPage\LoginSignupSpecialPage::mainLoginForm	(	array	$requests,
			$msg = '',
			$msgtype = 'error' )

protected

Parameters

AuthenticationRequest[]	$requests	A list of AuthorizationRequest objects, used to generate the form fields. An empty array means a fatal error (authentication cannot continue).
string \| Message	$msg
string	$msgtype

Exceptions

ErrorPageError
Exception
FatalError
PermissionsError
ReadOnlyError

Access: internal

Definition at line 544 of file LoginSignupSpecialPage.php.

References MediaWiki\SpecialPage\LoginSignupSpecialPage\getAuthForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\getDefaultAction(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\SpecialPage\SpecialPage\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\SpecialPage\LoginSignupSpecialPage\isSignup(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), and MediaWiki\Specials\SpecialUserLogin\successfulAction().

◆ makeLanguageSelector()

MediaWiki\SpecialPage\LoginSignupSpecialPage::makeLanguageSelector ( )

protected

Produce a bar of links which allow the user to select another language during login/registration but retain "returnto".

Returns: string

Definition at line 1238 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml().

◆ makeLanguageSelectorLink()

MediaWiki\SpecialPage\LoginSignupSpecialPage::makeLanguageSelectorLink	(		$text,
			$lang )

protected

Create a language selector link for a particular language Links back to this page preserving type and returnto.

Parameters

string	$text	Link text
string	$lang	Language code

Returns: string

Definition at line 1265 of file LoginSignupSpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ onAuthChangeFormFields()

MediaWiki\SpecialPage\LoginSignupSpecialPage::onAuthChangeFormFields	(	array	$requests,
		array	$fieldInfo,
		array &	$formDescriptor,
			$action )

Change the form descriptor that determines how a field will look in the authentication form.Called from fieldInfoToFormDescriptor().

Stability: stable: to override

Parameters

AuthenticationRequest[]	$requests
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses).
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	Authentication type (one of the AuthManager::ACTION_* constants)

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 808 of file LoginSignupSpecialPage.php.

◆ postProcessFormDescriptor()

MediaWiki\SpecialPage\LoginSignupSpecialPage::postProcessFormDescriptor	(	&	$formDescriptor,
			$requests )

protected

Parameters

array	&$formDescriptor
array	$requests

Definition at line 1300 of file LoginSignupSpecialPage.php.

References getRequest(), and getUser().

◆ setRequest()

MediaWiki\SpecialPage\LoginSignupSpecialPage::setRequest	(	array	$data,
			$wasPosted = null )

protected

Override the POST data, GET data from the real request is preserved.

Used to preserve POST data over a HTTP redirect.

Stability: stable: to override

Parameters

array	$data
bool \| null	$wasPosted

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 109 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ setSessionUserForCurrentRequest()

MediaWiki\SpecialPage\LoginSignupSpecialPage::setSessionUserForCurrentRequest ( )

protected

Replace some globals to make sure the fact that the user has just been logged in is reflected in the current request.

Definition at line 511 of file LoginSignupSpecialPage.php.

References $wgLang, MediaWiki\SpecialPage\SpecialPage\getContext(), and MediaWiki\SpecialPage\SpecialPage\setContext().

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ showExtraInformation()

MediaWiki\SpecialPage\LoginSignupSpecialPage::showExtraInformation ( )

protected

Show extra information such as password recovery information, link from login to signup, CTA etc? Such information should only be shown on the "landing page", ie.

when the user is at the first step of the authentication process.

Returns: bool

Definition at line 821 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml().

◆ showReturnToPage()

MediaWiki\SpecialPage\LoginSignupSpecialPage::showReturnToPage	(	$type,
		$returnTo = '',
		$returnToQuery = '',
		$stickHTTPS = false )

Add a "return to" link or redirect to it.

Extensions can use this to reuse the "return to" logic after inject steps (such as redirection) into the login process.

Parameters

string	$type	One of the following: error: display a return to link ignoring $wgRedirectOnLogin signup: display a return to link using $wgRedirectOnLogin if needed success: display a return to link using $wgRedirectOnLogin if needed successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
string	$returnTo
array \| string	$returnToQuery
bool	$stickHTTPS	Keep redirect link on HTTPS

Since: 1.22

Definition at line 500 of file LoginSignupSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getContext().

◆ showSuccessPage()

MediaWiki\SpecialPage\LoginSignupSpecialPage::showSuccessPage	(	$type,
		$title,
		$msgname,
		$injected_html,
		$extraMessages )

protected

Show the success page.

Parameters

string	$type	Condition of return to; see `executeReturnTo`
string \| Message	$title	Page's title
string	$msgname
string	$injected_html
StatusValue \| null	$extraMessages

Definition at line 460 of file LoginSignupSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\SpecialPage\SpecialPage\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getUser(), wfDeprecated(), and wfEscapeWikiText().

Referenced by MediaWiki\Specials\SpecialCreateAccount\successfulAction(), and MediaWiki\Specials\SpecialUserLogin\successfulAction().

◆ successfulAction()

MediaWiki\SpecialPage\LoginSignupSpecialPage::successfulAction	(		$direct = false,
			$extraMessages = null )

abstractprotected

Parameters

bool	$direct	True if the action was successful just now; false if that happened pre-redirection (so this handler was called already)
StatusValue \| null	$extraMessages

Returns: void

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUserLogin.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

Member Data Documentation

◆ $authForm

HTMLForm null MediaWiki\SpecialPage\LoginSignupSpecialPage::$authForm

protected

Definition at line 90 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml().

◆ $mAction

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mAction

protected

Definition at line 64 of file LoginSignupSpecialPage.php.

◆ $mEntryError

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mEntryError = ''

protected

Definition at line 71 of file LoginSignupSpecialPage.php.

◆ $mEntryErrorType

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mEntryErrorType = 'error'

protected

Definition at line 72 of file LoginSignupSpecialPage.php.

◆ $mFromHTTP

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mFromHTTP

protected

Definition at line 70 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ $mLanguage

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mLanguage

protected

Definition at line 65 of file LoginSignupSpecialPage.php.

◆ $mLoaded

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mLoaded = false

protected

Definition at line 74 of file LoginSignupSpecialPage.php.

◆ $mLoadedRequest

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mLoadedRequest = false

protected

Definition at line 75 of file LoginSignupSpecialPage.php.

◆ $mPosted

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mPosted

protected

Definition at line 63 of file LoginSignupSpecialPage.php.

◆ $mReturnTo

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mReturnTo

protected

Definition at line 62 of file LoginSignupSpecialPage.php.

◆ $mReturnToQuery

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mReturnToQuery

protected

Definition at line 67 of file LoginSignupSpecialPage.php.

◆ $mSecureLoginUrl

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mSecureLoginUrl

protected

Definition at line 76 of file LoginSignupSpecialPage.php.

◆ $mStickHTTPS

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mStickHTTPS

protected

Definition at line 69 of file LoginSignupSpecialPage.php.

◆ $mToken

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mToken

protected

Definition at line 68 of file LoginSignupSpecialPage.php.

◆ $mVariant

MediaWiki\SpecialPage\LoginSignupSpecialPage::$mVariant

protected

Definition at line 66 of file LoginSignupSpecialPage.php.

◆ $proxyAccountCreation

bool MediaWiki\SpecialPage\LoginSignupSpecialPage::$proxyAccountCreation

protected

True if the user if creating an account for someone else.

Flag used for internal communication, only set at the very end.

Definition at line 85 of file LoginSignupSpecialPage.php.

◆ $securityLevel

string MediaWiki\SpecialPage\LoginSignupSpecialPage::$securityLevel

protected

Definition at line 80 of file LoginSignupSpecialPage.php.

Referenced by MediaWiki\SpecialPage\LoginSignupSpecialPage\load().

◆ $targetUser

User MediaWiki\SpecialPage\LoginSignupSpecialPage::$targetUser

protected

FIXME another flag for passing data.

Definition at line 87 of file LoginSignupSpecialPage.php.

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

includes/specialpage/LoginSignupSpecialPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ beforeExecute()

◆ execute()

◆ getAuthForm()

◆ getBenefitsContainerHtml()

◆ getFieldDefinitions()

◆ getGroupName()

◆ getNoticeHtml()

◆ getPageHtml()

◆ getPreservedParams()

◆ getReturnToQueryStringFragment()

◆ getTokenName()

◆ hasSessionCookie()

◆ isSignup()

◆ load()

◆ logAuthResult()

◆ mainLoginForm()

◆ makeLanguageSelector()

◆ makeLanguageSelectorLink()

◆ onAuthChangeFormFields()

◆ postProcessFormDescriptor()

◆ setRequest()

◆ setSessionUserForCurrentRequest()

◆ showExtraInformation()

◆ showReturnToPage()

◆ showSuccessPage()

◆ successfulAction()

Member Data Documentation

◆ $authForm

◆ $mAction

◆ $mEntryError

◆ $mEntryErrorType

◆ $mFromHTTP

◆ $mLanguage

◆ $mLoaded

◆ $mLoadedRequest

◆ $mPosted

◆ $mReturnTo

◆ $mReturnToQuery

◆ $mSecureLoginUrl

◆ $mStickHTTPS

◆ $mToken

◆ $mVariant

◆ $proxyAccountCreation

◆ $securityLevel

◆ $targetUser