FormAction Class Reference

Inheritance diagram for FormAction:

Collaboration diagram for FormAction:

List of all members.

Public Member Functions
	execute (array $data=null, $captureErrors=true)
	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.
Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.
	getForm ()
	Get the HTMLForm to control behaviour.
	getFormFields ()
	Get an HTMLForm descriptor array.
	postText ()
	preText ()
	Add pre- or post-text to the form.

---

Detailed Description

Definition at line 353 of file Action.php.

---

Member Function Documentation

FormAction::alterForm

(

HTMLForm $

form

)

[protected]

Play with the HTMLForm if you need to more substantially.

Parameters:

$form

HTMLForm

Reimplemented in UnwatchAction, WatchAction, PurgeAction, and RevertFileAction.

Definition at line 376 of file Action.php.

Referenced by getForm().

Here is the caller graph for this function:

FormAction::execute	(	array $	data = null,
		$	captureErrors = true
	)

See also:

Action::execute()

Exceptions:

ErrorPageError

Parameters:

array | null	$data
bool	$captureErrors

Returns:

bool

Definition at line 451 of file Action.php.

References Action\$fields, Action\checkCanExecute(), Action\getUser(), onSubmit(), and onSuccess().

Here is the call graph for this function:

FormAction::getForm

(

)

[protected]

Get the HTMLForm to control behaviour.

Returns:

HTMLForm|null

Definition at line 382 of file Action.php.

References alterForm(), Action\getContext(), getFormFields(), Action\getName(), Action\getRequest(), postText(), preText(), wfArrayToCGI(), and wfRunHooks().

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

Here is the call graph for this function:

Here is the caller graph for this function:

FormAction::getFormFields

(

)

[abstract, protected]

Get an HTMLForm descriptor array.

Returns:

Array

Reimplemented in RevertFileAction, PurgeAction, and WatchAction.

Referenced by getForm().

Here is the caller graph for this function:

FormAction::onSubmit

(

$

data

)

[abstract]

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 in UnwatchAction, RevertFileAction, PurgeAction, and WatchAction.

Referenced by execute().

Here is the caller graph for this function:

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 UnwatchAction, WatchAction, RevertFileAction, and PurgeAction.

Referenced by execute(), and show().

Here is the caller graph for this function:

FormAction::postText

(

)

[protected]

Returns:

string

Reimplemented in PurgeAction.

Definition at line 370 of file Action.php.

Referenced by getForm().

Here is the caller graph for this function:

FormAction::preText

(

)

[protected]

Add pre- or post-text to the form.

Returns:

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

Reimplemented in UnwatchAction, WatchAction, and PurgeAction.

Definition at line 365 of file Action.php.

Referenced by getForm().

Here is the caller graph for this function:

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 behaviour, but that's what subclassing is for :D

Reimplemented from Action.

Reimplemented in PurgeAction, and WatchAction.

Definition at line 432 of file Action.php.

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

Here is the call graph for this function:

---

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

• includes/Action.php