[FEATURE] Introduce event to modify icon providers (#1582)

Co-authored-by: Benjamin Kott <benjamin.kott@outlook.com>

Author: buchmarv

Classes/Events/ModifyIconProvidersEvent.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the package bk2k/bootstrap-package.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace BK2K\BootstrapPackage\Events;
+
+use BK2K\BootstrapPackage\Icons\IconProviderInterface;
+
+final class ModifyIconProvidersEvent
+{
+    /**
+     * @param IconProviderInterface[] $iconProviders
+     */
+    public function __construct(
+        private array $iconProviders,
+    ) {
+    }
+
+    /**
+     * @return IconProviderInterface[]
+     */
+    public function getIconProviders(): array
+    {
+        return $this->iconProviders;
+    }
+
+    /**
+     * @param IconProviderInterface[] $iconProviders
+     */
+    public function setIconProviders(array $iconProviders): void
+    {
+        $this->iconProviders = $iconProviders;
+    }
+}

Classes/Icons/IconProviderInterface.php

@@ -9,9 +9,12 @@
 
 namespace BK2K\BootstrapPackage\Icons;
 
+use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
+
 /**
  * IconProviderInterface
  */
+#[AutoconfigureTag('bootstrapPackage.iconProvider')]
 interface IconProviderInterface
 {
     /**

Classes/Service/IconProviderService.php

@@ -0,0 +1,47 @@
+<?php
+declare(strict_types = 1);
+
+/*
+ * This file is part of the package bk2k/bootstrap-package.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace BK2K\BootstrapPackage\Service;
+
+use BK2K\BootstrapPackage\Events\ModifyIconProvidersEvent;
+use BK2K\BootstrapPackage\Icons\IconProviderInterface;
+use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
+
+final readonly class IconProviderService
+{
+    public function __construct(
+        #[AutowireIterator('bootstrapPackage.iconProvider')]
+        private iterable $iconProviders
+    ) {
+    }
+
+    public function __invoke(ModifyIconProvidersEvent $event): void
+    {
+        $classList = [];
+        $iconProviders = $event->getIconProviders();
+
+        // add already registered class names to prevent duplicate registration
+        array_walk($iconProviders, static function (IconProviderInterface $iconProvider) use (&$classList) {
+            $classList[] = get_class($iconProvider);
+        });
+
+        /** @var IconProviderInterface $iconProvider */
+        foreach ($this->iconProviders as $iconProvider) {
+            $className = get_class($iconProvider);
+            if (in_array($className, $classList, true)) {
+                continue;
+            }
+            $iconProviders[] = $iconProvider;
+            $classList[] = $className;
+        }
+
+        $event->setIconProviders($iconProviders);
+    }
+}

Classes/Service/IconService.php

@@ -10,14 +10,23 @@
 
 namespace BK2K\BootstrapPackage\Service;
 
+use BK2K\BootstrapPackage\Events\ModifyIconProvidersEvent;
 use BK2K\BootstrapPackage\Icons\IconProviderInterface;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * IconService
  */
 class IconService
 {
+    protected EventDispatcherInterface $eventDispatcher;
+
+    public function __construct()
+    {
+        $this->eventDispatcher = GeneralUtility::makeInstance(EventDispatcherInterface::class);
+    }
+
     public function getIconSetItems(array &$configuration): void
     {
         $iconSets = [];
@@ -84,6 +93,9 @@ public function getIconProviders(): array
             }
         }
 
-        return $iconProviders;
+        /** @var ModifyIconProvidersEvent $event */
+        $event = $this->eventDispatcher->dispatch(new ModifyIconProvidersEvent($iconProviders));
+
+        return $event->getIconProviders();
     }
 }

Configuration/Services.yaml

@@ -13,6 +13,12 @@ services:
         identifier: 'bk2k/bootstrap-package/set-backend-styling'
         event: TYPO3\CMS\Core\Package\Event\AfterPackageActivationEvent
 
+  BK2K\BootstrapPackage\Service\IconProviderService:
+    tags:
+      - name: event.listener
+        identifier: 'bk2k/bootstrap-package/modify-icon-providers'
+        event: BK2K\BootstrapPackage\Events\ModifyIconProvidersEvent
+
   BK2K\BootstrapPackage\Backend\ToolbarItem\VersionToolbarItem:
     tags:
       - name: event.listener

ext_localconf.php

@@ -54,12 +54,6 @@
         = \BK2K\BootstrapPackage\Hooks\PageRenderer\PreProcessHook::class . '->execute';
 }
 
-// Register icon provider
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/bootstrap-package/icons']['provider'][\BK2K\BootstrapPackage\Icons\IoniconsProvider::class]
-    = \BK2K\BootstrapPackage\Icons\IoniconsProvider::class;
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/bootstrap-package/icons']['provider'][\BK2K\BootstrapPackage\Icons\GlyphiconsProvider::class]
-    = \BK2K\BootstrapPackage\Icons\GlyphiconsProvider::class;
-
 // Add default RTE configuration for bootstrap package
 $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['bootstrap'] = 'EXT:bootstrap_package/Configuration/RTE/Default.yaml';