[TASK] park current GridColumnItem in runtime cache

to not break the BeforeContainerPreviewIsRenderedEvent Method Signatures
we put the GridColumnItem into the runtime cache in the ContainerPreviewRenderer
renderPageModulePreviewHeader Method (which is always called) and fetch it in
the GridRenderer to pass it tho the Event.
This is a hack to not break the event, but fix the custom BackendTemplate usage
(s. dfc61c4)

Relates to: #563

Author: achimfritz

Classes/Backend/Preview/ContainerPreviewRenderer.php

@@ -15,19 +15,33 @@
 
 use TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer;
 use TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem;
+use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
+use TYPO3\CMS\Core\Information\Typo3Version;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 class ContainerPreviewRenderer extends StandardContentPreviewRenderer
 {
     protected GridRenderer $gridRenderer;
+    protected FrontendInterface $runtimeCache;
 
-    public function __construct(GridRenderer $gridRenderer) {
+    public function __construct(GridRenderer $gridRenderer, FrontendInterface $runtimeCache) {
         $this->gridRenderer = $gridRenderer;
+        $this->runtimeCache = $runtimeCache;
+    }
+
+    public function renderPageModulePreviewHeader(GridColumnItem $item): string
+    {
+        $this->runtimeCache->set('tx_container_current_gridColumItem', $item);
+        return parent::renderPageModulePreviewHeader($item);
     }
 
     public function renderPageModulePreviewContent(GridColumnItem $item): string
     {
+        if ((GeneralUtility::makeInstance(Typo3Version::class))->getMajorVersion() > 11) {
+            return parent::renderPageModulePreviewContent($item);
+        }
         $record = $item->getRecord();
-        $record['tx_container_grid'] = $this->gridRenderer->renderGrid($record, $item->getContext(), $item);
+        $record['tx_container_grid'] = $this->gridRenderer->renderGrid($record, $item->getContext());
         $item->setRecord($record);
         return parent::renderPageModulePreviewContent($item);
     }

Classes/Backend/Preview/GridRenderer.php

@@ -26,6 +26,7 @@
 use TYPO3\CMS\Backend\View\BackendLayout\Grid\GridRow;
 use TYPO3\CMS\Backend\View\PageLayoutContext;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
+use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Fluid\View\StandaloneView;
@@ -37,20 +38,23 @@ class GridRenderer
     protected ContainerFactory $containerFactory;
     protected NewContentUrlBuilder $newContentUrlBuilder;
     protected EventDispatcherInterface $eventDispatcher;
+    protected FrontendInterface $runtimeCache;
 
     public function __construct(
         Registry $tcaRegistry,
         ContainerFactory $containerFactory,
         NewContentUrlBuilder $newContentUrlBuilder,
-        EventDispatcherInterface $eventDispatcher
+        EventDispatcherInterface $eventDispatcher,
+        FrontendInterface $runtimeCache
     ) {
         $this->eventDispatcher = $eventDispatcher;
         $this->tcaRegistry = $tcaRegistry;
         $this->containerFactory = $containerFactory;
         $this->newContentUrlBuilder = $newContentUrlBuilder;
+        $this->runtimeCache = $runtimeCache;
     }
 
-    public function renderGrid(array $record, PageLayoutContext $context, ?GridColumnItem $parentGridColumnItem = null): string
+    public function renderGrid(array $record, PageLayoutContext $context): string
     {
         $grid = GeneralUtility::makeInstance(Grid::class, $context);
         try {
@@ -96,6 +100,7 @@ public function renderGrid(array $record, PageLayoutContext $context, ?GridColum
         $view->assign('grid', $grid);
         $view->assign('containerRecord', $record);
         $view->assign('context', $context);
+        $parentGridColumnItem = $this->runtimeCache->get('tx_container_current_gridColumItem');
         $beforeContainerPreviewIsRendered = new BeforeContainerPreviewIsRenderedEvent($container, $view, $grid, $parentGridColumnItem);
         $this->eventDispatcher->dispatch($beforeContainerPreviewIsRendered);
         $rendered = $view->render();

Classes/Events/BeforeContainerPreviewIsRenderedEvent.php

@@ -25,9 +25,9 @@ final class BeforeContainerPreviewIsRenderedEvent
 
     protected Grid $grid;
 
-    protected ?GridColumnItem $item;
+    protected GridColumnItem $item;
 
-    public function __construct(Container $container, StandaloneView $view, Grid $grid, ?GridColumnItem $item)
+    public function __construct(Container $container, StandaloneView $view, Grid $grid, GridColumnItem $item)
     {
         $this->container = $container;
         $this->view = $view;
@@ -50,8 +50,9 @@ public function getGrid(): Grid
         return $this->grid;
     }
 
-    public function getItem(): ?GridColumnItem
+    public function getItem(): GridColumnItem
     {
+        trigger_error('gridColumItem property will be removed on next major release', E_USER_DEPRECATED);
         return $this->item;
     }
 }

Classes/Tca/Registry.php

@@ -64,8 +64,9 @@ public function configureContainer(ContainerConfiguration $containerConfiguratio
                     $containerConfiguration->getGroup(),
                 ]
             );
-            $GLOBALS['TCA']['tt_content']['types'][$containerConfiguration->getCType()]['previewRenderer'] = \B13\Container\Backend\Preview\ContainerPreviewRenderer::class;
         }
+        $GLOBALS['TCA']['tt_content']['types'][$containerConfiguration->getCType()]['previewRenderer'] = \B13\Container\Backend\Preview\ContainerPreviewRenderer::class;
+
 
         if ((GeneralUtility::makeInstance(Typo3Version::class))->getMajorVersion() >= 13) {
             if (!isset($GLOBALS['TCA']['tt_content']['types'][$containerConfiguration->getCType()]['creationOptions'])) {

Configuration/Services.yaml

@@ -15,8 +15,13 @@ services:
 
   B13\Container\Tca\Registry:
     public: true
+  B13\Container\Backend\Preview\GridRenderer:
+    arguments:
+      $runtimeCache: '@cache.runtime'
   B13\Container\Backend\Preview\ContainerPreviewRenderer:
     public: true
+    arguments:
+      $runtimeCache: '@cache.runtime'
   B13\Container\Hooks\UsedRecords:
     public: true
   B13\Container\Hooks\Datahandler\CommandMapAfterFinishHook: