| Line 1: | Line 1: | ||
FFAfterFormHandling hook | FFAfterFormHandling hook | ||
| − | When FlexForm is finished processing a submit | + | When FlexForm |
| + | |||
| + | * is initiated with an extension | ||
| + | * is finished processing a submit and just before it will set notifications and return to the user | ||
| + | |||
| + | it (FlexForm) will first search for the extension in the extension folder. If it cannot find it, the '''FFAfterFormHandling''' Hook will run. | ||
Allowing people to do additional actions with the information submitted by the Form. | Allowing people to do additional actions with the information submitted by the Form. | ||
| Line 8: | Line 13: | ||
! colspan="2" |<center>FFAfterFormHandling</center> | ! colspan="2" |<center>FFAfterFormHandling</center> | ||
|- | |- | ||
| − | | colspan="2" |<center>Available since version 1.1. | + | | colspan="2" |<center>Available since version 1.1.15</center> |
|- | |- | ||
| colspan="2" |<center>Allows final actions on form values before output</center> | | colspan="2" |<center>Allows final actions on form values before output</center> | ||
|- | |- | ||
|function | |function | ||
| − | |<code>public static function onFFAfterFormHandling( $flexFormFields, &$responseHandler ) { ... }</code> | + | |<code>public static function onFFAfterFormHandling( string $external, array $flexFormFields, HandleResponse &$responseHandler ) { ... }</code> |
|- | |- | ||
|hook | |hook | ||
| Line 21: | Line 26: | ||
|<code>FlexForm/src/Processors/Request/External.php. Method: runHook</code> | |<code>FlexForm/src/Processors/Request/External.php. Method: runHook</code> | ||
|} | |} | ||
| + | |||
| + | The string $external will hold the name of the extension that was assigned to the form. | ||
The array <code>$flexFormFields</code> will be available and hold all submitted Form elements as '''name->value'''. | The array <code>$flexFormFields</code> will be available and hold all submitted Form elements as '''name->value'''. | ||
Revision as of 21:01, 24 May 2022
FFAfterFormHandling hook
When FlexForm
- is initiated with an extension
- is finished processing a submit and just before it will set notifications and return to the user
it (FlexForm) will first search for the extension in the extension folder. If it cannot find it, the FFAfterFormHandling Hook will run.
Allowing people to do additional actions with the information submitted by the Form.
| function | public static function onFFAfterFormHandling( string $external, array $flexFormFields, HandleResponse &$responseHandler ) { ... }
|
| hook | $wgHooks['FFAfterFormHandling'][] = 'MyExtensionHooks::onFFAfterFormHandling';
|
| called from | FlexForm/src/Processors/Request/External.php. Method: runHook
|
The string $external will hold the name of the extension that was assigned to the form.
The array $flexFormFields will be available and hold all submitted Form elements as name->value.
responseHandler function :
on error :
$responseHandler->setReturnType( HandleResponse::TYPE_ERROR );
$responseHandler->setReturnStatus( "Your general error info" );
$responseHandler->setReturnData( "Details information" );
on success you only have to return true. If you want to add a message that FlexForm should who, then you can do the following :
$responseHandler->setReturnType( HandleResponse::TYPE_SUCCESS);
$responseHandler->setReturnData( "Success information" );
Always return true;
