LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount, but some extensions called its public methods directly, so the class is retained as a B/C wrapper. More...

Inheritance diagram for LoginForm:

[legend]

Collaboration diagram for LoginForm:

[legend]

Public Member Functions
	__construct ( $request=null)

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.

	execute ( $subPage)
	Default execute method Checks user permissions.

	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.

	getRequest ()
	Get the WebRequest being used for this instance.

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

	getSkin ()
	Shortcut to get the skin being used for this instance.

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

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

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

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

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key)
	Wrapper around wfMessage that sets the current context.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Static Public Member Functions
static	clearCreateaccountToken ()

static	clearLoginThrottle ( $username)

static	clearLoginToken ()

static	getCreateaccountToken ()

static	getLoginToken ()

static	getValidErrorMessages ()

static	incLoginThrottle ( $username)

static	incrementLoginThrottle ( $username)

static	setCreateaccountToken ()

static	setLoginToken ()

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.

Public Attributes
const	ABORTED = 8

const	CREATE_BLOCKED = 9

const	EMPTY_PASS = 6

const	ILLEGAL = 2

const	NEED_TOKEN = 12

const	NO_NAME = 1

const	NOT_EXISTS = 4

const	RESET_PASS = 7

const	SUCCESS = 0

const	THROTTLED = 10

const	USER_BLOCKED = 11

const	USER_MIGRATED = 14

const	WRONG_PASS = 5

const	WRONG_PLUGIN_PASS = 3

const	WRONG_TOKEN = 13

Static Public Attributes
static	$statusCodes

Additional Inherited Members
Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	getCacheTTL ()

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

	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.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount, but some extensions called its public methods directly, so the class is retained as a B/C wrapper.

Anything that used it before should use AuthManager instead.

Definition at line 1460 of file LoginSignupSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

LoginForm::__construct ( $request = null )

Parameters

WebRequest $request

Definition at line 1498 of file LoginSignupSpecialPage.php.

References wfDeprecated().

Member Function Documentation

◆ clearCreateaccountToken()

static LoginForm::clearCreateaccountToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Definition at line 1593 of file LoginSignupSpecialPage.php.

References $wgRequest, and wfDeprecated().

◆ clearLoginThrottle()

static LoginForm::clearLoginThrottle ( $username )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Parameters

string $username

Returns: void

Definition at line 1540 of file LoginSignupSpecialPage.php.

References $username, $wgRequest, User\getCanonicalName(), and wfDeprecated().

◆ clearLoginToken()

static LoginForm::clearLoginToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Definition at line 1567 of file LoginSignupSpecialPage.php.

References $wgRequest, and wfDeprecated().

◆ getCreateaccountToken()

static LoginForm::getCreateaccountToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Returns: string

Definition at line 1577 of file LoginSignupSpecialPage.php.

References $wgRequest, and wfDeprecated().

◆ getLoginToken()

static LoginForm::getLoginToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Definition at line 1551 of file LoginSignupSpecialPage.php.

References $wgRequest, and wfDeprecated().

◆ getValidErrorMessages()

static LoginForm::getValidErrorMessages ( )

static

Deprecated: since 1.27 - call LoginHelper::getValidErrorMessages instead.

Returns: array

Definition at line 1507 of file LoginSignupSpecialPage.php.

References LoginHelper\getValidErrorMessages().

◆ incLoginThrottle()

static LoginForm::incLoginThrottle ( $username )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Parameters

string $username

Returns: bool|int

Definition at line 1529 of file LoginSignupSpecialPage.php.

References $res, $username, true, and wfDeprecated().

◆ incrementLoginThrottle()

static LoginForm::incrementLoginThrottle ( $username )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Parameters

string $username

Returns: array|false

Definition at line 1516 of file LoginSignupSpecialPage.php.

References $username, $wgRequest, User\getCanonicalName(), and wfDeprecated().

◆ setCreateaccountToken()

static LoginForm::setCreateaccountToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Definition at line 1586 of file LoginSignupSpecialPage.php.

References wfDeprecated().

◆ setLoginToken()

static LoginForm::setLoginToken ( )

static

Deprecated: since 1.27 - don't use LoginForm, use AuthManager instead

Definition at line 1560 of file LoginSignupSpecialPage.php.

References wfDeprecated().

Member Data Documentation

◆ $statusCodes

LoginForm::$statusCodes

static

Initial value:

= [
        self::SUCCESS => 'success',
        self::NO_NAME => 'no_name',
        self::ILLEGAL => 'illegal',
        self::WRONG_PLUGIN_PASS => 'wrong_plugin_pass',
        self::NOT_EXISTS => 'not_exists',
        self::WRONG_PASS => 'wrong_pass',
        self::EMPTY_PASS => 'empty_pass',
        self::RESET_PASS => 'reset_pass',
        self::ABORTED => 'aborted',
        self::CREATE_BLOCKED => 'create_blocked',
        self::THROTTLED => 'throttled',
        self::USER_BLOCKED => 'user_blocked',
        self::NEED_TOKEN => 'need_token',
        self::WRONG_TOKEN => 'wrong_token',
        self::USER_MIGRATED => 'user_migrated',
    ]