[BUGFIX] Implement multiple itemsProcFunc support

Close: FluidTYPO3#2063
monosize · Aug 5, 2023 · fcc9932 · fcc9932
1 parent 8b05036
commit fcc9932
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 4 deletions.
diff --git a/Classes/Integration/MultipleItemsProcFunc.php b/Classes/Integration/MultipleItemsProcFunc.php
@@ -0,0 +1,44 @@
+<?php
+namespace FluidTYPO3\Flux\Integration;
+
+/*
+ * This file is part of the FluidTYPO3/Flux project under GPLv2 or later.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.md file that was distributed with this source code.
+ */
+
+use TYPO3\CMS\Backend\Form\FormDataProviderInterface;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+class MultipleItemsProcFunc
+{
+    public static function register(string $table, string $field, ?string $additionalFunction = null): void
+    {
+        $existingFunction = $GLOBALS['TCA'][$table]['columns'][$field]['config']['itemsProcFunc'] ?? null;
+        $newFunction = static::class . '->execute';
+
+        $GLOBALS['TCA'][$table]['multipleItemsProcessingFunctions'][$field] = array_values(
+            array_filter(
+                array_merge(
+                    $GLOBALS['TCA'][$table]['multipleItemsProcessingFunctions'][$field] ?? [],
+                    [
+                        $existingFunction !== $newFunction ? $existingFunction : null,
+                        $additionalFunction,
+                    ]
+                )
+            )
+        );
+        $GLOBALS['TCA'][$table]['columns'][$field]['config']['itemsProcFunc'] = $newFunction;
+    }
+
+    public function execute(array &$parameters, FormDataProviderInterface $formDataProvider): void
+    {
+        $table = $parameters['table'];
+        $field = $parameters['field'];
+        $processors = $GLOBALS['TCA'][$table]['multipleItemsProcessingFunctions'][$field] ?? [];
+        foreach (array_filter($processors) as $functionReference) {
+            GeneralUtility::callUserFunction($functionReference, $parameters, $formDataProvider);
+        }
+    }
+}
diff --git a/Configuration/TCA/Overrides/pages.php b/Configuration/TCA/Overrides/pages.php
@@ -12,7 +12,6 @@
             'config' => [
                 'type' => 'select',
                 'renderType' => 'selectSingle',
-                'itemsProcFunc' => 'FluidTYPO3\Flux\Backend\PageLayoutDataProvider->addItems',
                 'fieldWizard' => [
                     'selectIcons' => [
                         'disabled' => false
@@ -27,7 +26,6 @@
             'config' => [
                 'type' => 'select',
                 'renderType' => 'selectSingle',
-                'itemsProcFunc' => 'FluidTYPO3\Flux\Backend\PageLayoutDataProvider->addItems',
                 'fieldWizard' => [
                     'selectIcons' => [
                         'disabled' => false
@@ -57,6 +55,18 @@
         ],
     ]);
 
+    \FluidTYPO3\Flux\Integration\MultipleItemsProcFunc::register(
+        'pages',
+        'tx_fed_page_controller_action',
+        \FluidTYPO3\Flux\Backend\PageLayoutDataProvider::class . '->addItems'
+    );
+
+    \FluidTYPO3\Flux\Integration\MultipleItemsProcFunc::register(
+        'pages',
+        'tx_fed_page_controller_action_sub',
+        \FluidTYPO3\Flux\Backend\PageLayoutDataProvider::class . '->addItems'
+    );
+
     $userFunctionsClass = new \FluidTYPO3\Flux\Integration\FormEngine\UserFunctions();
     if (is_callable([$userFunctionsClass , 'fluxFormFieldDisplayCondition'])) {
 

diff --git a/Configuration/TCA/Overrides/tt_content.php b/Configuration/TCA/Overrides/tt_content.php
@@ -1,8 +1,12 @@
 <?php
 
 (function () {
-    $GLOBALS['TCA']['tt_content']['columns']['colPos']['config']['itemsProcFunc'] =
-        \FluidTYPO3\Flux\Integration\Overrides\BackendLayoutView::class . '->colPosListItemProcFunc';
+    \FluidTYPO3\Flux\Integration\MultipleItemsProcFunc::register(
+        'tt_content',
+        'colPos',
+        \FluidTYPO3\Flux\Integration\Overrides\BackendLayoutView::class . '->colPosListItemProcFunc'
+    );
+
     $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['label'] = 'LLL:EXT:flux/Resources/Private/Language/locallang.xlf:tt_content.pi_flexform';
 
     if (\FluidTYPO3\Flux\Utility\ExtensionConfigurationUtility::getOption(\FluidTYPO3\Flux\Utility\ExtensionConfigurationUtility::OPTION_FLEXFORM_TO_IRRE)) {

diff --git a/Tests/Unit/Integration/MultipleItemsProcFuncTest.php b/Tests/Unit/Integration/MultipleItemsProcFuncTest.php
@@ -0,0 +1,45 @@
+<?php
+namespace FluidTYPO3\Flux\Tests\Unit\Integration;
+
+/*
+ * This file is part of the FluidTYPO3/Flux project under GPLv2 or later.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.md file that was distributed with this source code.
+ */
+
+use FluidTYPO3\Flux\Integration\MultipleItemsProcFunc;
+use FluidTYPO3\Flux\Tests\Unit\AbstractTestCase;
+use TYPO3\CMS\Backend\Form\FormDataProviderInterface;
+
+class MultipleItemsProcFuncTest extends AbstractTestCase
+{
+    private static $executed = false;
+
+    public function testRegistersFunction(): void
+    {
+        MultipleItemsProcFunc::register('table', 'field', static::class . '->dummyFunction');
+        self::assertSame(
+            MultipleItemsProcFunc::class . '->execute',
+            $GLOBALS['TCA']['table']['columns']['field']['config']['itemsProcFunc']
+        );
+        self::assertSame(
+            [static::class . '->dummyFunction'],
+            $GLOBALS['TCA']['table']['multipleItemsProcessingFunctions']['field']
+        );
+    }
+
+    public function testExecutesFunction(): void
+    {
+        $provider = $this->getMockBuilder(FormDataProviderInterface::class)->getMockForAbstractClass();
+        MultipleItemsProcFunc::register('table', 'field', static::class . '->dummyFunction');
+        $parameters = ['table' => 'table', 'field' => 'field'];
+        (new MultipleItemsProcFunc())->execute($parameters, $provider);
+        self::assertTrue(static::$executed);
+    }
+
+    public function dummyFunction(): void
+    {
+        static::$executed = true;
+    }
+}