Special page for requesting a password reset email. More...

Inheritance diagram for SpecialPasswordReset:

[legend]

Collaboration diagram for SpecialPasswordReset:

[legend]

Public Member Functions
	__construct (PasswordReset $passwordReset)

	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

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

	execute ( $par)

	isListed ()
	Hide the password reset page if resets are disabled.

	onSubmit (array $data)
	Process the form.

	onSuccess ()
	Show a message on the successful processing of the form.

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

Public Member Functions inherited from FormSpecialPage
	requiresUnblock ()
	Whether this action cannot be executed by a blocked user.

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

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.

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

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

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

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

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

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

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

	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.

	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.

	setContentLanguage (Language $contentLanguage)
	Set content language.

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

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

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

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

Protected Member Functions
	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

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

Protected Member Functions inherited from FormSpecialPage
	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

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

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

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

	getLanguageConverter ()
	Shortcut to get language's converter.

	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.

	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!

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Private Attributes
string	$method
	Identifies which password reset field was specified by the user.

PasswordReset	$passwordReset

Status	$result

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 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 FormSpecialPage
string null	$par = null
	The sub-page of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from 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 for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Detailed Description

Special page for requesting a password reset email.

Requires the TemporaryPasswordPrimaryAuthenticationProvider and the EmailNotificationSecondaryAuthenticationProvider (or something providing equivalent functionality) to be enabled.

Definition at line 33 of file SpecialPasswordReset.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPasswordReset::__construct ( PasswordReset $passwordReset )

Parameters

PasswordReset $passwordReset

Definition at line 50 of file SpecialPasswordReset.php.

References $passwordReset.

Member Function Documentation

◆ alterForm()

SpecialPasswordReset::alterForm ( HTMLForm $form )

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 111 of file SpecialPasswordReset.php.

References HTMLForm\addHiddenFields(), SpecialPage\getConfig(), SpecialPage\getRequest(), SpecialPage\msg(), HTMLForm\setHeaderText(), HTMLForm\setSubmitDestructive(), and HTMLForm\setSubmitTextMsg().

◆ checkExecutePermissions()

SpecialPasswordReset::checkExecutePermissions ( User $user )

Called from execute() to check if the given user can perform this action.

Failures here must throw subclasses of ErrorPageError.

Parameters

User $user

Exceptions

UserBlockedError

Reimplemented from FormSpecialPage.

Definition at line 64 of file SpecialPasswordReset.php.

◆ doesWrites()

SpecialPasswordReset::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 56 of file SpecialPasswordReset.php.

◆ execute()

SpecialPasswordReset::execute ( $par )

Parameters

string | null $par

Reimplemented from FormSpecialPage.

Definition at line 76 of file SpecialPasswordReset.php.

References FormSpecialPage\$par, and SpecialPage\getOutput().

◆ getDisplayFormat()

SpecialPasswordReset::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 107 of file SpecialPasswordReset.php.

◆ getFormFields()

SpecialPasswordReset::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 82 of file SpecialPasswordReset.php.

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

◆ getGroupName()

SpecialPasswordReset::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 SpecialPage.

Definition at line 197 of file SpecialPasswordReset.php.

◆ isListed()

SpecialPasswordReset::isListed ( )

Hide the password reset page if resets are disabled.

Returns: bool

Reimplemented from SpecialPage.

Definition at line 189 of file SpecialPasswordReset.php.

◆ onSubmit()

SpecialPasswordReset::onSubmit ( array $data )

Process the form.

At this point we know that the user passes all the criteria in userCanExecute(), and if the data array contains 'Username', etc, then Username resets are allowed.

Parameters

array $data

Exceptions

MWException
ThrottledError\|PermissionsError

Returns: Status

Reimplemented from FormSpecialPage.

Definition at line 141 of file SpecialPasswordReset.php.

References $result.

◆ onSuccess()

SpecialPasswordReset::onSuccess ( )

Show a message on the successful processing of the form.

This doesn't necessarily mean a reset email was sent.

Reimplemented from FormSpecialPage.

Definition at line 160 of file SpecialPasswordReset.php.

References SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\msg(), and wfEscapeWikiText().

◆ userCanExecute()

SpecialPasswordReset::userCanExecute ( User $user )

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

Can be overridden by sub- classes with more complicated permissions schemes.

Stability: stable: to override

Parameters

User $user The user to check

Returns: bool Does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 60 of file SpecialPasswordReset.php.

Member Data Documentation

◆ $method

string SpecialPasswordReset::$method

private

Identifies which password reset field was specified by the user.

Definition at line 45 of file SpecialPasswordReset.php.

◆ $passwordReset

PasswordReset SpecialPasswordReset::$passwordReset

private

Definition at line 35 of file SpecialPasswordReset.php.

Referenced by __construct().

◆ $result

Status SpecialPasswordReset::$result

private

Definition at line 40 of file SpecialPasswordReset.php.

Referenced by onSubmit().

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

includes/specials/SpecialPasswordReset.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

◆ doesWrites()

◆ execute()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ isListed()

◆ onSubmit()

◆ onSuccess()

◆ userCanExecute()

Member Data Documentation

◆ $method

◆ $passwordReset

◆ $result