MediaWiki REL1_39
|
User interface for the rollback action. More...
Public Member Functions | |
__construct (Page $page, ?IContextSource $context, IContentHandlerFactory $contentHandlerFactory, RollbackPageFactory $rollbackPageFactory, UserOptionsLookup $userOptionsLookup, WatchlistManager $watchlistManager, CommentFormatter $commentFormatter) | |
doesWrites () | |
getName () | |
Return the name of the action this object responds to. | |
getRestriction () | |
Get the permission required to perform this action. | |
handleRollbackRequest () | |
onSubmit ( $data) | |
Process the form on POST submission. | |
onSuccess () | |
Do something exciting on successful processing of the form. | |
show () | |
Public Member Functions inherited from Action | |
__construct (Page $page, IContextSource $context=null) | |
Only public since 1.21. | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. | |
getArticle () | |
Get a Article object. | |
getAuthority () | |
Shortcut to get the Authority executing this instance. | |
getContext () | |
Get the IContextSource in use here. | |
getLanguage () | |
Shortcut to get the user Language being used for this instance. | |
getOutput () | |
Get the OutputPage being used for this instance. | |
getRequest () | |
Get the WebRequest being used for this instance. | |
getSkin () | |
Shortcut to get the Skin being used for this instance. | |
getTitle () | |
Shortcut to get the Title object from the page. | |
getUser () | |
Shortcut to get the User being used for this instance. | |
getWikiPage () | |
Get a WikiPage object. | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
needsReadRights () | |
Indicates whether this action requires read rights. | |
requiresUnblock () | |
Whether this action can still 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. | |
getDescription () | |
Returns the description that goes below the <h1> element. | |
getFormFields () | |
Get an HTMLForm descriptor array. | |
usesOOUI () | |
Whether the form should use OOUI. | |
Protected Member Functions inherited from FormAction | |
getForm () | |
Get the HTMLForm to control behavior. | |
postText () | |
preText () | |
Add pre- or post-text to the form. | |
Protected Member Functions inherited from Action | |
checkCanExecute (User $user) | |
Checks if the given user (identified by an object) can perform this action. | |
getHookContainer () | |
getHookRunner () | |
getPageTitle () | |
Returns the name that goes in the <h1> page title. | |
setHeaders () | |
Set output headers for noindexing etc. | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. | |
Additional Inherited Members | |
Static Public Member Functions inherited from Action | |
static | exists (string $name) |
Check if a given action is recognised, even if it's disabled. | |
static | factory (string $action, Article $article, IContextSource $context=null) |
Get an appropriate Action subclass for the given action. | |
static | getActionName (IContextSource $context) |
Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. | |
Protected Attributes inherited from Action | |
IContextSource null | $context |
IContextSource if specified; otherwise we'll use the Context from the Page. | |
array | $fields |
The fields used to create the HTMLForm. | |
WikiPage Article ImagePage CategoryPage Page | $page |
Page on which we're performing the action. | |
User interface for the rollback action.
Definition at line 38 of file RollbackAction.php.
RollbackAction::__construct | ( | Page | $page, |
?IContextSource | $context, | ||
IContentHandlerFactory | $contentHandlerFactory, | ||
RollbackPageFactory | $rollbackPageFactory, | ||
UserOptionsLookup | $userOptionsLookup, | ||
WatchlistManager | $watchlistManager, | ||
CommentFormatter | $commentFormatter ) |
Page | $page | |
IContextSource | null | $context | |
IContentHandlerFactory | $contentHandlerFactory | |
RollbackPageFactory | $rollbackPageFactory | |
UserOptionsLookup | $userOptionsLookup | |
WatchlistManager | $watchlistManager | |
CommentFormatter | $commentFormatter |
Definition at line 64 of file RollbackAction.php.
|
protected |
Play with the HTMLForm if you need to more substantially.
HTMLForm | $form |
Reimplemented from FormAction.
Definition at line 109 of file RollbackAction.php.
References HTMLForm\addHiddenField(), Action\getRequest(), HTMLForm\setSubmitTextMsg(), HTMLForm\setTokenSalt(), and HTMLForm\setWrapperLegendMsg().
RollbackAction::doesWrites | ( | ) |
Reimplemented from FormAction.
Definition at line 97 of file RollbackAction.php.
|
protected |
Returns the description that goes below the <h1>
element.
Reimplemented from Action.
Definition at line 93 of file RollbackAction.php.
|
protected |
Get an HTMLForm descriptor array.
Reimplemented from FormAction.
Definition at line 305 of file RollbackAction.php.
References Action\msg().
RollbackAction::getName | ( | ) |
Return the name of the action this object responds to.
Reimplemented from Action.
Definition at line 81 of file RollbackAction.php.
RollbackAction::getRestriction | ( | ) |
Get the permission required to perform this action.
Often, but not always, the same as the action name
Reimplemented from Action.
Definition at line 85 of file RollbackAction.php.
RollbackAction::handleRollbackRequest | ( | ) |
Definition at line 145 of file RollbackAction.php.
References getAuthority(), getContext(), Action\getOutput(), Action\getRequest(), getTitle(), getUser(), Action\getWikiPage(), Action\msg(), Message\rawParam(), Linker\revUserTools(), and wfEscapeWikiText().
Referenced by show().
RollbackAction::onSubmit | ( | $data | ) |
Process the form on POST submission.
If you don't want to do anything with the form, just return false here.
This method will be passed to the HTMLForm as a submit callback (see HTMLForm::setSubmitCallback) and must return as documented for HTMLForm::trySubmit.
array | $data |
Reimplemented from FormAction.
Definition at line 105 of file RollbackAction.php.
RollbackAction::onSuccess | ( | ) |
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 101 of file RollbackAction.php.
RollbackAction::show | ( | ) |
ErrorPageError | |
ReadOnlyError | |
ThrottledError |
Reimplemented from FormAction.
Definition at line 131 of file RollbackAction.php.
References Action\checkCanExecute(), getUser(), handleRollbackRequest(), and Action\setHeaders().
|
protected |
Whether the form should use OOUI.
Reimplemented from FormAction.
Definition at line 89 of file RollbackAction.php.