[TASK] Replace "new" button for scheduler tasks in FormEngine

Editing a `tx_scheduler_task` also allowed
creating a new task via the "New" button in
the FormEngine doc header. However, since
#107526, the task type can no longer be
changed in FormEngine. Therefore, the "New"
button was hidden as it led to a broken
editing view.

Thanks to #107471, a dedicated wizard is
available for creating new tasks. This wizard
can therefore now be used in FormEngine.

Resolves: #107539
Related: #107471
Related: #107526
Releases: main
Change-Id: I77f8887dba0dba902cd2af6ae70844fd448f00a3
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/90798
Reviewed-by: Garvin Hicking <garvin@hick.ing>
Tested-by: Oli Bartsch <bo@cedev.de>
Reviewed-by: Benni Mack <benni@typo3.org>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Garvin Hicking <garvin@hick.ing>
Reviewed-by: Oli Bartsch <bo@cedev.de>
Tested-by: Benni Mack <benni@typo3.org>

Author: o-ba

typo3/sysext/scheduler/Classes/EventListener/ReplaceAddNewButtonToFormEngine.php

@@ -0,0 +1,94 @@
+<?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\Scheduler\EventListener;
+
+use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Backend\Routing\UriBuilder;
+use TYPO3\CMS\Backend\Template\Components\ModifyButtonBarEvent;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+use TYPO3\CMS\Core\Imaging\IconFactory;
+use TYPO3\CMS\Core\Imaging\IconSize;
+use TYPO3\CMS\Core\Localization\LanguageService;
+use TYPO3\CMS\Core\Page\PageRenderer;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+/**
+ * Listener replaces the "New" button of FormEngine with the button to open the scheduler task wizard
+ */
+final readonly class ReplaceAddNewButtonToFormEngine
+{
+    public function __construct(
+        private IconFactory $iconFactory,
+        private PageRenderer $pageRenderer,
+        private UriBuilder $uriBuilder,
+    ) {}
+
+    #[AsEventListener]
+    public function __invoke(ModifyButtonBarEvent $event): void
+    {
+        $request = $this->getRequest();
+
+        if (($request->getAttribute('routing')?->getRoute()?->getOptions()['_identifier'] ?? '') !== 'record_edit') {
+            return;
+        }
+
+        $editConfig = $request->getQueryParams()['edit'] ?? null;
+        if (!is_array($editConfig) || $editConfig === [] || count($editConfig) > 1 || key($editConfig) !== 'tx_scheduler_task') {
+            return;
+        }
+
+        $buttons = $event->getButtons();
+        $leftButtons = $buttons['left'] ?? [];
+
+        $this->pageRenderer->loadJavaScriptModule('@typo3/scheduler/new-scheduler-task-wizard-button.js');
+
+        $addTaskUrl = (string)$this->uriBuilder->buildUriFromRoute('ajax_new_scheduler_task_wizard', [
+            'returnUrl' => GeneralUtility::sanitizeLocalUrl($request->getQueryParams()['returnUrl'] ?? '') ?: $request->getAttribute('normalizedParams')->getRequestUri(),
+        ]);
+
+        $languageService = $this->getLanguageService();
+        $newButton = $event->getButtonBar()->makeFullyRenderedButton()->setHtmlSource(
+            '<typo3-scheduler-new-task-wizard-button url="' . $addTaskUrl . '" subject="' . htmlspecialchars($languageService->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:function.add')) . '">'
+            . $this->iconFactory->getIcon('actions-plus', IconSize::SMALL) . htmlspecialchars($languageService->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:function.add')) .
+            '</typo3-scheduler-new-task-wizard-button>'
+        );
+
+        // Find and replace t3js-editform-new button
+        // By replacing the existing button we ensure to respect TSconfig and that user has necessary permissions
+        foreach ($leftButtons as $groupIndex => $buttonGroup) {
+            foreach ($buttonGroup as $buttonIndex => $button) {
+                if (method_exists($button, 'getClasses') && str_contains($button->getClasses(), 't3js-editform-new')) {
+                    $leftButtons[$groupIndex][$buttonIndex] = $newButton;
+                }
+            }
+        }
+
+        $buttons['left'] = $leftButtons;
+        $event->setButtons($buttons);
+    }
+
+    private function getLanguageService(): LanguageService
+    {
+        return $GLOBALS['LANG'];
+    }
+
+    private function getRequest(): ServerRequestInterface
+    {
+        return $GLOBALS['TYPO3_REQUEST'];
+    }
+}