Implements Special:CreateAccount. More...

Inherits MediaWiki\SpecialPage\LoginSignupSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialCreateAccount:

[legend]

Public Member Functions

__construct (AuthManager $authManager, FormatterFactory $formatterFactory)

checkPermissions ()

Checks if userCanExecute, and if not throws a PermissionsError.

doesWrites ()

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

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.

Public Member Functions inherited from MediaWiki\SpecialPage\LoginSignupSpecialPage

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)

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.

checkReadOnly ()

If the wiki is currently in readonly mode, throws a ReadOnlyError.

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.

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

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

clearToken ()

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

getLoginSecurityLevel ()

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

isSignup ()

logAuthResult ( $success, $status=null)

Logs to the authmanager-stats channel.

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

Run any hooks registered for logins, then display a message welcoming the user.

Protected Member Functions inherited from MediaWiki\SpecialPage\LoginSignupSpecialPage

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

Create a HTMLForm descriptor for the core login fields.

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 ( $options=[])

Returns URL query parameters which should be preserved between authentication requests.These should be used when generating links such as form submit or language switch.These parameters will be preserved in:

successive authentication steps (the form submit URL and the return URL for redirecting providers);
links that reload the same form somehow (e.g. language switcher links);
links for switching between the login and create account forms.

Stability: stable: to override

Parameters

array

$options

(since 1.43)

reset (bool, default false): Reset the authentication process, i.e. omit parameters which are related to continuing in-progress authentication.
withToken (bool, default false): Include CSRF token Before 1.43, this was a boolean flag identical to the current 'withToken' option. That usage is deprecated.

Returns: array Array of parameter name => parameter value.

hasSessionCookie ()

Check if a session cookie is present.

load ( $subPage)

Load data from request.

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.

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.

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.

getRequestBlacklist ()

Allows blacklisting certain request types.

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 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	$messages

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

string	$mAction

string	$mDisplay = 'page'

string	$mEntryError = ''

string	$mEntryErrorType = 'error'

bool	$mFromHTTP

bool	$mLoaded = false

bool	$mLoadedRequest = false

bool	$mPosted

string string	$mReturnTo
	The title of the page to return to after authentication finishes, or the empty string when there is no return target.

string string	$mReturnToAnchor
	The fragment part of the URL to return to after authentication finishes.

string string	$mReturnToQuery
	The query string part of the URL to return to after authentication finishes.

string null	$mSecureLoginUrl

bool	$mStickHTTPS

string	$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 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

Implements Special:CreateAccount.

Definition at line 37 of file SpecialCreateAccount.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialCreateAccount::__construct	(	AuthManager	$authManager,
		FormatterFactory	$formatterFactory )

Parameters

AuthManager	$authManager
FormatterFactory	$formatterFactory

Definition at line 57 of file SpecialCreateAccount.php.

References MediaWiki\SpecialPage\SpecialPage\setAuthManager().

Member Function Documentation

◆ checkPermissions()

MediaWiki\Specials\SpecialCreateAccount::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Stability: stable: to override

Since: 1.19

Returns: void

Exceptions

PermissionsError

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 68 of file SpecialCreateAccount.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthManager(), MediaWiki\SpecialPage\SpecialPage\getAuthority(), and MediaWiki\SpecialPage\SpecialPage\getContext().

◆ clearToken()

MediaWiki\Specials\SpecialCreateAccount::clearToken ( )

protected

Definition at line 174 of file SpecialCreateAccount.php.

References MediaWiki\SpecialPage\AuthManagerSpecialPage\getRequest().

Referenced by MediaWiki\Specials\SpecialCreateAccount\successfulAction().

◆ doesWrites()

MediaWiki\Specials\SpecialCreateAccount::doesWrites ( )

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

Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 64 of file SpecialCreateAccount.php.

◆ getDefaultAction()

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

◆ getDescription()

MediaWiki\Specials\SpecialCreateAccount::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.

Derived classes can override this, but usually it is easier to keep the default behavior.

Returning a string from this method has been deprecated since 1.41.

Stability: stable: to override

Returns: string|Message

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 95 of file SpecialCreateAccount.php.

References MediaWiki\SpecialPage\SpecialPage\msg().

◆ getGroupName()

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

Definition at line 182 of file SpecialCreateAccount.php.

◆ getLoginSecurityLevel()

MediaWiki\Specials\SpecialCreateAccount::getLoginSecurityLevel ( )

protected

Stability: stable: to override

Returns: bool|string

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 87 of file SpecialCreateAccount.php.

◆ getToken()

MediaWiki\Specials\SpecialCreateAccount::getToken ( )

protected

Returns the CSRF token.

Stability: stable: to override

Returns: Token

Reimplemented from MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 170 of file SpecialCreateAccount.php.

References MediaWiki\SpecialPage\AuthManagerSpecialPage\getRequest().

◆ getTokenName()

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

Definition at line 178 of file SpecialCreateAccount.php.

◆ isSignup()

MediaWiki\Specials\SpecialCreateAccount::isSignup ( )

protected

Reimplemented from MediaWiki\SpecialPage\LoginSignupSpecialPage.

Definition at line 99 of file SpecialCreateAccount.php.

◆ logAuthResult()

MediaWiki\Specials\SpecialCreateAccount::logAuthResult	(		$success,
			$status = null )

protected

Logs to the authmanager-stats channel.

Parameters

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

Reimplemented from MediaWiki\SpecialPage\LoginSignupSpecialPage.

Definition at line 186 of file SpecialCreateAccount.php.

References $success.

◆ successfulAction()

MediaWiki\Specials\SpecialCreateAccount::successfulAction	(		$direct = false,
			$extraMessages = null )

protected

Run any hooks registered for logins, then display a message welcoming the user.

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

Reimplemented from MediaWiki\SpecialPage\LoginSignupSpecialPage.

Definition at line 110 of file SpecialCreateAccount.php.

Member Data Documentation

◆ $allowedActions

MediaWiki\Specials\SpecialCreateAccount::$allowedActions

staticprotected

Initial value:

= [
        AuthManager::ACTION_CREATE,
        AuthManager::ACTION_CREATE_CONTINUE
    ]

Definition at line 39 of file SpecialCreateAccount.php.

◆ $messages

MediaWiki\Specials\SpecialCreateAccount::$messages

staticprotected

Initial value:

= [
        'authform-newtoken' => 'nocookiesfornew',
        'authform-notoken' => 'sessionfailure',
        'authform-wrongtoken' => 'sessionfailure',
    ]

Definition at line 45 of file SpecialCreateAccount.php.

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

includes/specials/SpecialCreateAccount.php

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkPermissions()

◆ clearToken()

◆ doesWrites()

◆ getDefaultAction()

◆ getDescription()

◆ getGroupName()

◆ getLoginSecurityLevel()

◆ getToken()

◆ getTokenName()

◆ isSignup()

◆ logAuthResult()

◆ successfulAction()

Member Data Documentation

◆ $allowedActions

◆ $messages