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

Inheritance diagram for LoginSignupSpecialPage:

[legend]

Collaboration diagram for LoginSignupSpecialPage:

[legend]

Public Member Functions
	__construct ( $name)

	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.

	showReturnToPage ( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
	Add a "return to" link or redirect to it.

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

	handleFormSubmit ( $data)
	Submit handler callback for HTMLForm.

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.

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

	getConfig ()
	Shortcut to get main config object.

	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.

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

	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.

	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
	beforeExecute ( $subPage)
	Gets called before.

	getAuthForm (array $requests, $action, $msg='', $msgType='error')
	Generates a form from the given request.

	getFieldDefinitions ()
	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'.

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

	getAuthForm (array $requests, $action)

	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 ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	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 SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

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

	getRobotPolicy ()
	Return the robot policy.

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

	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.

Protected Attributes
HTMLForm	$authForm

	$mAction

	$mEntryError = ''

	$mEntryErrorType = 'error'

	$mFromHTTP

	$mLanguage

	$mLoaded = false

	$mLoadedRequest = false

	$mPosted

	$mReturnTo

	$mReturnToQuery

	$mSecureLoginUrl

	$mStickHTTPS

	$mToken

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 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 SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	canBypassForm (&$button_name)
	Determine if the login form can be bypassed.

	loadRequestParameters ()
	Load basic request parameters for this Special page.

	showCreateAccountLink ()
	Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides).

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 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	sortFormDescriptorFields (array &$formDescriptor)
	Sort the fields of a form descriptor by their 'weight' property.

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

Static Protected Attributes inherited from 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 37 of file LoginSignupSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

LoginSignupSpecialPage::__construct ( $name )

Definition at line 83 of file LoginSignupSpecialPage.php.

References $wgUseMediaWikiUIEverywhere.

Member Function Documentation

◆ beforeExecute()

LoginSignupSpecialPage::beforeExecute ( $subPage )

protected

Gets called before.

See also: SpecialPage::execute. Return false to prevent calling execute() (since 1.27+).

Since: 1.20

Parameters

string | null $subPage

Returns: bool|void

Reimplemented from AuthManagerSpecialPage.

Reimplemented in SpecialUserLogin.

Definition at line 203 of file LoginSignupSpecialPage.php.

References AuthManagerSpecialPage\$subPage, and loadRequestParameters().

◆ canBypassForm()

LoginSignupSpecialPage::canBypassForm ( & $button_name )

private

Determine if the login form can be bypassed.

This will be the case when no more than one button is present and no other user input fields that are not marked as 'skippable' are present. If the login form were not bypassed, the user would be presented with a superfluous page on which they must press the single button to proceed with login. Not only does this cause an additional mouse click and page load, it confuses users, especially since there are a help link and forgotten password link that are provided on the login page that do not apply to this situation.

Parameters

string | null &$button_name if the form has a single button, returns the name of the button; otherwise, returns null

Returns: bool

Definition at line 399 of file LoginSignupSpecialPage.php.

References AuthManagerSpecialPage\isContinued().

Referenced by execute().

◆ execute()

LoginSignupSpecialPage::execute ( $subPage )

Parameters

string | null $subPage PhanTypeObjectUnsetDeclaredProperty

Reimplemented from SpecialPage.

Definition at line 213 of file LoginSignupSpecialPage.php.

References $response, AuthManagerSpecialPage\$subPage, $title, $wgSecureLogin, canBypassForm(), SpecialPage\checkPermissions(), AuthManagerSpecialPage\getContinueAction(), AuthManagerSpecialPage\getDefaultAction(), SpecialPage\getFullTitle(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), getPreservedParams(), AuthManagerSpecialPage\getRequest(), AuthManagerSpecialPage\getToken(), getTokenName(), SpecialPage\getUser(), AuthManagerSpecialPage\isActionAllowed(), isSignup(), load(), AuthManagerSpecialPage\loadAuth(), logAuthResult(), mainLoginForm(), PROTO_HTTPS, SpecialPage\setHeaders(), setRequest(), setSessionUserForCurrentRequest(), successfulAction(), AuthManagerSpecialPage\trySubmit(), wfAppendQuery(), and wfCanIPUseHTTPS().

