[TASK] Migrate toolbar item to event listener, migrate icon registration code, drop compatibility with TYPO3 9 and 10

Author: Francois Suter

Classes/Toolbar/ToolbarItem.php …ses/EventListener/ClearCacheListener.phpClasses/Toolbar/ToolbarItem.php renamed to Classes/EventListener/ClearCacheListener.php Classes/Toolbar/ToolbarItem.php renamed to Classes/EventListener/ClearCacheListener.php

@@ -1,7 +1,8 @@
 <?php
+
 declare(strict_types=1);
 
-namespace Cobweb\FlushLanguageCache\Toolbar;
+namespace Cobweb\FlushLanguageCache\EventListener;
 
 /**
  * This file is part of the TYPO3 CMS project.
@@ -16,27 +17,26 @@
  * The TYPO3 project - inspiring people to share!
  */
 
+use TYPO3\CMS\Backend\Backend\Event\ModifyClearCacheActionsEvent;
 use TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException;
 use TYPO3\CMS\Backend\Routing\UriBuilder;
-use TYPO3\CMS\Backend\Toolbar\ClearCacheActionsHookInterface;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Prepares additional flush cache entry.
  */
-class ToolbarItem implements ClearCacheActionsHookInterface
+class ClearCacheListener
 {
-    static public $itemKey = 'flushLanguageCache';
+    static public string $itemKey = 'flushLanguageCache';
 
     /**
      * Adds the flush language cache menu item.
      *
-     * @param array $cacheActions Array of CacheMenuItems
-     * @param array $optionValues Array of AccessConfigurations-identifiers (typically used by userTS with options.clearCache.identifier)
+     * @param ModifyClearCacheActionsEvent $event
      * @return void
      */
-    public function manipulateCacheActions(&$cacheActions, &$optionValues)
+    public function __invoke(ModifyClearCacheActionsEvent $event): void
     {
         // First check if user has right to access the flush language cache item
         $tsConfig = $this->getBackendUser()->getTSConfig();
@@ -46,14 +46,16 @@ public function manipulateCacheActions(&$cacheActions, &$optionValues)
             $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
             try {
                 $uri = $uriBuilder->buildUriFromRoute('flushLanguageCache');
-                $cacheActions[] = [
+                $event->addCacheAction(
+                    [
                         'id' => self::$itemKey,
                         'title' => 'LLL:EXT:flush_language_cache/Resources/Private/Language/locallang.xlf:flushLanguageCache',
                         'description' => 'LLL:EXT:flush_language_cache/Resources/Private/Language/locallang.xlf:flushLanguageCache.description',
                         'href' => $uri,
                         'iconIdentifier' => 'tx_flushlanguagecache_flush'
-                ];
-                $optionValues[] = self::$itemKey;
+                    ]
+                );
+                $event->addCacheActionIdentifier(self::$itemKey);
             } catch (RouteNotFoundException $e) {
                 // Do nothing, i.e. do not add the menu item if the AJAX route cannot be found
             }
@@ -69,4 +71,4 @@ protected function getBackendUser(): BackendUserAuthentication
     {
         return $GLOBALS['BE_USER'];
     }
-}
+}

Configuration/Icons.php

@@ -0,0 +1,7 @@
+<?php
+return [
+    'tx_flushlanguagecache_flush' => [
+        'provider' => TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
+        'source' => 'EXT:flush_language_cache/Resources/Public/Icons/FlushCache.svg'
+    ],
+];

Configuration/Services.yaml

@@ -14,3 +14,8 @@ services:
         command: 'languagecache:flush'
         description: 'Clears the language cache (l10n).'
         schedulable: true
+
+  Cobweb\FlushLanguageCache\EventListener\ClearCacheListener:
+    tags:
+      - name: event.listener
+        identifier: 'flush-language-cache/flush'

Resources/Public/Icons/FlushCache.svg

@@ -2,7 +2,6 @@
 	"name": "cobweb/flush_language_cache",
 	"type": "typo3-cms-extension",
 	"description": "Adds an item to the flush cache menu to clear just the language (l10n) cache. Also provides a command-line tool for that.",
-	"version": "3.0.2",
 	"license": [
 		"GPL-2.0+"
 	],
@@ -18,8 +17,8 @@
 		}
 	},
 	"require": {
-		"php": ">=7.2.0",
-		"typo3/cms-core": ">=9.5.0,<12.0"
+		"php": ">=7.4.0",
+		"typo3/cms-core": "^11.5 || ^12.0"
 	},
 	"replace": {
 		"typo3-ter/flush_language_cache": "self.version"

composer.json

@@ -18,8 +18,8 @@
         'version' => '3.0.2',
         'constraints' => [
                 'depends' => [
-                        'typo3' => '9.5.0-11.5.99',
-                        'php' => '7.2.0-8.0.99'
+                        'typo3' => '11.5.0-12.9.99',
+                        'php' => '7.4.0-8.1.99'
                 ],
                 'conflicts' => [],
                 'suggests' => [],