Let users change their email address. More...
Public Member Functions | |
| __construct () | |
| execute ($par) | |
| Main execution point. | |
| isListed () | |
| onSubmit (array $data) | |
| Process the form on POST submission. | |
| onSuccess () | |
| Do something exciting on successful processing of the form, most likely to show a confirmation message. | |
| requiresUnblock () | |
| Whether this action cannot be executed by a blocked user. | |
Protected Member Functions | |
| alterForm (HTMLForm $form) | |
| Play with the HTMLForm if you need to more substantially. | |
| attemptChange (User $user, $pass, $newaddr) | |
| checkExecutePermissions (User $user) | |
| Called from execute() to check if the given user can perform this action. | |
| 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 | |
| Status | $status |
Detailed Description
Let users change their email address.
Definition at line 29 of file SpecialChangeEmail.php.
Constructor & Destructor Documentation
Definition at line 34 of file SpecialChangeEmail.php.
Member Function Documentation
| SpecialChangeEmail::alterForm | ( | HTMLForm $ | form | ) | [protected] |
Play with the HTMLForm if you need to more substantially.
- Parameters:
-
HTMLForm $form
Reimplemented from FormSpecialPage.
Definition at line 108 of file SpecialChangeEmail.php.
References HTMLForm\addHiddenField(), SpecialPage\getRequest(), HTMLForm\setDisplayFormat(), HTMLForm\setId(), HTMLForm\setSubmitTextMsg(), HTMLForm\setTableId(), and HTMLForm\setWrapperLegend().
| SpecialChangeEmail::attemptChange | ( | User $ | user, |
| $ | pass, | ||
| $ | newaddr | ||
| ) | [protected] |
- Parameters:
-
User $user string $pass string $newaddr
- Returns:
- Status
Definition at line 152 of file SpecialChangeEmail.php.
Referenced by onSubmit().
| SpecialChangeEmail::checkExecutePermissions | ( | User $ | user | ) | [protected] |
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 59 of file SpecialChangeEmail.php.
References SpecialPage\getUser(), global, and SpecialPage\requireLogin().
| SpecialChangeEmail::execute | ( | $ | par | ) |
Main execution point.
- Parameters:
-
string $par
Reimplemented from FormSpecialPage.
Definition at line 51 of file SpecialChangeEmail.php.
| SpecialChangeEmail::getFormFields | ( | ) | [protected] |
Get an HTMLForm descriptor array.
- Returns:
- array
Reimplemented from FormSpecialPage.
Definition at line 77 of file SpecialChangeEmail.php.
References $user, array(), SpecialPage\getConfig(), SpecialPage\getUser(), and SpecialPage\msg().
| SpecialChangeEmail::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 199 of file SpecialChangeEmail.php.
| SpecialChangeEmail::onSubmit | ( | array $ | data | ) |
Process the form on POST submission.
- Parameters:
-
array $data HTMLForm $form
- Returns:
- bool|string|array|Status As documented for HTMLForm::trySubmit.
Reimplemented from FormSpecialPage.
Definition at line 117 of file SpecialChangeEmail.php.
References $status, attemptChange(), SpecialPage\getRequest(), SpecialPage\getUser(), and Status\newGood().
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 130 of file SpecialChangeEmail.php.
References SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), Title\newFromText(), and Title\newMainPage().
Whether this action cannot be executed by a blocked user.
- Returns:
- bool
Reimplemented from FormSpecialPage.
Definition at line 195 of file SpecialChangeEmail.php.
Member Data Documentation
Status SpecialChangeEmail::$status [private] |
Definition at line 32 of file SpecialChangeEmail.php.
Referenced by onSubmit().
The documentation for this class was generated from the following file:
- includes/specials/SpecialChangeEmail.php
