Class for pages in NS_FILE. More...
Public Member Functions | |
| getName () | |
| Return the name of the action this object responds to. | |
| getRestriction () | |
| Get the permission required to perform this action. | |
| 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. | |
| checkCanExecute (User $user) | |
| Checks if the given user (identified by an object) can perform this action. | |
| getDescription () | |
| Returns the description that goes below the <h1> tag. | |
| getFormFields () | |
| Get an HTMLForm descriptor array. | |
| getPageTitle () | |
| Returns the name that goes in the <h1> page title. | |
Protected Attributes | |
| $oldFile | |
Detailed Description
Class for pages in NS_FILE.
Definition at line 49 of file RevertAction.php.
Member Function Documentation
| RevertFileAction::alterForm | ( | HTMLForm $ | form | ) | [protected] |
Play with the HTMLForm if you need to more substantially.
- Parameters:
-
$form HTMLForm
Reimplemented from FormAction.
Definition at line 77 of file RevertAction.php.
References HTMLForm\addHiddenField(), Action\getRequest(), HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegendMsg().
| RevertFileAction::checkCanExecute | ( | User $ | user | ) | [protected] |
Checks if the given user (identified by an object) can perform this action.
Can be overridden by sub-classes with more complicated permissions schemes. Failures here must throw subclasses of ErrorPageError
- Parameters:
-
$user User: the user to check, or null to use the context user
- Exceptions:
-
UserBlockedError|ReadOnlyError|PermissionsError
- Returns:
- bool True on success
Reimplemented from Action.
Definition at line 60 of file RevertAction.php.
References array(), Action\getRequest(), Action\getTitle(), and RepoGroup\singleton().
| RevertFileAction::getDescription | ( | ) | [protected] |
Returns the description that goes below the <h1> tag.
- Returns:
- String
Reimplemented from Action.
Definition at line 140 of file RevertAction.php.
References Action\getOutput(), and Action\getTitle().
| RevertFileAction::getFormFields | ( | ) | [protected] |
Get an HTMLForm descriptor array.
- Returns:
- Array
Reimplemented from FormAction.
Definition at line 83 of file RevertAction.php.
References $timestamp, $user, $wgContLang, array(), Action\getLanguage(), Action\getRequest(), Action\getTitle(), Action\getUser(), global, Action\msg(), page, and wfExpandUrl().
Return the name of the action this object responds to.
- Returns:
- String lowercase
Reimplemented from Action.
Definition at line 52 of file RevertAction.php.
| RevertFileAction::getPageTitle | ( | ) | [protected] |
Returns the name that goes in the <h1> page title.
- Returns:
- String
Reimplemented from Action.
Definition at line 136 of file RevertAction.php.
References Action\getTitle(), and Action\msg().
Get the permission required to perform this action.
Often, but not always, the same as the action name
- Returns:
- String|null
Reimplemented from Action.
Definition at line 56 of file RevertAction.php.
| RevertFileAction::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:
-
$data Array
- Returns:
- Bool|Array true for success, false for didn't-try, array of errors on failure
Reimplemented from FormAction.
Definition at line 114 of file RevertAction.php.
References $comment, $source, Action\getRequest(), Action\getUser(), and page.
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 FormAction.
Definition at line 121 of file RevertAction.php.
References $timestamp, $user, Action\getLanguage(), Action\getOutput(), Action\getRequest(), Action\getTitle(), Action\getUser(), page, and wfExpandUrl().
Member Data Documentation
RevertFileAction::$oldFile [protected] |
Definition at line 50 of file RevertAction.php.
The documentation for this class was generated from the following file:
- includes/actions/RevertAction.php
