DevOps:Doc/FlexForm/1.1/extensions - Revision history

81d56153-9868-4094-90a0-df1700ff7090: Text replacement - "{{Doc properties" to "{{Csp class properties"

2025-07-15T09:00:51Z

Text replacement - "{{Doc properties" to "{{Csp class properties"

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

Charlot: User:Charlot

2022-09-22T13:49:50Z

User:Charlot

ws-class-props
← Older revision		Revision as of 15:49, 22 September 2022
Line 4:		Line 4:
	\|Doc parent=		\|Doc parent=
	\|Doc sort order=250		\|Doc sort order=250
	\|Doc target group=~~User~~		\|Doc target group=Developer
			\|Doc synopsis=Creating a FlexForm extension
	}}		}}

Slot migration: Slot migration

2022-08-03T12:00:13Z

Slot migration

ws-class-props
← Older revision		Revision as of 14:00, 3 August 2022
Line 1:		Line 1:
			{{Doc properties
			\|Doc subject=DevOps:Doc/FlexForm
			\|Subject version=1.1
			\|Doc parent=
			\|Doc sort order=250
			\|Doc target group=User
			}}
ws-page-props
Line 1:		Line 1:
	~~{{Doc properties~~
	~~\|Doc subject=DevOps:Doc/FlexForm~~
	~~\|Subject version=1.1~~
	~~\|Doc parent=~~
	~~\|Doc sort order=250~~
	~~\|Doc target group=User~~
	}}

Charlot at 09:33, 30 May 2022

2022-05-30T09:33:32Z

← Older revision		Revision as of 11:33, 30 May 2022
Line 21:		Line 21:

	Your extension will be based based on a class PostHandler and will utilize the '''HandlerInterface''' interface and will only hold one method : '''execute'''		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'''.		The array <code>$flexFormFields</code> will be available and hold all submitted Form elements as '''name->value'''.
Line 27:		Line 38:

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

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

Charlot at 09:31, 30 May 2022

2022-05-30T09:31:50Z

← Older revision		Revision as of 11:31, 30 May 2022
Line 20:		Line 20:
	</syntaxhighlight>		</syntaxhighlight>

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

	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'''.

Charlot at 20:03, 24 May 2022

2022-05-24T20:03:28Z

← Older revision		Revision as of 22:03, 24 May 2022
Line 38:		Line 38:
	return $responseHandler;		return $responseHandler;
	</syntaxhighlight>		</syntaxhighlight>
	~~NOTE:~~

			==== 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.		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.		No error message will be shown if FlexForm cannot find the extension.

Charlot at 20:03, 24 May 2022

2022-05-24T20:03:12Z

← Older revision		Revision as of 22:03, 24 May 2022
Line 38:		Line 38:
	return $responseHandler;		return $responseHandler;
	</syntaxhighlight>		</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.

Charlot at 12:36, 24 May 2022

2022-05-24T12:36:24Z

← Older revision		Revision as of 14:36, 24 May 2022
Line 1:		Line 1:
	'''FlexForm''' can be extended by a PHP function to handle additional tasks after a Form has been submitted.		'''FlexForm''' can be extended by a PHP function to handle additional tasks after a Form has been submitted.

	Start a FlexForm and tell it to use your extension :
	<syntaxhighlight lang="html">		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" >		<_form action="addToWiki" extension="<name of your extension" >
	Your flexform elements here		Your flexform elements here

Admin at 09:50, 24 May 2022

2022-05-24T09:50:55Z

← Older revision		Revision as of 11:50, 24 May 2022
Line 15:		Line 15:
	</syntaxhighlight>		</syntaxhighlight>

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

	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'''.

Admin at 09:50, 24 May 2022

2022-05-24T09:50:27Z

← Older revision		Revision as of 11:50, 24 May 2022
Line 1:		Line 1:
	FlexForm can be extended by a PHP function to handle additional tasks after a Form has been submitted.		'''FlexForm''' can be extended by a PHP function to handle additional tasks after a Form has been submitted.

	Start a FlexForm and tell it to use your extension :		Start a FlexForm and tell it to use your extension :
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

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

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

	Your extension will be ~~base~~ on the HandlerInterface interface and will only hold one method : execute		Your extension will be based on the '''HandlerInterface''' interface and will only hold one method : execute

	The array $flexFormFields 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'''.

	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 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 ~~successfull~~ and return the responseHandler :		If your extension has successfully finished its tasks, tell the '''responsehandler''' it has been successful and return the responseHandler :
	<syntaxhighlight lang="html">		<syntaxhighlight lang="html">
	$responseHandler->setReturnType( HandleResponse::TYPE_SUCCESS );		$responseHandler->setReturnType( HandleResponse::TYPE_SUCCESS );