[!!!][FEATURE] Add PSR-14 Event before renderable is rendered

A new PSR-14 event TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent
has been introduced which serves as an replacement for the now
removed hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering'].

Resolves: #107569
Releases: main
Change-Id: Ic57fe2a7e8a359bf344eb5f69f72f24ff922c8f6
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/90977
Reviewed-by: Sven Liebert <mail@sven-liebert.de>
Reviewed-by: Simon Schaufelberger <simonschaufi+typo3@gmail.com>
Reviewed-by: Oli Bartsch <bo@cedev.de>
Tested-by: Simon Schaufelberger <simonschaufi+typo3@gmail.com>
Tested-by: Sven Liebert <mail@sven-liebert.de>
Tested-by: Oli Bartsch <bo@cedev.de>
Tested-by: core-ci <typo3@b13.com>

Author: brosua

typo3/sysext/core/Documentation/Changelog/14.0/Breaking-107569-RemovedBeforeRenderingHook.rst

@@ -0,0 +1,38 @@
+.. include:: /Includes.rst.txt
+
+.. _breaking-107569-1759906416:
+
+==================================================
+Breaking: #107569 - Removed "beforeRendering" hook
+==================================================
+
+See :issue:`107569`
+
+Description
+===========
+
+The hook :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering']`
+has been removed in favor of the more powerful PSR-14 :php:`TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent`.
+
+Impact
+======
+
+Any hook implementation registered is not executed anymore in TYPO3 v14.0+.
+
+Affected installations
+======================
+
+TYPO3 installations with custom extensions using this hook. The extension
+scanner reports any usage as weak match.
+
+Migration
+=========
+
+The hook is removed without deprecation in order to allow extensions
+to work with TYPO3 v13 (using the hook) and v14+ (using the new event)
+when implementing the event as well without any further deprecations.
+Use the :ref:`PSR-14 Event <feature-107569-1759906422>` to allow greater
+influence in the functionality. Especially because the event is dispatched
+later, it allows more modifications than the previous hook.
+
+.. index:: Backend, ext:form, FullyScanned

typo3/sysext/core/Documentation/Changelog/14.0/Feature-107569-IntroducePSR14BeforeRenderableIsRenderedEvent.rst

@@ -0,0 +1,60 @@
+.. include:: /Includes.rst.txt
+
+.. _feature-107569-1759906422:
+
+=============================================================
+Feature: #107569 - PSR-14 Event before renderable is rendered
+=============================================================
+
+See :issue:`107569`
+
+Description
+===========
+
+A new PSR-14 event :php:`TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent`
+has been introduced which serves as an replacement for the now
+:ref:`removed <breaking-107569-1759906416>` hook
+:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering']`.
+
+The new event is dispatched just right before a renderable is rendered.
+
+The event provides the following public properties:
+
+* :php:`$renderable`: The form element
+* :php:`$formRuntime`: The form runtime
+
+Example
+=======
+
+An example event listener could look like:
+
+..  code-block:: php
+
+    use TYPO3\CMS\Core\Attribute\AsEventListener;
+    use TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent;
+
+    class MyEventListener {
+
+        #[AsEventListener(
+            identifier: 'my-extension/before-renderable-is-rendered',
+        )]
+        public function __invoke(BeforeRenderableIsRenderedEvent $event): void
+        {
+            $renderable = $event->renderable;
+            if ($renderable->getType() !== 'Date') {
+                return;
+            }
+            $date = $event->formRuntime[$renderable->getIdentifier()];
+            if ($date instanceof \DateTime) {
+                $event->formRuntime[$renderable->getIdentifier()] = $date->format('Y-m-d');
+            }
+        }
+    }
+
+Impact
+======
+
+With the new PSR-14 :php:`BeforeRenderableIsRenderedEvent`, it's now
+possible to modify the renderable before it's rendered or modify the form runtime.
+
+.. index:: Backend, ext:form

typo3/sysext/form/Classes/Domain/Renderer/FluidFormRenderer.php

@@ -21,12 +21,13 @@
 
 namespace TYPO3\CMS\Form\Domain\Renderer;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\View\ViewFactoryData;
 use TYPO3\CMS\Core\View\ViewFactoryInterface;
 use TYPO3\CMS\Fluid\View\FluidViewAdapter;
 use TYPO3\CMS\Form\Domain\Exception\RenderingException;