◆ getAuthForm()

LoginSignupSpecialPage::getAuthForm	(	array	$requests,
			$action,
			$msg = '',
			$msgType = 'error' )

protected

Generates a form from the given request.

Parameters

AuthenticationRequest[]	$requests
string	$action	AuthManager action name
string \| Message	$msg
string	$msgType

Returns: HTMLForm

Definition at line 649 of file LoginSignupSpecialPage.php.

References $authForm, $context, SpecialPage\getConfig(), SpecialPage\getContext(), SpecialPage\getPageTitle(), AuthManagerSpecialPage\getRequest(), getReturnToQueryStringFragment(), AuthManagerSpecialPage\getToken(), getTokenName(), isSignup(), and postProcessFormDescriptor().

Referenced by mainLoginForm().

◆ getFieldDefinitions()

LoginSignupSpecialPage::getFieldDefinitions ( )

protected

Create a HTMLForm descriptor for the core login fields.

Returns: array

Definition at line 758 of file LoginSignupSpecialPage.php.

References $wgEmailConfirmToEdit, SpecialPage\getLinkRenderer(), AuthManagerSpecialPage\getRequest(), getReturnToQueryStringFragment(), SpecialPage\getTitleFor(), SpecialPage\getUser(), AuthManagerSpecialPage\isContinued(), isSignup(), SpecialPage\msg(), showCreateAccountLink(), and showExtraInformation().

Referenced by onAuthChangeFormFields().

◆ getGroupName()

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Reimplemented in SpecialCreateAccount, and SpecialUserLogin.

Definition at line 1149 of file LoginSignupSpecialPage.php.

◆ getPageHtml()

LoginSignupSpecialPage::getPageHtml ( $formHtml )

protected

Add page elements which are outside the form.

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

Parameters

string $formHtml

Returns: string

Definition at line 585 of file LoginSignupSpecialPage.php.

References $wgLoginLanguageSelector, isSignup(), makeLanguageSelector(), SpecialPage\msg(), and showExtraInformation().

Referenced by mainLoginForm().

◆ getPreservedParams()

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.

Parameters

bool $withToken Include CSRF token

Returns: array

Reimplemented from AuthManagerSpecialPage.

Definition at line 189 of file LoginSignupSpecialPage.php.

References $wgSecureLogin, and isSignup().

Referenced by execute().

◆ getReturnToQueryStringFragment()

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 1060 of file LoginSignupSpecialPage.php.

References wfUrlencode().

Referenced by getAuthForm(), and getFieldDefinitions().

◆ getTokenName()

LoginSignupSpecialPage::getTokenName ( )

protected

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

Returns: string

Reimplemented from AuthManagerSpecialPage.

Reimplemented in SpecialCreateAccount, and SpecialUserLogin.

Definition at line 1089 of file LoginSignupSpecialPage.php.

References isSignup().

Referenced by execute(), getAuthForm(), and load().

◆ hasSessionCookie()

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 1046 of file LoginSignupSpecialPage.php.

References $wgDisableCookieCheck, $wgInitialSessionId, and AuthManagerSpecialPage\getRequest().

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

◆ isSignup()

LoginSignupSpecialPage::isSignup ( )

abstractprotected

Reimplemented in SpecialCreateAccount, and SpecialUserLogin.

Referenced by execute(), getAuthForm(), getFieldDefinitions(), getPageHtml(), getPreservedParams(), getTokenName(), mainLoginForm(), postProcessFormDescriptor(), and showCreateAccountLink().

◆ load()

LoginSignupSpecialPage::load ( $subPage )

protected

Load data from request.

Access:\n private

Parameters

string $subPage Subpage of Special:Userlogin

Definition at line 123 of file LoginSignupSpecialPage.php.

