From 1ff4a177ca49a4cfb9b1662a137799abd874ff69 Mon Sep 17 00:00:00 2001
From: Sebastian Michaelsen <sebastian@michaelsen.io>
Date: Sat, 3 Aug 2024 18:20:09 +0200
Subject: [PATCH] feat: register component classes with custom PHP attribute

WIP: The generated TypoScript is loaded very early, before the TypoScript Sets from extensions. This way, at the moment we can *not* override the rendering from other extensions like fluid_styled_content.
Look if we can generate the TypoScript into the set of the host extension.
---
 .../Attribute/ComponentForContentElements.php | 15 ++++++
 .../CompilerPass/ComponentPass.php            | 48 +++++++++++++++++
 .../ContainerBuilding/ComponentRegistry.php   | 33 ++++++++++++
 .../ComponentRegistryEntry.php                | 30 +++++++++++
 .../AddComponentsToTypoScript.php             | 51 +++++++++++++++++++
 Configuration/Services.php                    | 21 ++++++++
 README.md                                     | 11 ++--
 7 files changed, 204 insertions(+), 5 deletions(-)
 create mode 100644 Classes/ContainerBuilding/Attribute/ComponentForContentElements.php
 create mode 100644 Classes/ContainerBuilding/CompilerPass/ComponentPass.php
 create mode 100644 Classes/ContainerBuilding/ComponentRegistry.php
 create mode 100644 Classes/ContainerBuilding/ComponentRegistryEntry.php
 create mode 100644 Classes/ContainerBuilding/EventListener/AddComponentsToTypoScript.php
 create mode 100644 Configuration/Services.php

diff --git a/Classes/ContainerBuilding/Attribute/ComponentForContentElements.php b/Classes/ContainerBuilding/Attribute/ComponentForContentElements.php
new file mode 100644
index 0000000..202e3d8
--- /dev/null
+++ b/Classes/ContainerBuilding/Attribute/ComponentForContentElements.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\ContainerBuilding\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class ComponentForContentElements
+{
+    public const TAG_NAME = 'webcomponents.forContentElements';
+
+    public function __construct(
+        public readonly string $cType,
+    ) {}
+}
diff --git a/Classes/ContainerBuilding/CompilerPass/ComponentPass.php b/Classes/ContainerBuilding/CompilerPass/ComponentPass.php
new file mode 100644
index 0000000..387d28d
--- /dev/null
+++ b/Classes/ContainerBuilding/CompilerPass/ComponentPass.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\ContainerBuilding\CompilerPass;
+
+use Sinso\Webcomponents\ContainerBuilding\ComponentRegistry;
+use Sinso\Webcomponents\ContainerBuilding\ComponentRegistryEntry;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class ComponentPass implements CompilerPassInterface
+{
+    public function __construct(
+        private readonly string $tagName
+    ) {}
+
+    public function process(ContainerBuilder $container): void
+    {
+        $componentRegistryEntries = $this->collectComponentRegistryEntries($container);
+        $componentRegistryDefinition = $container->findDefinition(ComponentRegistry::class);
+        foreach ($componentRegistryEntries as $componentRegistryEntry) {
+            $componentRegistryDefinition->addMethodCall(
+                'registerComponent',
+                [
+                    $componentRegistryEntry->componentClassname,
+                    $componentRegistryEntry->getCTypes(),
+                ]
+            );
+        }
+    }
+
+    /**
+     * @return iterable<ComponentRegistryEntry>
+     */
+    private function collectComponentRegistryEntries(ContainerBuilder $container): iterable
+    {
+        $componentClasses = [];
+        foreach ($container->findTaggedServiceIds($this->tagName) as $serviceName => $tags) {
+            $componentRegistryEntry = new ComponentRegistryEntry($serviceName);
+            foreach ($tags as $attribute) {
+                $componentRegistryEntry->addCType($attribute['cType']);
+            }
+            $componentClasses[] = $componentRegistryEntry;
+        }
+        return $componentClasses;
+    }
+}
diff --git a/Classes/ContainerBuilding/ComponentRegistry.php b/Classes/ContainerBuilding/ComponentRegistry.php
new file mode 100644
index 0000000..430f928
--- /dev/null
+++ b/Classes/ContainerBuilding/ComponentRegistry.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\ContainerBuilding;
+
+class ComponentRegistry
+{
+    /**
+     * @var array<ComponentRegistryEntry>
+     */
+    private array $componentRegistryEntries = [];
+
+    /**
+     * @param iterable<int, string> $cTypes
+     */
+    public function registerComponent(string $serviceClassName, iterable $cTypes): void
+    {
+        $componentRegistryEntry = new ComponentRegistryEntry($serviceClassName);
+        foreach ($cTypes as $cType) {
+            $componentRegistryEntry->addCType($cType);
+        }
+        $this->componentRegistryEntries[] = $componentRegistryEntry;
+    }
+
+    /**
+     * @return iterable<ComponentRegistryEntry>
+     */
+    public function getComponentRegistryEntries(): iterable
+    {
+        return $this->componentRegistryEntries;
+    }
+}
diff --git a/Classes/ContainerBuilding/ComponentRegistryEntry.php b/Classes/ContainerBuilding/ComponentRegistryEntry.php
new file mode 100644
index 0000000..64c735b
--- /dev/null
+++ b/Classes/ContainerBuilding/ComponentRegistryEntry.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\ContainerBuilding;
+
+class ComponentRegistryEntry
+{
+    /**
+     * @var array<string> $cTypes
+     */
+    private array $cTypes = [];
+
+    public function __construct(
+        public readonly string $componentClassname,
+    ) {}
+
+    public function addCType(string $cType): void
+    {
+        $this->cTypes[] = $cType;
+    }
+
+    /**
+     * @return iterable<string>
+     */
+    public function getCTypes(): iterable
+    {
+        return $this->cTypes;
+    }
+}
diff --git a/Classes/ContainerBuilding/EventListener/AddComponentsToTypoScript.php b/Classes/ContainerBuilding/EventListener/AddComponentsToTypoScript.php
new file mode 100644
index 0000000..089c092
--- /dev/null
+++ b/Classes/ContainerBuilding/EventListener/AddComponentsToTypoScript.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinso\Webcomponents\ContainerBuilding\EventListener;
+
+use Sinso\Webcomponents\ContainerBuilding\ComponentRegistry;
+use Sinso\Webcomponents\ContainerBuilding\ComponentRegistryEntry;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+use TYPO3\CMS\Core\Core\Event\BootCompletedEvent;
+use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
+
+#[AsEventListener(identifier: 'webcomponents/addComponentsToTypoScript')]
+class AddComponentsToTypoScript
+{
+    public function __invoke(BootCompletedEvent $event): void
+    {
+        ExtensionManagementUtility::addTypoScriptSetup($this->generateTypoScript());
+    }
+
+    public function __construct(
+        private readonly ComponentRegistry $componentRegistry,
+    ) {}
+
+    private function generateTypoScript(): string
+    {
+        $typoScript = '';
+        foreach ($this->componentRegistry->getComponentRegistryEntries() as $entry) {
+            $typoScript .= $this->generateTypoScriptForComponent($entry);
+        }
+        return $typoScript;
+    }
+
+    private function generateTypoScriptForComponent(ComponentRegistryEntry $entry): string
+    {
+        $typoScript = '';
+        foreach ($entry->getCTypes() as $cType) {
+            $typoScript .= $this->generateTypoScriptForCType($entry, $cType);
+        }
+        return $typoScript;
+    }
+
+    private function generateTypoScriptForCType(ComponentRegistryEntry $entry, string $cType): string
+    {
+        return <<<TYPOSCRIPT
+tt_content.{$cType} >
+tt_content.{$cType} = WEBCOMPONENT
+tt_content.{$cType}.component = {$entry->componentClassname}
+TYPOSCRIPT;
+    }
+}
diff --git a/Configuration/Services.php b/Configuration/Services.php
new file mode 100644
index 0000000..7dc3df7
--- /dev/null
+++ b/Configuration/Services.php
@@ -0,0 +1,21 @@
+<?php
+
+use Sinso\Webcomponents\ContainerBuilding\Attribute\ComponentForContentElements;
+use Sinso\Webcomponents\ContainerBuilding\CompilerPass\ComponentPass;
+use Symfony\Component\DependencyInjection\ChildDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $container, ContainerBuilder $containerBuilder) {
+    $containerBuilder->registerAttributeForAutoconfiguration(
+        ComponentForContentElements::class,
+        static function (ChildDefinition $definition, ComponentForContentElements $attribute, \Reflector $reflector): void {
+            $definition->addTag(
+                ComponentForContentElements::TAG_NAME,
+                ['cType' => $attribute->cType]
+            );
+        }
+    );
+
+    $containerBuilder->addCompilerPass(new ComponentPass(ComponentForContentElements::TAG_NAME));
+};
diff --git a/README.md b/README.md
index ea3fbb9..772ffaf 100644
--- a/README.md
+++ b/README.md
@@ -28,20 +28,17 @@ Generates the output:
 
 You can populate the web component with PHP:
 