+use TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent;
 use TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper;
 
 /**
@@ -131,6 +132,7 @@ class FluidFormRenderer extends AbstractElementRenderer
 {
     public function __construct(
         protected readonly ViewFactoryInterface $viewFactory,
+        private readonly EventDispatcherInterface $eventDispatcher,
     ) {}
 
     /**
@@ -174,12 +176,7 @@ public function render(): string
                 ->getViewHelperVariableContainer()
                 ->addOrUpdate(RenderRenderableViewHelper::class, 'formRuntime', $this->formRuntime);
         }
-        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering'] ?? [] as $className) {
-            $hookObj = GeneralUtility::makeInstance($className);
-            if (method_exists($hookObj, 'beforeRendering')) {
-                $hookObj->beforeRendering($this->formRuntime, $this->formRuntime->getFormDefinition());
-            }
-        }
+        $this->eventDispatcher->dispatch(new BeforeRenderableIsRenderedEvent($this->formRuntime->getFormDefinition(), $this->formRuntime));
         return $view->render($this->formRuntime->getTemplateName());
     }
 }

typo3/sysext/form/Classes/Event/BeforeRenderableIsRenderedEvent.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Form\Event;
+
+use TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
+use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
+
+/**
+ * Listeners to this Event will be able to modify the renderable before it is rendered.
+ */
+final class BeforeRenderableIsRenderedEvent
+{
+    public function __construct(
+        public RootRenderableInterface $renderable,
+        public FormRuntime $formRuntime,
+    ) {}
+}

typo3/sysext/form/Classes/EventListener/BeforeRenderableIsRenderedEventListener.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Form\EventListener;
+
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+use TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent;
+
+class BeforeRenderableIsRenderedEventListener
+{
+    #[AsEventListener('form-framework/format-date-before-rendered')]
+    public function __invoke(BeforeRenderableIsRenderedEvent $event): void
+    {
+        $renderable = $event->renderable;
+        if ($renderable->getType() !== 'Date') {
+            return;
+        }
+        $date = $event->formRuntime[$renderable->getIdentifier()];
+        if ($date instanceof \DateTime) {
+            // @see https://www.w3.org/TR/2011/WD-html-markup-20110405/input.date.html#input.date.attrs.value
+            // 'Y-m-d' = https://tools.ietf.org/html/rfc3339#section-5.6 -> full-date
+            $event->formRuntime[$renderable->getIdentifier()] = $date->format('Y-m-d');
+        }
+    }
+}

typo3/sysext/form/Classes/Hooks/FormElementHooks.php

@@ -18,7 +18,6 @@
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Validation\Error;
 use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
-use TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
 use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 use TYPO3\CMS\Form\Service\TranslationService;
 
@@ -57,20 +56,4 @@ public function afterSubmit(FormRuntime $formRuntime, RenderableInterface $rende
 
         return $elementValue;
     }
-
-    /**
-     * This is a hook that is invoked by the rendering system **before**
-     * the corresponding element is rendered.
-     */
-    public function beforeRendering(FormRuntime $formRuntime, RootRenderableInterface $renderable)
-    {
-        if ($renderable->getType() === 'Date') {
-            $date = $formRuntime[$renderable->getIdentifier()];
-            if ($date instanceof \DateTime) {
-                // @see https://www.w3.org/TR/2011/WD-html-markup-20110405/input.date.html#input.date.attrs.value
-                // 'Y-m-d' = https://tools.ietf.org/html/rfc3339#section-5.6 -> full-date
-                $formRuntime[$renderable->getIdentifier()] = $date->format('Y-m-d');
-            }
-        }
-    }
 }

typo3/sysext/form/Classes/ViewHelpers/RenderRenderableViewHelper.php

@@ -21,10 +21,11 @@
 
 namespace TYPO3\CMS\Form\ViewHelpers;
 
-use TYPO3\CMS\Core\Utility\GeneralUtility;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
 use TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
 use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
+use TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 
 /**
@@ -42,6 +43,10 @@ final class RenderRenderableViewHelper extends AbstractViewHelper
      */
     protected $escapeOutput = false;
 
+    public function __construct(
+        private readonly EventDispatcherInterface $eventDispatcher,
+    ) {}
+
     public function initializeArguments(): void
     {
         $this->registerArgument('renderable', RootRenderableInterface::class, 'A RenderableInterface instance', true);
@@ -54,17 +59,9 @@ public function render(): string
             ->getViewHelperVariableContainer()
             ->get(self::class, 'formRuntime');
         $renderable = $this->arguments['renderable'];
-        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering'] ?? [] as $className) {
-            $hookObj = GeneralUtility::makeInstance($className);
-            if (method_exists($hookObj, 'beforeRendering')) {
-                $hookObj->beforeRendering(
-                    $formRuntime,
-                    $renderable
-                );
-            }
-        }
+        $this->eventDispatcher->dispatch(new BeforeRenderableIsRenderedEvent($renderable, $formRuntime));
         $content = '';
-        if ($renderable instanceof FormRuntime || $renderable instanceof RenderableInterface && $renderable->isEnabled()) {
+        if ($renderable instanceof FormRuntime || ($renderable instanceof RenderableInterface && $renderable->isEnabled())) {
             $content = $this->renderChildren();
         }
         // Wrap every renderable with a span with an identifier path data attribute if previewMode is active