References $securityLevel, AuthManagerSpecialPage\$subPage, $wgSecureLogin, SpecialPage\getLinkRenderer(), SpecialPage\getPageTitle(), AuthManagerSpecialPage\getRequest(), getTokenName(), LoginHelper\getValidErrorMessages(), AuthManagerSpecialPage\loadAuth(), loadRequestParameters(), and SpecialPage\msg().

Referenced by execute().

◆ loadRequestParameters()

LoginSignupSpecialPage::loadRequestParameters ( )

private

Load basic request parameters for this Special page.

Definition at line 99 of file LoginSignupSpecialPage.php.

References SpecialPage\getConfig(), and AuthManagerSpecialPage\getRequest().

Referenced by beforeExecute(), and load().

◆ logAuthResult()

LoginSignupSpecialPage::logAuthResult	(		$success,
			$status = null )

abstractprotected

Logs to the authmanager-stats channel.

Parameters

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

Reimplemented in SpecialCreateAccount, and SpecialUserLogin.

Referenced by execute().

◆ mainLoginForm()

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
MWException
PermissionsError
ReadOnlyError

Access:\n private

Definition at line 514 of file LoginSignupSpecialPage.php.

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

Referenced by execute(), SpecialCreateAccount\successfulAction(), and SpecialUserLogin\successfulAction().

◆ makeLanguageSelector()

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 1099 of file LoginSignupSpecialPage.php.

References $lang, SpecialPage\getLanguage(), makeLanguageSelectorLink(), and SpecialPage\msg().

Referenced by getPageHtml().

◆ makeLanguageSelectorLink()

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 1126 of file LoginSignupSpecialPage.php.

References $lang, $mReturnTo, $mReturnToQuery, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), and SpecialPage\getPageTitle().

Referenced by makeLanguageSelector().

◆ onAuthChangeFormFields()

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

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)

Returns: bool

Reimplemented from AuthManagerSpecialPage.

Definition at line 701 of file LoginSignupSpecialPage.php.

References getFieldDefinitions().

◆ postProcessFormDescriptor()

LoginSignupSpecialPage::postProcessFormDescriptor	(	&	$formDescriptor,
			$requests )

protected

Parameters

array	&$formDescriptor
array	$requests

Definition at line 1157 of file LoginSignupSpecialPage.php.

References AuthManagerSpecialPage\addTabIndex(), AuthManagerSpecialPage\getRequest(), SpecialPage\getUser(), isSignup(), and AuthManagerSpecialPage\needsSubmitButton().

Referenced by getAuthForm().

◆ setRequest()

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.

Parameters

array	$data
bool \| null	$wasPosted

Reimplemented from AuthManagerSpecialPage.

Definition at line 91 of file LoginSignupSpecialPage.php.

Referenced by execute().

◆ setSessionUserForCurrentRequest()

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 482 of file LoginSignupSpecialPage.php.

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

Referenced by execute().

◆ showCreateAccountLink()

LoginSignupSpecialPage::showCreateAccountLink ( )

private

Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides).

Returns: bool

Definition at line 1076 of file LoginSignupSpecialPage.php.

References getPermissionManager(), SpecialPage\getUser(), and isSignup().

Referenced by getFieldDefinitions().

◆ showExtraInformation()

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 749 of file LoginSignupSpecialPage.php.

References $securityLevel, and AuthManagerSpecialPage\getContinueAction().

Referenced by getFieldDefinitions(), and getPageHtml().

◆ showReturnToPage()

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 471 of file LoginSignupSpecialPage.php.

References $type, and SpecialPage\getContext().

◆ showSuccessPage()

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 435 of file LoginSignupSpecialPage.php.

