Extensions

'''FlexForm''' can be extended by a PHP function to handle additional tasks after a Form has been submitted.


This can be done with '''FFAfterFormHandling''' MediaWiki Hook. For more information see de Docs on Hooks.


Or using the following method:

Start a FlexForm and tell it to use your extension :<syntaxhighlight lang="html">
<form extension="<name of your extension" >
   Your flexform elements here
</form>
</syntaxhighlight>

Create a folder in <code>FlexForm/src/Modules/Handlers</code> with the name of your extension. 

In this folder create a file called <code>PostHandler.php</code> with the following namespace : 
<syntaxhighlight lang="html">
namespace FlexForm\Modules\Handlers\< your extension name = same as folder name >;
</syntaxhighlight>

Your extension will be based based on a class PostHandler and will utilize the '''HandlerInterface''' interface and will only hold one method : '''execute'''

<syntaxhighlight lang="php">
class PostHandler implements HandlerInterface {
	/**
	 * @inerhitDoc
	 */
	public function execute( array $flexFormFields, ?array $config, HandleResponse $responseHandler ): HandleResponse {

	}
}
</syntaxhighlight>

The array <code>$flexFormFields</code> will be available and hold all submitted Form elements as '''name->value'''.

The array <code>$config</code> will hold an array of your config variables you can set in the FlexForm config array (<code>$wgFlexFormConfig</code>) in your local settings. If you have not set any configuration, $config will be null.

You can set your config settings like so (example from the included PHPList extension, you should change phpList with the name of your extension):
<syntaxhighlight lang="php">
$wgFlexFormConfig['extensions']['phpList']['HTML'] = 1;
$wgFlexFormConfig['extensions']['phpList']['PHP_LIST_URL'] = 'https://example.com/lists';
$wgFlexFormConfig['extensions']['phpList']['FIELD_EMAIL'] = 'email';
</syntaxhighlight>

Once set the <code>$config</code> variable holds everything from <code>$wgFlexFormConfig['extensions']['phpList']</code>. So in this case if you want the FIELD_EMAIL, you get it from <code>$config['FIELD_EMAIL']</code>;


If your extension produces an error, throw a '''FlexFormException''' and FlexForm will take care of the rest. ''Make sure to throw a message that has your extension name in it''.

If your extension has successfully finished its tasks, tell the '''responsehandler''' it has been successful and return the responseHandler :
<syntaxhighlight lang="php">
$responseHandler->setReturnType( HandleResponse::TYPE_SUCCESS );
return $responseHandler;
</syntaxhighlight>

If your extension has successfully finished its tasks and you want to pass additional information to the user :
<syntaxhighlight lang="php">
$responseHandler->setReturnType( HandleResponse::TYPE_SUCCESS );
$responseHandler->setReturnData( string < your message > );
return $responseHandler;
</syntaxhighlight>

==== NOTE: ====
When a FlexForm has the extension tag. FlexForm will first search for the extension in the Handlers folder. If it cannot be found it will run the '''FFAfterFormHandling''' hook.

No error message will be shown if FlexForm cannot find the extension.