MediaWiki  master
FormAction Class Reference

An action which shows a form and does something based on the input from the form. More...

Inheritance diagram for FormAction:
Collaboration diagram for FormAction:

Public Member Functions

 doesWrites ()
 Stable to override. More...
 
 onSubmit ( $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 
 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. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 getArticle ()
 Get a Article object. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 getSkin ()
 Shortcut to get the Skin being used for this instance. More...
 
 getTitle ()
 Shortcut to get the Title object from the page. More...
 
 getUser ()
 Shortcut to get the User being used for this instance. More...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially Stable to override. More...
 
 getForm ()
 Get the HTMLForm to control behavior Stable to override. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array Stable to override. More...
 
 postText ()
 Stable to override. More...
 
 preText ()
 Add pre- or post-text to the form Stable to override. More...
 
 usesOOUI ()
 Whether the form should use OOUI Stable to override. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

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. More...
 
static factory (?string $action, Page $article, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 
- Protected Attributes inherited from Action
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action. More...
 

Detailed Description

An action which shows a form and does something based on the input from the form.

Stable to extend

Definition at line 30 of file FormAction.php.

Member Function Documentation

◆ alterForm()

FormAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially Stable to override.

Parameters
HTMLForm$form

Reimplemented in McrUndoAction, WatchAction, PurgeAction, MarkpatrolledAction, RevertAction, RollbackAction, UnwatchAction, and McrRestoreAction.

Definition at line 64 of file FormAction.php.

Referenced by getForm().

◆ doesWrites()

FormAction::doesWrites ( )

Stable to override.

Returns
bool

Reimplemented from Action.

Reimplemented in WatchAction, RevertAction, MarkpatrolledAction, PurgeAction, UnwatchAction, and RollbackAction.

Definition at line 169 of file FormAction.php.

◆ getForm()

FormAction::getForm ( )
protected

◆ getFormFields()

FormAction::getFormFields ( )
protected

Get an HTMLForm descriptor array Stable to override.

Returns
array

Reimplemented in McrUndoAction, RollbackAction, WatchAction, PurgeAction, RevertAction, and UnwatchAction.

Definition at line 37 of file FormAction.php.

Referenced by getForm().

◆ onSubmit()

FormAction::onSubmit (   $data)
abstract

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.

See also
HTMLForm::setSubmitCallback()
HTMLForm::trySubmit()
Parameters
array$data
Returns
bool|string|array|Status Must return as documented for HTMLForm::trySubmit

Reimplemented in McrUndoAction, RevertAction, MarkpatrolledAction, WatchAction, RollbackAction, PurgeAction, and UnwatchAction.

◆ onSuccess()

FormAction::onSuccess ( )
abstract

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 in McrUndoAction, WatchAction, RevertAction, MarkpatrolledAction, PurgeAction, UnwatchAction, and RollbackAction.

Referenced by show().

◆ postText()

FormAction::postText ( )
protected

Stable to override.

Returns
string

Reimplemented in PurgeAction.

Definition at line 55 of file FormAction.php.

Referenced by getForm().

◆ preText()

FormAction::preText ( )
protected

Add pre- or post-text to the form Stable to override.

Returns
string HTML which will be sent to $form->addPreText()

Reimplemented in McrUndoAction, and MarkpatrolledAction.

Definition at line 47 of file FormAction.php.

Referenced by getForm().

◆ show()

FormAction::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 Stable to override

Reimplemented from Action.

Reimplemented in RollbackAction, PurgeAction, and McrUndoAction.

Definition at line 153 of file FormAction.php.

References Action\checkCanExecute(), getForm(), Action\getUser(), onSuccess(), and Action\setHeaders().

◆ usesOOUI()

FormAction::usesOOUI ( )
protected

Whether the form should use OOUI Stable to override.

Returns
bool

Reimplemented in McrUndoAction, WatchAction, PurgeAction, RevertAction, MarkpatrolledAction, and RollbackAction.

Definition at line 72 of file FormAction.php.

Referenced by getForm().


The documentation for this class was generated from the following file: