feat: register additional properties during compile time

The old way to register additional properties with the PSR-14 event
"RegisterAdditionalTypePropertiesEvent" is deprecated.

Author: brotkrueml

CHANGELOG.md

@@ -7,6 +7,12 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+- Registration of additional properties by implementing `AdditionalPropertiesInterface`
+
+### Deprecated
+- PSR-14 event `RegisterAdditionalTypePropertiesEvent`
+
 ### Fixed
 - Additional properties cache is not cleared when flushing the cache
 

Classes/Core/AdditionalPropertiesInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "schema" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Brotkrueml\Schema\Core;
+
+/**
+ * @api
+ */
+interface AdditionalPropertiesInterface
+{
+    /**
+     * @return non-empty-string
+     */
+    public function getType(): string;
+
+    /**
+     * @return list<non-empty-string>
+     */
+    public function getAdditionalProperties(): array;
+}

Classes/Core/Model/AbstractType.php

@@ -14,6 +14,7 @@
 use Brotkrueml\Schema\Attributes\Type;
 use Brotkrueml\Schema\Event\RegisterAdditionalTypePropertiesEvent;
 use Brotkrueml\Schema\Extension;
+use Brotkrueml\Schema\Type\AdditionalPropertiesProvider;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Cache\CacheManager;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
@@ -58,14 +59,24 @@ protected function addAdditionalProperties(): void
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache(Extension::CACHE_IDENTIFIER);
         $additionalProperties = $cache->get($cacheEntryIdentifier);
         if ($additionalProperties === false) {
-            $event = new RegisterAdditionalTypePropertiesEvent(static::class);
+            /** @var AdditionalPropertiesProvider $additionalPropertiesProvider */
+            $additionalPropertiesProvider = GeneralUtility::makeInstance(AdditionalPropertiesProvider::class);
+            $additionalProperties = $additionalPropertiesProvider->getForType($this->getType());
 
+            $event = new RegisterAdditionalTypePropertiesEvent(static::class);
             /** @var EventDispatcherInterface $eventDispatcher */
             $eventDispatcher = GeneralUtility::makeInstance(EventDispatcherInterface::class);
             /** @var RegisterAdditionalTypePropertiesEvent $event */
             $event = $eventDispatcher->dispatch($event);
+            if ($event->haveAdditionalPropertiesRegistered()) {
+                $message = \sprintf(
+                    'Using the RegisterAdditionalTypePropertiesEvent for "%s" is deprecated since EXT:schema version 3.10.0, it will be removed in version 4.0.0. To register additional properties create a class implementing AdditionalPropertiesInterface. Consult the docs for details.',
+                    $this->getType(),
+                );
+                \trigger_error($message, \E_USER_DEPRECATED);
+            }
 
-            $additionalProperties = $event->getAdditionalProperties();
+            $additionalProperties = [...$additionalProperties, ...$event->getAdditionalProperties()];
             $cache->set($cacheEntryIdentifier, $additionalProperties, [], 0);
         }
 

Classes/DependencyInjection/AdditionalPropertiesPass.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "schema" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Brotkrueml\Schema\DependencyInjection;
+
+use Brotkrueml\Schema\Type\AdditionalPropertiesProvider;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @internal
+ */
+final class AdditionalPropertiesPass implements CompilerPassInterface
+{
+    public function __construct(
+        private readonly string $tagName,
+    ) {}
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (! $container->hasDefinition(AdditionalPropertiesProvider::class)) {
+            return;
+        }
+
+        $providerDefinition = $container->getDefinition(AdditionalPropertiesProvider::class)->setPublic(true);
+        foreach (\array_keys($container->findTaggedServiceIds($this->tagName)) as $id) {
+            $providerDefinition->addMethodCall('add', [$id]);
+        }
+    }
+}

Classes/Event/RegisterAdditionalTypePropertiesEvent.php

@@ -11,12 +11,16 @@
 
 namespace Brotkrueml\Schema\Event;
 
+/**
+ * @deprecated since 3.10.0, will be removed in 4.0.0. To register additional properties create a class implementing AdditionalPropertiesInterface. Consult the docs for details.
+ */
 final class RegisterAdditionalTypePropertiesEvent
 {
     /**
      * @var list<string>
      */
     private array $additionalProperties = [];
+    private bool $haveAdditionalPropertiesRegistered = false;
 
     public function __construct(
         private readonly string $type,
@@ -39,6 +43,15 @@ public function registerAdditionalProperty(string $propertyName): void
     {
         if (! \in_array($propertyName, $this->additionalProperties, true)) {
             $this->additionalProperties[] = $propertyName;
+            $this->haveAdditionalPropertiesRegistered = true;
         }
     }
+
+    /**
+     * @internal
+     */
+    public function haveAdditionalPropertiesRegistered(): bool
+    {
+        return $this->haveAdditionalPropertiesRegistered;
+    }
 }