-```
-tt_content.tx_myext_mycontentelement = WEBCOMPONENT
-tt_content.tx_myext_mycontentelement.component = Acme\MyExt\Components\MyContentElement
-```
-
 ```php
 <?php
 
 namespace Acme\MyExt\Components;
 
+use Sinso\Webcomponents\ContainerBuilding\Attribute\ComponentForContentElements;
 use Sinso\Webcomponents\DataProviding\ComponentInterface;
 use Sinso\Webcomponents\DataProviding\Traits\ContentObjectRendererTrait;
 use Sinso\Webcomponents\Dto\ComponentRenderingData;
 
+#[ComponentForContentElements(cType: 'tx_myext_my-content-element')]
 class MyContentElement implements ComponentInterface
 {
     use ContentObjectRendererTrait;
@@ -60,6 +57,8 @@ class MyContentElement implements ComponentInterface
 }
 ```
 
+The `#[ComponentForContentElements]` attribute will take care of setting up the necessary TypoScript in the background. 
+
 ## Abort rendering
 
 The component classes can use the `\Sinso\Webcomponents\DataProviding\Traits\Assert` trait to abort rendering, for example if the record is not available:
@@ -69,6 +68,7 @@ The component classes can use the `\Sinso\Webcomponents\DataProviding\Traits\Ass
 
 namespace Acme\MyExt\Components;
 
+use Sinso\Webcomponents\ContainerBuilding\Attribute\ComponentForContentElements;
 use Sinso\Webcomponents\DataProviding\ComponentInterface;
 use Sinso\Webcomponents\DataProviding\Traits\Assert;
 use Sinso\Webcomponents\DataProviding\Traits\ContentObjectRendererTrait;
@@ -76,6 +76,7 @@ use Sinso\Webcomponents\DataProviding\Traits\FileReferences;
 use Sinso\Webcomponents\Dto\ComponentRenderingData;
 use TYPO3\CMS\Core\Resource\FileReference;
 
+#[ComponentForContentElements(cType: 'image')]
 class Image implements ComponentInterface
 {
     use Assert;