Special page for requesting a password reset email. More...
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 | |
| Message | |
| Status | $result |
Detailed Description
Special page for requesting a password reset email.
Definition at line 29 of file SpecialPasswordReset.php.
Constructor & Destructor Documentation
Definition at line 39 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 98 of file SpecialPasswordReset.php.
| SpecialPasswordReset::canChangePassword | ( | User $ | user | ) | [protected] |
Definition at line 290 of file SpecialPasswordReset.php.
Called from execute() to check if the given user can perform this action.
Failures here must throw subclasses of ErrorPageError.
- Parameters:
-
$user User
- Returns:
- Bool true
- Exceptions:
-
ErrorPageError
Reimplemented from FormSpecialPage.
Definition at line 47 of file SpecialPasswordReset.php.
| SpecialPasswordReset::getFormFields | ( | ) | [protected] |
Get an HTMLForm descriptor array.
- Returns:
- Array
Reimplemented from FormSpecialPage.
Definition at line 58 of file SpecialPasswordReset.php.
Hide the password reset page if resets are disabled.
- Returns:
- Bool
Reimplemented from SpecialPage.
Definition at line 318 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
- Returns:
- Bool|Array
Reimplemented from FormSpecialPage.
Definition at line 124 of file SpecialPasswordReset.php.
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.
| SpecialPasswordReset::preText | ( | ) | [protected] |
Add pre- or post-text to the form.
- Returns:
- String HTML which will be sent to $form->addPreText()
Reimplemented from FormSpecialPage.
Definition at line 102 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 43 of file SpecialPasswordReset.php.
Member Data Documentation
Message SpecialPasswordReset::$email [private] |
Definition at line 33 of file SpecialPasswordReset.php.
Status SpecialPasswordReset::$result [private] |
Definition at line 37 of file SpecialPasswordReset.php.
The documentation for this class was generated from the following file:
- includes/specials/SpecialPasswordReset.php
