MediaWiki  REL1_19
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.
 preText ()
 Add pre- or post-text to the form.

Private Attributes

 $email
 $result

Detailed Description

Special page for requesting a password reset email.

Definition at line 29 of file SpecialPasswordReset.php.


Constructor & Destructor Documentation


Member Function Documentation

Play with the HTMLForm if you need to more substantially.

Parameters:
$formHTMLForm

Reimplemented from FormSpecialPage.

Definition at line 97 of file SpecialPasswordReset.php.

References HTMLForm\setSubmitText(), and wfMessage().

Here is the call graph for this function:

Definition at line 290 of file SpecialPasswordReset.php.

References $wgAuth, $wgPasswordResetRoutes, and User\isBlocked().

Referenced by checkExecutePermissions(), isListed(), and userCanExecute().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Failures here must throw subclasses of ErrorPageError.

Parameters:
$userUser
Returns:
Bool true
Exceptions:
ErrorPageError

Reimplemented from FormSpecialPage.

Definition at line 49 of file SpecialPasswordReset.php.

References canChangePassword().

Here is the call graph for this function:

Get an HTMLForm descriptor array.

Returns:
Array

Reimplemented from FormSpecialPage.

Definition at line 60 of file SpecialPasswordReset.php.

References $wgAuth, $wgPasswordResetRoutes, and SpecialPage\getUser().

Here is the call graph for this function:

Hide the password reset page if resets are disabled.

Returns:
Bool

Reimplemented from SpecialPage.

Definition at line 318 of file SpecialPasswordReset.php.

References canChangePassword(), and SpecialPage\getUser().

Here is the call graph for this function:

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:
$dataarray
Returns:
Bool|Array

Reimplemented from FormSpecialPage.

Definition at line 123 of file SpecialPasswordReset.php.

References $res, $title, $user, $wgAuth, $wgNewPasswordExpiry, $wgPasswordReminderResendTime, SpecialPage\getRequest(), SpecialPage\getUser(), IP\isValid(), User\newFromName(), User\newFromRow(), Title\newMainPage(), Sanitizer\validateEmail(), wfEscapeWikiText(), wfGetDB(), wfMessage(), and wfRunHooks().

Here is the call graph for this function:

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

Reimplemented from FormSpecialPage.

Definition at line 273 of file SpecialPasswordReset.php.

References SpecialPage\getOutput(), SpecialPage\getUser(), and Html\rawElement().

Here is the call graph for this function:

Add pre- or post-text to the form.

Returns:
String HTML which will be sent to $form->addPreText()

Reimplemented from FormSpecialPage.

Definition at line 101 of file SpecialPasswordReset.php.

References $wgPasswordResetRoutes, and wfMessage().

Here is the call graph for this function:

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:
$userUser: the user to check
Returns:
Boolean: does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 45 of file SpecialPasswordReset.php.

References canChangePassword().

Here is the call graph for this function:


Member Data Documentation

SpecialPasswordReset::$email [private]

Definition at line 34 of file SpecialPasswordReset.php.

SpecialPasswordReset::$result [private]

Definition at line 39 of file SpecialPasswordReset.php.


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