MediaWiki master
|
Temporary action for MCR undos. More...
Inherits FormAction.
Inherited by McrRestoreAction.
Public Member Functions | |
__construct (Article $article, IContextSource $context, ReadOnlyMode $readOnlyMode, RevisionLookup $revisionLookup, RevisionRenderer $revisionRenderer, CommentFormatter $commentFormatter, Config $config) | |
getDescription () | |
Returns the description that goes below the <h1> element. | |
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. | |
show () | |
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere. | |
Public Member Functions inherited from FormAction | |
doesWrites () | |
Public Member Functions inherited from Action | |
__construct (Article $article, IContextSource $context) | |
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 () | |
Indicates whether this action page write access to the wiki. | |
setHookContainer (HookContainer $hookContainer) | |
Protected Member Functions | |
addStatePropagationFields (HTMLForm $form) | |
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. | |
getFormFields () | |
Get an HTMLForm descriptor array. | |
initFromParameters () | |
preText () | |
Add pre- or post-text to the form. | |
usesOOUI () | |
Whether the form should use OOUI. | |
Protected Member Functions inherited from FormAction | |
getForm () | |
Get the HTMLForm to control behavior. | |
postText () | |
Protected Member Functions inherited from 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. | |
Protected Attributes | |
int | $cur = 0 |
RevisionRecord null | $curRev = null |
int | $undo = 0 |
int | $undoafter = 0 |
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. | |
Additional Inherited Members | |
Static Public Member Functions inherited from Action | |
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. | |
Temporary action for MCR undos.
This is intended to go away when real MCR support is added to EditPage and the standard undo-with-edit behavior can be implemented there instead.
If this were going to be kept, we'd probably want to figure out a good way to reuse the same code for generating the headers, summary box, and buttons on EditPage and here, and to better share the diffing and preview logic between the two. But doing that now would require much of the rewriting of EditPage that we're trying to put off by doing this instead.
Definition at line 44 of file McrUndoAction.php.
McrUndoAction::__construct | ( | Article | $article, |
IContextSource | $context, | ||
ReadOnlyMode | $readOnlyMode, | ||
RevisionLookup | $revisionLookup, | ||
RevisionRenderer | $revisionRenderer, | ||
CommentFormatter | $commentFormatter, | ||
Config | $config ) |
Article | $article | |
IContextSource | $context | |
ReadOnlyMode | $readOnlyMode | |
RevisionLookup | $revisionLookup | |
RevisionRenderer | $revisionRenderer | |
CommentFormatter | $commentFormatter | |
Config | $config |
Definition at line 68 of file McrUndoAction.php.
References MediaWiki\Config\Config\get().
|
protected |
Reimplemented in McrRestoreAction.
Definition at line 516 of file McrUndoAction.php.
References MediaWiki\HTMLForm\HTMLForm\addHiddenField().
Referenced by alterForm().
|
protected |
Play with the HTMLForm if you need to more substantially.
HTMLForm | $form |
Reimplemented from FormAction.
Reimplemented in McrRestoreAction.
Definition at line 489 of file McrUndoAction.php.
References MediaWiki\HTMLForm\HTMLForm\addButton(), addStatePropagationFields(), getTitle(), MediaWiki\HTMLForm\HTMLForm\setCancelTarget(), MediaWiki\HTMLForm\HTMLForm\setId(), MediaWiki\HTMLForm\HTMLForm\setSubmitName(), MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg(), MediaWiki\HTMLForm\HTMLForm\setSubmitTooltip(), MediaWiki\HTMLForm\HTMLForm\setWrapperLegendMsg(), and MediaWiki\HTMLForm\HTMLForm\showCancel().
|
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
User | $user |
UserBlockedError|ReadOnlyError|PermissionsError |
Reimplemented from Action.
Definition at line 165 of file McrUndoAction.php.
References getTitle(), and initFromParameters().
McrUndoAction::getDescription | ( | ) |
Returns the description that goes below the <h1>
element.
Reimplemented from Action.
Reimplemented in McrRestoreAction.
Definition at line 89 of file McrUndoAction.php.
|
protected |
Get an HTMLForm descriptor array.
Reimplemented from FormAction.
Definition at line 444 of file McrUndoAction.php.
References Action\getRequest().
McrUndoAction::getName | ( | ) |
Return the name of the action this object responds to.
Reimplemented from Action.
Reimplemented in McrRestoreAction.
Definition at line 85 of file McrUndoAction.php.
McrUndoAction::getRestriction | ( | ) |
Get the permission required to perform this action.
Often, but not always, the same as the action name
Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.
Reimplemented from Action.
Definition at line 93 of file McrUndoAction.php.
|
protected |
Reimplemented in McrRestoreAction.
Definition at line 149 of file McrUndoAction.php.
References $curRev, Action\getRequest(), and Action\getWikiPage().
Referenced by checkCanExecute().
McrUndoAction::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 356 of file McrUndoAction.php.
References $curRev, EDIT_AUTOSUMMARY, EDIT_UPDATE, Action\getAuthority(), Action\getContext(), Action\getHookRunner(), MediaWiki\Revision\RevisionRecord\getId(), Action\getRequest(), MediaWiki\Revision\RevisionRecord\getSlotRoles(), getTitle(), Action\getUser(), and Action\getWikiPage().
McrUndoAction::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 522 of file McrUndoAction.php.
References Action\getOutput(), and getTitle().
|
protected |
Add pre- or post-text to the form.
Reimplemented from FormAction.
Definition at line 526 of file McrUndoAction.php.
McrUndoAction::show | ( | ) |
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere.
Some actions have more exotic behavior, but that's what subclassing is for :D
Reimplemented from FormAction.
Definition at line 98 of file McrUndoAction.php.
References Action\getOutput(), Action\getRequest(), and Action\useTransactionalTimeLimit().
|
protected |
Whether the form should use OOUI.
Reimplemented from FormAction.
Definition at line 440 of file McrUndoAction.php.
|
protected |
Definition at line 48 of file McrUndoAction.php.
|
protected |
Definition at line 51 of file McrUndoAction.php.
Referenced by McrRestoreAction\initFromParameters(), initFromParameters(), and onSubmit().
|
protected |
Definition at line 46 of file McrUndoAction.php.
|
protected |
Definition at line 47 of file McrUndoAction.php.