DevOps:Doc/FlexForm/2.0/Extensions - Revision history

Maintenance script: Imported by PageSync

2025-07-15T08:36:29Z

Imported by PageSync

ws-class-props
← Older revision		Revision as of 10:36, 15 July 2025
Line 1:		Line 1:
	{{~~Doc~~ properties		{{Csp class properties
	\|Subject version=2.0		\|Subject version=2.0
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm

Charlot: User:Charlot

2023-04-08T08:20:34Z

User:Charlot

ws-class-props
← Older revision		Revision as of 10:20, 8 April 2023
Line 1:		Line 1:
	{{Doc properties		{{Doc properties
	\|Subject version=2.0~~,2.1~~		\|Subject version=2.0
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm
	\|Doc sort order=250		\|Doc sort order=250

Charlot: User:Charlot

2023-03-30T19:57:07Z

User:Charlot

ws-class-props
← Older revision		Revision as of 21:57, 30 March 2023
Line 1:		Line 1:
	{{Doc properties		{{Doc properties
	\|Subject version=2.0		\|Subject version=2.0,2.1
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm
	\|Doc sort order=250		\|Doc sort order=250

Charlot at 13:36, 4 January 2023

2023-01-04T13:36:58Z

← Older revision		Revision as of 15:36, 4 January 2023
Line 8:		Line 8:

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

Charlot: User:Charlot

2023-01-04T13:36:21Z

User:Charlot

ws-class-props
← Older revision		Revision as of 15:36, 4 January 2023
Line 4:		Line 4:
	\|Doc sort order=250		\|Doc sort order=250
	\|Doc target group=Developer		\|Doc target group=Developer
			\|Doc synopsis=Creating a FlexForm extension
			\|Doc parent=
	}}		}}

Charlot: User:Charlot

2023-01-04T13:36:12Z

User:Charlot

New page

'''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 action="addToWiki" 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, HandleResponse $responseHandler ): HandleResponse {

}
}
</syntaxhighlight>

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

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

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.