References $title, $type, SpecialPage\getContext(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getUser(), and wfEscapeWikiText().

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

◆ successfulAction()

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 SpecialCreateAccount, and SpecialUserLogin.

Referenced by execute().

Member Data Documentation

◆ $authForm

HTMLForm LoginSignupSpecialPage::$authForm

protected

Definition at line 64 of file LoginSignupSpecialPage.php.

Referenced by getAuthForm().

◆ $mAction

LoginSignupSpecialPage::$mAction

protected

Definition at line 40 of file LoginSignupSpecialPage.php.

◆ $mEntryError

LoginSignupSpecialPage::$mEntryError = ''

protected

Definition at line 46 of file LoginSignupSpecialPage.php.

◆ $mEntryErrorType

LoginSignupSpecialPage::$mEntryErrorType = 'error'

protected

Definition at line 47 of file LoginSignupSpecialPage.php.

◆ $mFromHTTP

LoginSignupSpecialPage::$mFromHTTP

protected

Definition at line 45 of file LoginSignupSpecialPage.php.

◆ $mLanguage

LoginSignupSpecialPage::$mLanguage

protected

Definition at line 41 of file LoginSignupSpecialPage.php.

◆ $mLoaded

LoginSignupSpecialPage::$mLoaded = false

protected

Definition at line 49 of file LoginSignupSpecialPage.php.

◆ $mLoadedRequest

LoginSignupSpecialPage::$mLoadedRequest = false

protected

Definition at line 50 of file LoginSignupSpecialPage.php.

◆ $mPosted

LoginSignupSpecialPage::$mPosted

protected

Definition at line 39 of file LoginSignupSpecialPage.php.

◆ $mReturnTo

LoginSignupSpecialPage::$mReturnTo

protected

Definition at line 38 of file LoginSignupSpecialPage.php.

Referenced by makeLanguageSelectorLink().

◆ $mReturnToQuery

LoginSignupSpecialPage::$mReturnToQuery

protected

Definition at line 42 of file LoginSignupSpecialPage.php.

Referenced by makeLanguageSelectorLink().

◆ $mSecureLoginUrl

LoginSignupSpecialPage::$mSecureLoginUrl

protected

Definition at line 51 of file LoginSignupSpecialPage.php.

◆ $mStickHTTPS

LoginSignupSpecialPage::$mStickHTTPS

protected

Definition at line 44 of file LoginSignupSpecialPage.php.

◆ $mToken

LoginSignupSpecialPage::$mToken

protected

Definition at line 43 of file LoginSignupSpecialPage.php.

◆ $proxyAccountCreation

bool 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 59 of file LoginSignupSpecialPage.php.

◆ $securityLevel

string LoginSignupSpecialPage::$securityLevel

protected

Definition at line 54 of file LoginSignupSpecialPage.php.

Referenced by load(), and showExtraInformation().

◆ $targetUser

User LoginSignupSpecialPage::$targetUser

protected

FIXME another flag for passing data.

Definition at line 61 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

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beforeExecute()

◆ canBypassForm()

◆ execute()

◆ getAuthForm()

◆ getFieldDefinitions()

◆ getGroupName()

◆ getPageHtml()

◆ getPreservedParams()

◆ getReturnToQueryStringFragment()

◆ getTokenName()

◆ hasSessionCookie()

◆ isSignup()

◆ load()

◆ loadRequestParameters()

◆ logAuthResult()

◆ mainLoginForm()

◆ makeLanguageSelector()

◆ makeLanguageSelectorLink()

◆ onAuthChangeFormFields()

◆ postProcessFormDescriptor()

◆ setRequest()

◆ setSessionUserForCurrentRequest()

◆ showCreateAccountLink()

◆ showExtraInformation()

◆ showReturnToPage()

◆ showSuccessPage()

◆ successfulAction()

Member Data Documentation

◆ $authForm

◆ $mAction

◆ $mEntryError

◆ $mEntryErrorType

◆ $mFromHTTP

◆ $mLanguage

◆ $mLoaded

◆ $mLoadedRequest

◆ $mPosted

◆ $mReturnTo

◆ $mReturnToQuery

◆ $mSecureLoginUrl

◆ $mStickHTTPS

◆ $mToken

◆ $proxyAccountCreation

◆ $securityLevel

◆ $targetUser