diff --git a/Documentation/ApiOverview/Events/Events/Form/AfterFormIsBuiltEvent.rst b/Documentation/ApiOverview/Events/Events/Form/AfterFormIsBuiltEvent.rst new file mode 100644 index 0000000000..71ba7d2091 --- /dev/null +++ b/Documentation/ApiOverview/Events/Events/Form/AfterFormIsBuiltEvent.rst @@ -0,0 +1,33 @@ +.. include:: /Includes.rst.txt +.. index:: Events; AfterFormIsBuiltEvent + +.. _AfterFormIsBuiltEvent: + +===================== +AfterFormIsBuiltEvent +===================== + +.. versionadded:: 14.0 + The events :php-short:`TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent` + and :php-short:`TYPO3\CMS\Form\Event\BeforeRenderableIsAddedToFormEvent` + provide an improved replacement for the removed hook + :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterBuildingFinished']`. + +The event :php-short:`TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent` +allows the form definition to be modified after a form has been created. + + +.. _AfterFormIsBuiltEvent-example: + +Example +======= + +.. literalinclude:: _AfterFormIsBuiltEvent/_MyEventListener.php + :caption: EXT:my_extension/Classes/EventListener/MyEventListener.php + +.. _AfterFormIsBuiltEvent-api: + +API +=== + +.. include:: /CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt diff --git a/Documentation/ApiOverview/Events/Events/Form/_AfterFormIsBuiltEvent/_MyEventListener.php b/Documentation/ApiOverview/Events/Events/Form/_AfterFormIsBuiltEvent/_MyEventListener.php new file mode 100644 index 0000000000..67ea1f270d --- /dev/null +++ b/Documentation/ApiOverview/Events/Events/Form/_AfterFormIsBuiltEvent/_MyEventListener.php @@ -0,0 +1,19 @@ +form->setLabel('foo'); + } +} diff --git a/Documentation/CodeSnippets/Config/Api/Events/EventsForm.php b/Documentation/CodeSnippets/Config/Api/Events/EventsForm.php index 1f17c863e2..796136e18a 100644 --- a/Documentation/CodeSnippets/Config/Api/Events/EventsForm.php +++ b/Documentation/CodeSnippets/Config/Api/Events/EventsForm.php @@ -1,6 +1,12 @@ 'createPhpClassDocs', + 'class' => \TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent::class, + 'targetFileName' => 'CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt', + 'withCode' => false, + ], [ 'action' => 'createPhpClassDocs', 'class' => \TYPO3\CMS\Form\Mvc\Persistence\Event\AfterFormDefinitionLoadedEvent::class, diff --git a/Documentation/CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt b/Documentation/CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt new file mode 100644 index 0000000000..9326723835 --- /dev/null +++ b/Documentation/CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt @@ -0,0 +1,10 @@ +.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets +.. php:namespace:: TYPO3\CMS\Form\Event + +.. php:class:: AfterFormIsBuiltEvent + + Listeners to this event will be able to modify the form definition + after a form is created. + + .. php:attr:: form + :public: