SpecialPasswordReset Class Reference

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

Inheritance diagram for SpecialPasswordReset:

Collaboration diagram for SpecialPasswordReset:

List of all members.

Public Member Functions
	__construct ()
	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.
	isListed ()
	Hide the password reset page if resets are disabled.
	onSubmit (array $data)
	Process the form.
	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.
	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
Protected Member Functions
	canChangePassword (User $user)
	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'.
Private Attributes
Message	$email
User	$firstUser
Status	$result

---

Detailed Description

Special page for requesting a password reset email.

Definition at line 29 of file SpecialPasswordReset.php.

---

Constructor & Destructor Documentation

SpecialPasswordReset::__construct

(

)

Definition at line 42 of file SpecialPasswordReset.php.

---

Member Function Documentation

SpecialPasswordReset::alterForm

(

HTMLForm $

form

)

Play with the HTMLForm if you need to more substantially.

Parameters:

$form

HTMLForm

Reimplemented from FormSpecialPage.

Definition at line 102 of file SpecialPasswordReset.php.

SpecialPasswordReset::canChangePassword

(

User $

user

)

[protected]

Definition at line 317 of file SpecialPasswordReset.php.

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

Returns:

Bool true

Reimplemented from FormSpecialPage.

Definition at line 50 of file SpecialPasswordReset.php.

SpecialPasswordReset::getFormFields

(

)

[protected]

Get an HTMLForm descriptor array.

Returns:

Array

Reimplemented from FormSpecialPage.

Definition at line 61 of file SpecialPasswordReset.php.

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

Returns:

string

Since:

1.21

Reimplemented from SpecialPage.

Definition at line 358 of file SpecialPasswordReset.php.

SpecialPasswordReset::isListed

(

)

Hide the password reset page if resets are disabled.

Returns:

Bool

Reimplemented from SpecialPage.

Definition at line 350 of file SpecialPasswordReset.php.

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:

$data

array

Exceptions:

MWException
ThrottledError|PermissionsError

Returns:

Bool|Array

Reimplemented from FormSpecialPage.

Definition at line 138 of file SpecialPasswordReset.php.

SpecialPasswordReset::onSuccess

(

)

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since:

1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 299 of file SpecialPasswordReset.php.

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.

Parameters:

$user

User: the user to check

Returns:

Boolean: does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 46 of file SpecialPasswordReset.php.

---

Member Data Documentation

Message SpecialPasswordReset::$email [private]

Definition at line 32 of file SpecialPasswordReset.php.

User SpecialPasswordReset::$firstUser [private]

Definition at line 36 of file SpecialPasswordReset.php.

Status SpecialPasswordReset::$result [private]

Definition at line 40 of file SpecialPasswordReset.php.

---

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

• includes/specials/SpecialPasswordReset.php