FormAction Class Reference

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

Inherits Action.

Inherited by DeleteAction, MarkpatrolledAction, McrUndoAction, PurgeAction, RevertAction, RollbackAction, and WatchAction.

Collaboration diagram for FormAction:

Public Member Functions
	doesWrites ()
	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 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.
	getName ()
	Return the name of the action this object responds to.
	getOutput ()
	Get the OutputPage being used for this instance.
	getRequest ()
	Get the WebRequest being used for this instance.
	getRestriction ()
	Get the permission required to perform this action.
	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.
	setHookContainer (HookContainer $hookContainer)

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.
	getForm ()
	Get the HTMLForm to control behavior.
	getFormFields ()
	Get an HTMLForm descriptor array.
	postText ()
	preText ()
	Add pre- or post-text to the form.
	usesOOUI ()
	Whether the form should use OOUI.
Protected Member Functions inherited from Action
	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> element.
	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	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.

Detailed Description

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

Stability: stable

to extend

Definition at line 32 of file FormAction.php.

Member Function Documentation

alterForm()

FormAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable

to override

Parameters

HTMLForm

$form

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

Definition at line 66 of file FormAction.php.

Referenced by getForm().

doesWrites()

FormAction::doesWrites

(

)

Stability: stable

to override

Returns

bool

Reimplemented from Action.

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

Definition at line 171 of file FormAction.php.

getForm()

FormAction::getForm ( )

protected

Get the HTMLForm to control behavior.

Stability: stable

to override

Returns

HTMLForm

Definition at line 83 of file FormAction.php.

References $params, alterForm(), Action\getArticle(), Action\getContext(), getFormFields(), Action\getHookRunner(), Action\getName(), Action\getRequest(), Action\getTitle(), postText(), preText(), usesOOUI(), and wfArrayToCgi().

Referenced by show(), and PurgeAction\show().

getFormFields()

FormAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable

to override

Returns

array

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

Definition at line 39 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 DeleteAction, MarkpatrolledAction, McrUndoAction, PurgeAction, RevertAction, RollbackAction, UnwatchAction, and WatchAction.

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

Referenced by show().

postText()

FormAction::postText ( )

protected

Stability: stable

to override

Returns

string

Reimplemented in PurgeAction.

Definition at line 57 of file FormAction.php.

Referenced by getForm().

preText()

FormAction::preText ( )

protected

Add pre- or post-text to the form.

Stability: stable

to override

Returns

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

Reimplemented in MarkpatrolledAction, and McrUndoAction.

Definition at line 49 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

Stability: stable

to override

Reimplemented from Action.

Reimplemented in DeleteAction, McrUndoAction, PurgeAction, and RollbackAction.

Definition at line 155 of file FormAction.php.

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

usesOOUI()

FormAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable

to override

Returns

bool

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

Definition at line 74 of file FormAction.php.

Referenced by getForm().

---

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

• includes/actions/FormAction.php