[BUGFIX] Correct template lookup when page record is new

Close: FluidTYPO3#2135 Close: FluidTYPO3#2138
monosize · Oct 10, 2023 · 2eecad3 · 2eecad3
1 parent ae31509
commit 2eecad3
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 4 deletions.
diff --git a/Classes/Provider/PageProvider.php b/Classes/Provider/PageProvider.php
@@ -84,14 +84,25 @@ public function getForm(array $row, ?string $forField = null): ?Form
             return null;
         }
 
-        $pageTemplateConfiguration = $this->pageService->getPageTemplateConfiguration($row['uid']);
-
         // If field is main field and "this page" has no selection or field is sub field and "subpages" has no selection
         if (($forField === self::FIELD_NAME_MAIN && empty($row[self::FIELD_ACTION_MAIN]))
             || ($forField === self::FIELD_NAME_SUB && empty($row[self::FIELD_ACTION_SUB]))
         ) {
             // The page inherits page layout from parent(s). Read the root line for the first page that defines a value
             // in the sub-action field, then use that record and resolve the Form used in the sub-configuration field.
+            // If the row is a new page, use the inherited form from the parent page.
+            $pageUid = $row['uid'] ?? 0;
+            $pageUidIsParent = false;
+            if (is_string($pageUid) && substr($pageUid, 0, 3) === 'NEW') {
+                $pageUid = $row['pid'] ?? 0;
+                $pageUidIsParent = true;
+            }
+
+            $pageTemplateConfiguration = $this->pageService->getPageTemplateConfiguration(
+                (integer) $pageUid,
+                $pageUidIsParent
+            );
+
             $form = parent::getForm($pageTemplateConfiguration['record_sub'] ?? $row, self::FIELD_NAME_SUB);
         } else {
             $form = parent::getForm($row, $forField);

diff --git a/Classes/Service/PageService.php b/Classes/Service/PageService.php
@@ -59,7 +59,7 @@ public function __construct(
      *
      * @api
      */
-    public function getPageTemplateConfiguration(int $pageUid): ?array
+    public function getPageTemplateConfiguration(int $pageUid, bool $pageUidIsParentUid = false): ?array
     {
         $pageUid = (integer) $pageUid;
         if (!$pageUid) {
@@ -81,12 +81,13 @@ public function getPageTemplateConfiguration(int $pageUid): ?array
         // Initialize with possibly-empty values and loop root line
         // to fill values as they are detected.
         foreach ($rootLine as $page) {
+            $rootLinePageUid = (integer) ($page['uid'] ?? 0);
             $mainFieldValue = $page[PageProvider::FIELD_ACTION_MAIN] ?? null;
             $subFieldValue = $page[PageProvider::FIELD_ACTION_SUB] ?? null;
             $resolvedMainTemplateIdentity = is_array($mainFieldValue) ? $mainFieldValue[0] : $mainFieldValue;
             $resolvedSubTemplateIdentity = is_array($subFieldValue) ? $subFieldValue[0] : $subFieldValue;
             $containsSubDefinition = (strpos($subFieldValue ?? '', '->') !== false);
-            $isCandidate = ((integer) ($page['uid'] ?? 0) !== $pageUid);
+            $isCandidate = $pageUidIsParentUid ? true : $rootLinePageUid !== $pageUid;
             if ($containsSubDefinition && $isCandidate) {
                 $resolvedSubTemplateIdentity = $subFieldValue;
                 $recordDefiningSub = $page;

diff --git a/Tests/Unit/Provider/PageProviderTest.php b/Tests/Unit/Provider/PageProviderTest.php
@@ -548,4 +548,66 @@ public function testGetControllerActionFromRecordReturnsDefaultIfActionIsEmpty()
         $subject->method('getControllerActionReferenceFromRecord')->willReturn('');
         self::assertSame('default', $subject->getControllerActionFromRecord(['uid' => 123]));
     }
+
+    /**
+     * @dataProvider getFormTestValues
+     */
+    public function testGetForm(array $row, ?string $forField, ?int $expectedLookupPageUid, ?Form $expectedReturn): void
+    {
+        $pageService = $this->getMockBuilder(PageService::class)
+            ->onlyMethods(['getPageTemplateConfiguration'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $subject = $this->getMockBuilder(PageProvider::class)
+            ->onlyMethods(['extractConfiguration', 'createCustomFormInstance'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->setInaccessiblePropertyValue($subject, 'pageService', $pageService);
+
+        if ($row['deleted'] ?? false) {
+            $pageService->expects(self::never())->method('getPageTemplateConfiguration');
+            $subject->expects(self::never())->method('extractConfiguration');
+        } elseif ($expectedLookupPageUid === null) {
+            $pageService->expects(self::never())->method('getPageTemplateConfiguration');
+            $subject->expects(self::once())->method('extractConfiguration')->willReturn($expectedReturn);
+        } else {
+            $fromParent = ['record_sub' => ['uid' => $expectedLookupPageUid]];
+            $pageService->expects(self::once())
+                ->method('getPageTemplateConfiguration')
+                ->with($expectedLookupPageUid)
+                ->willReturn($fromParent);
+            $subject->expects(self::once())
+                ->method('extractConfiguration')
+                ->with($fromParent['record_sub'])
+                ->willReturn($expectedReturn);
+        }
+        $output = $subject->getForm($row, $forField);
+        self::assertSame($expectedReturn, $output);
+    }
+
+    public function getFormTestValues(): array
+    {
+        $dummyForm = Form::create();
+        return [
+            'deleted page returns null early' => [['deleted' => 1], null, null, null],
+            'existing record uses inherited configuration' => [
+                ['uid' => 123],
+                PageProvider::FIELD_NAME_MAIN,
+                123,
+                $dummyForm
+            ],
+            'existing record and unspecified field does not look up inherited configuration' => [
+                ['uid' => 123],
+                null,
+                null,
+                $dummyForm
+            ],
+            'new record uses parent page form' => [
+                ['uid' => 'NEW123', 'pid' => 33],
+                PageProvider::FIELD_NAME_MAIN,
+                33,
+                $dummyForm
+            ],
+        ];
+    }
 }