Special page which uses an HTMLForm to handle processing. More...
Public Member Functions | |
| execute ($par) | |
| Basic SpecialPage workflow: get a form, send it to the user; get some data back,. | |
| 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. | |
| requiresWrite () | |
| Whether this action requires the wiki not to be locked. | |
Protected Member Functions | |
| 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. | |
| getForm () | |
| Get the HTMLForm to control behavior. | |
| getFormFields () | |
| Get an HTMLForm descriptor array. | |
| getMessagePrefix () | |
| Get message prefix for HTMLForm. | |
| postText () | |
| preText () | |
| Add pre- or post-text to the form. | |
| setParameter ($par) | |
| Maybe do something interesting with the subpage parameter. | |
Detailed Description
Special page which uses an HTMLForm to handle processing.
This is mostly a clone of FormAction. More special pages should be built this way; maybe this could be a new structure for SpecialPages
Definition at line 910 of file SpecialPage.php.
Member Function Documentation
| FormSpecialPage::alterForm | ( | HTMLForm $ | form | ) | [protected] |
Play with the HTMLForm if you need to more substantially.
- Parameters:
-
$form HTMLForm
Reimplemented in SpecialBlock, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.
Definition at line 929 of file SpecialPage.php.
| FormSpecialPage::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 in SpecialBlock, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.
Definition at line 1013 of file SpecialPage.php.
| FormSpecialPage::execute | ( | $ | par | ) |
Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
- Parameters:
-
string $par Subpage string if one was specified
Reimplemented from SpecialPage.
Definition at line 987 of file SpecialPage.php.
| FormSpecialPage::getForm | ( | ) | [protected] |
Get the HTMLForm to control behavior.
- Returns:
- HTMLForm|null
Definition at line 945 of file SpecialPage.php.
| FormSpecialPage::getFormFields | ( | ) | [abstract, protected] |
Get an HTMLForm descriptor array.
- Returns:
- Array
Reimplemented in SpecialBlock, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.
| FormSpecialPage::getMessagePrefix | ( | ) | [protected] |
Get message prefix for HTMLForm.
- Since:
- 1.21
- Returns:
- string
Definition at line 937 of file SpecialPage.php.
| FormSpecialPage::onSubmit | ( | array $ | data | ) | [abstract] |
Process the form on POST submission.
- Parameters:
-
$data Array
- Returns:
- Bool|Array true for success, false for didn't-try, array of errors on failure
Reimplemented in SpecialBlock, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.
| FormSpecialPage::onSuccess | ( | ) | [abstract] |
Do something exciting on successful processing of the form, most likely to show a confirmation message.
Reimplemented in SpecialBlock, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.
| FormSpecialPage::postText | ( | ) | [protected] |
Reimplemented in SpecialBlock.
Definition at line 923 of file SpecialPage.php.
| FormSpecialPage::preText | ( | ) | [protected] |
Add pre- or post-text to the form.
- Returns:
- String HTML which will be sent to $form->addPreText()
Reimplemented in SpecialBlock, and SpecialPasswordReset.
Definition at line 922 of file SpecialPage.php.
Whether this action cannot be executed by a blocked user.
- Returns:
- Bool
Definition at line 1040 of file SpecialPage.php.
Whether this action requires the wiki not to be locked.
- Returns:
- Bool
Reimplemented in SpecialLockdb, and SpecialUnlockdb.
Definition at line 1032 of file SpecialPage.php.
| FormSpecialPage::setParameter | ( | $ | par | ) | [protected] |
Maybe do something interesting with the subpage parameter.
- Parameters:
-
$par String
Reimplemented in SpecialBlock.
Definition at line 1004 of file SpecialPage.php.
The documentation for this class was generated from the following file:
- includes/SpecialPage.php
