feat: allow for custom implementations of component rendering data

sinso · Sep 9, 2024 · fda25e5 · fda25e5
1 parent b56e842
commit fda25e5
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 10 deletions.
diff --git a/Classes/ContentObject/WebcomponentContentObject.php b/Classes/ContentObject/WebcomponentContentObject.php
@@ -7,6 +7,7 @@
 use Sinso\Webcomponents\DataProviding\AssertionFailedException;
 use Sinso\Webcomponents\DataProviding\ComponentInterface;
 use Sinso\Webcomponents\Dto\ComponentRenderingData;
+use Sinso\Webcomponents\Dto\ComponentRenderingDataInterface;
 use Sinso\Webcomponents\Dto\Events\ComponentWillBeRendered;
 use Sinso\Webcomponents\Dto\InputData;
 use Sinso\Webcomponents\Rendering\ComponentRenderer;
@@ -77,7 +78,7 @@ public function render($conf = []): string
     /**
      * @param array<string, mixed> $conf
      */
-    private function evaluateTypoScriptConfiguration(ComponentRenderingData $componentRenderingData, array $conf): ComponentRenderingData
+    private function evaluateTypoScriptConfiguration(ComponentRenderingData $componentRenderingData, array $conf): ComponentRenderingDataInterface
     {
         if (is_array($conf['properties.'] ?? null)) {
             foreach ($conf['properties.'] as $key => $value) {
@@ -94,12 +95,9 @@ private function evaluateTypoScriptConfiguration(ComponentRenderingData $compone
         return $componentRenderingData;
     }
 
-    private function renderMarkup(ComponentRenderingData $componentRenderingData): string
+    private function renderMarkup(ComponentRenderingDataInterface $componentRenderingData): string
     {
         $tagName = $componentRenderingData->getTagName();
-        if ($tagName === null) {
-            throw new AssertionFailedException('No tag name provided', 1722672898);
-        }
         $content = $componentRenderingData->getTagContent();
         $properties = $componentRenderingData->getTagProperties();
 

diff --git a/Classes/Dto/ComponentRenderingData.php b/Classes/Dto/ComponentRenderingData.php
@@ -4,7 +4,9 @@
 
 namespace Sinso\Webcomponents\Dto;
 
-class ComponentRenderingData
+use Sinso\Webcomponents\DataProviding\AssertionFailedException;
+
+class ComponentRenderingData implements ComponentRenderingDataInterface, TagPropertiesSettable, TagContentSettable, TagNameSettable
 {
     private ?string $tagContent = null;
     private ?string $tagName = null;
@@ -44,8 +46,11 @@ public function setTagProperties(array $tagProperties): void
         $this->tagProperties = $tagProperties;
     }
 
-    public function getTagName(): ?string
+    public function getTagName(): string
     {
+        if ($this->tagName === null) {
+            throw new AssertionFailedException('No tag name provided', 1722672898);
+        }
         return $this->tagName;
     }
 

diff --git a/Classes/Dto/ComponentRenderingDataInterface.php b/Classes/Dto/ComponentRenderingDataInterface.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Sinso\Webcomponents\Dto;
+
+interface ComponentRenderingDataInterface
+{
+    public function getTagContent(): ?string;
+
+    /**
+     * @return array<string, mixed>|null
+     */
+    public function getTagProperties(): ?array;
+
+    public function getTagName(): string;
+}
diff --git a/Classes/Dto/Events/ComponentWillBeRendered.php b/Classes/Dto/Events/ComponentWillBeRendered.php
@@ -5,6 +5,7 @@
 namespace Sinso\Webcomponents\Dto\Events;
 
 use Sinso\Webcomponents\Dto\ComponentRenderingData;
+use Sinso\Webcomponents\Dto\ComponentRenderingDataInterface;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 
 /**
@@ -16,6 +17,6 @@ class ComponentWillBeRendered
 {
     public function __construct(
         public readonly ContentObjectRenderer $contentObjectRenderer,
-        public readonly ComponentRenderingData $componentRenderingData,
+        public readonly ComponentRenderingDataInterface $componentRenderingData,
     ) {}
 }
diff --git a/Classes/Dto/TagContentSettable.php b/Classes/Dto/TagContentSettable.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\Dto;
+
+interface TagContentSettable
+{
+    public function setTagContent(?string $tagContent): void;
+}
diff --git a/Classes/Dto/TagNameSettable.php b/Classes/Dto/TagNameSettable.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\Dto;
+
+interface TagNameSettable
+{
+    public function setTagName(string $tagName): void;
+}
diff --git a/Classes/Dto/TagPropertiesSettable.php b/Classes/Dto/TagPropertiesSettable.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\Dto;
+
+interface TagPropertiesSettable
+{
+    public function setTagProperty(string $key, mixed $value): void;
+
+    public function setTagProperties(array $tagProperties): void;
+}
diff --git a/Classes/Rendering/ComponentRenderer.php b/Classes/Rendering/ComponentRenderer.php
@@ -19,15 +19,15 @@ class ComponentRenderer
     /**
      * @param array<string, mixed> $properties
      */
-    public function renderComponent(string $tagName, ?string $content, array $properties): string
+    public function renderComponent(string $tagName, ?string $content, ?array $properties): string
     {
         /** @var TagBuilder $tagBuilder */
         $tagBuilder = GeneralUtility::makeInstance(TagBuilder::class);
         $tagBuilder->setTagName($tagName);
         if (!empty($content)) {
             $tagBuilder->setContent($content);
         }
-        foreach ($properties as $key => $value) {
+        foreach ($properties ?? [] as $key => $value) {
             if ($value === null) {
                 continue;
             }