Page removal from a user's watchlist. More...
Public Member Functions | |
| getName () | |
| Return the name of the action this object responds to. | |
| onSubmit ($data) | |
| Process the form on POST submission. | |
| onSuccess () | |
| Do something exciting on successful processing of the form. | |
Protected Member Functions | |
| alterForm (HTMLForm $form) | |
| Play with the HTMLForm if you need to more substantially. | |
| getDescription () | |
| Returns the description that goes below the <h1> tag. | |
| preText () | |
| Add pre- or post-text to the form. | |
Detailed Description
Page removal from a user's watchlist.
Definition at line 28 of file UnwatchAction.php.
Member Function Documentation
| UnwatchAction::alterForm | ( | HTMLForm $ | form | ) | [protected] |
Play with the HTMLForm if you need to more substantially.
- Parameters:
-
HTMLForm $form
Reimplemented from WatchAction.
Definition at line 46 of file UnwatchAction.php.
References HTMLForm\setSubmitTextMsg().
| UnwatchAction::getDescription | ( | ) | [protected] |
Returns the description that goes below the <h1> tag.
- Since:
- 1.17
- Returns:
- string
Reimplemented from WatchAction.
Definition at line 34 of file UnwatchAction.php.
References Action\msg().
Return the name of the action this object responds to.
- Since:
- 1.17
- Returns:
- string Lowercase name
Reimplemented from WatchAction.
Definition at line 30 of file UnwatchAction.php.
| UnwatchAction::onSubmit | ( | $ | data | ) |
Process the form on POST submission.
If you return false from getFormFields(), this will obviously never be reached. If you don't want to do anything with the form, just return false here
- Parameters:
-
array $data
- Returns:
- bool|array True for success, false for didn't-try, array of errors on failure
Reimplemented from WatchAction.
Definition at line 38 of file UnwatchAction.php.
References WatchAction\doUnwatch(), Action\getTitle(), Action\getUser(), wfProfileIn(), and wfProfileOut().
Do something exciting on successful processing of the form.
This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).
Reimplemented from WatchAction.
Definition at line 54 of file UnwatchAction.php.
References Action\getOutput(), and Action\getTitle().
| UnwatchAction::preText | ( | ) | [protected] |
Add pre- or post-text to the form.
- Returns:
- string HTML which will be sent to $form->addPreText()
Reimplemented from WatchAction.
Definition at line 50 of file UnwatchAction.php.
References Action\msg().
The documentation for this class was generated from the following file:
- includes/actions/UnwatchAction.php
