An action which shows a form and does something based on the input from the form. More...
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 behavior. | |
| getFormFields () | |
| Get an HTMLForm descriptor array. | |
| postText () | |
| preText () | |
| Add pre- or post-text to the form. | |
Detailed Description
An action which shows a form and does something based on the input from the form.
Definition at line 29 of file FormAction.php.
Member Function Documentation
| FormAction::alterForm | ( | HTMLForm $ | form | ) | [protected] |
Play with the HTMLForm if you need to more substantially.
- Parameters:
-
HTMLForm $form
Reimplemented in UnwatchAction, WatchAction, PurgeAction, and RevertFileAction.
Definition at line 56 of file FormAction.php.
Referenced by getForm().
| FormAction::execute | ( | array $ | data = null, |
| $ | captureErrors = true |
||
| ) |
- See also:
- Action::execute()
- Parameters:
-
array | null $data bool $captureErrors
- Exceptions:
-
ErrorPageError|Exception
- Returns:
- bool
Definition at line 133 of file FormAction.php.
References $e, Action\$fields, $key, $params, array(), as, Action\checkCanExecute(), Action\getContext(), Action\getUser(), onSubmit(), and onSuccess().
| FormAction::getForm | ( | ) | [protected] |
Get the HTMLForm to control behavior.
- Returns:
- HTMLForm|null
Definition at line 63 of file FormAction.php.
References $form, $params, alterForm(), array(), Action\getContext(), getFormFields(), Action\getName(), Action\getRequest(), page, postText(), preText(), wfArrayToCgi(), and wfRunHooks().
Referenced by WatchAction\show(), PurgeAction\show(), and show().
| FormAction::getFormFields | ( | ) | [abstract, protected] |
Get an HTMLForm descriptor array.
- Returns:
- array
Reimplemented in RevertFileAction, PurgeAction, and WatchAction.
Referenced by getForm().
| 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:
-
array $data
- 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().
| 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.
| FormAction::postText | ( | ) | [protected] |
- Returns:
- string
Reimplemented in PurgeAction.
Definition at line 48 of file FormAction.php.
Referenced by getForm().
| 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 41 of file FormAction.php.
Referenced by getForm().
| 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
Reimplemented from Action.
Reimplemented in PurgeAction, and WatchAction.
Definition at line 113 of file FormAction.php.
References $form, Action\checkCanExecute(), getForm(), Action\getUser(), onSuccess(), and Action\setHeaders().
The documentation for this class was generated from the following file:
- includes/actions/FormAction.php
