[TASK] Replace deprecated hook with event listener, code style fixes

Author: davkraid

Classes/Domain/DTO/Configuration.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the "Locate" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * Team YD <[email protected]>, Leuchtfeuer Digital Marketing
+ */
+
 namespace Leuchtfeuer\Locate\Domain\DTO;
 
 class Configuration
@@ -140,4 +149,4 @@ public function getSettings(): array
             'simulateIp' => $this->getSimulateIp(),
         ];
     }
-}
+}

Classes/Hook/OverrideIconOverlayHook.php Classes/EventListener/ModifyRecordOverlayIconIdentifierEventListener.php

@@ -9,19 +9,30 @@
  * Team YD <[email protected]>, Leuchtfeuer Digital Marketing
  */
 
-namespace Leuchtfeuer\Locate\Hook;
+namespace Leuchtfeuer\Locate\EventListener;
 
 use Doctrine\DBAL\Exception;
+use Leuchtfeuer\Locate\Utility\TypeCaster;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
 use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Imaging\Event\ModifyRecordOverlayIconIdentifierEvent;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-class OverrideIconOverlayHook
+final readonly class ModifyRecordOverlayIconIdentifierEventListener
 {
     /**
      * @throws Exception
      */
-    public function postOverlayPriorityLookup(string $table, array $row, array $status, string $iconName): string
+    #[AsEventListener(
+        identifier: 'locate/modify-record-overlay-icon-identifier',
+        event: ModifyRecordOverlayIconIdentifierEvent::class
+    )]
+    public function __invoke(ModifyRecordOverlayIconIdentifierEvent $event): void
     {
+        $table = $event->getTable();
+        $row = $event->getRow();
+        $iconName = $event->getOverlayIconIdentifier();
+
         if ($table === 'pages' && !empty($row) && !str_contains((string)$row['uid'], 'NEW')) {
             // since tx_locate_regions is not included in the row array (PageTreeRepository is initialized with empty additionalFields)
             // we need to get the necessary information on our own
@@ -40,10 +51,11 @@ public function postOverlayPriorityLookup(string $table, array $row, array $stat
             }
         }
 
-        return $iconName;
+        $event->setOverlayIconIdentifier($iconName);
     }
 
     /**
+     * @param array<string, mixed> $row
      * @throws Exception
      */
     private function countRegions(string $table, array $row): int
@@ -54,9 +66,9 @@ private function countRegions(string $table, array $row): int
 
         $qb = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
 
-        return (int)$qb
+        return TypeCaster::toInt($qb
             ->select('tx_locate_regions')
-            ->from($table)->where($qb->expr()->eq('uid', $row['uid']))->executeQuery()
-            ->fetchOne();
+            ->from($table)->where($qb->expr()->eq('uid', TypeCaster::toInt($row['uid'])))->executeQuery()
+            ->fetchOne());
     }
 }

Classes/Middleware/LanguageRedirectMiddleware.php

@@ -15,18 +15,14 @@
 
 use Leuchtfeuer\Locate\Domain\DTO\Configuration;
 use Leuchtfeuer\Locate\Processor\Court;
-use Leuchtfeuer\Locate\Verdict\Redirect;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
-use TYPO3\CMS\Backend\Routing\RouteResult;
 use TYPO3\CMS\Core\LinkHandling\Exception\UnknownLinkHandlerException;
 use TYPO3\CMS\Core\LinkHandling\LinkService;
 use TYPO3\CMS\Core\Routing\PageArguments;
-use TYPO3\CMS\Core\Routing\SiteRouteResult;
 use TYPO3\CMS\Core\Site\Entity\Site;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManager;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 
@@ -59,8 +55,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                 $config->setExcludeBots((bool)($locateSetup['excludeBots'] ?? 1));
                 $config->setSimulateIp((string)($locateSetup['simulateIp'] ?? ''));
                 $config->setJudges($locateSetup['judges.'] ?? []);
-                $config->setFacts( $locateSetup['facts.'] ?? []);
-                $config->setVerdicts( $locateSetup['verdicts.'] ?? []);
+                $config->setFacts($locateSetup['facts.'] ?? []);
+                $config->setVerdicts($locateSetup['verdicts.'] ?? []);
 
                 return $this->court->withConfiguration($config)->run() ?? $handler->handle($request);
             }

Classes/Processor/Court.php

@@ -38,10 +38,7 @@ class Court implements ProcessorInterface
      */
     protected array $facts = [];
 
-    public function __construct(private readonly LoggerInterface $logger)
-    {
-
-    }
+    public function __construct(private readonly LoggerInterface $logger) {}
 
     public function withConfiguration(Configuration $configuration): self
     {

Classes/Processor/ProcessorInterface.php

@@ -19,7 +19,6 @@
 
 interface ProcessorInterface
 {
-
     public function __construct(LoggerInterface $logger);
 
     public function withConfiguration(Configuration $configuration): self;

Classes/Utility/TypeCaster.php

@@ -2,9 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Leuchtfeuer\Locate\Utility;
+/*
+ * This file is part of the "Locate" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * Team YD <[email protected]>, Leuchtfeuer Digital Marketing
+ */
 
-use Exception;
+namespace Leuchtfeuer\Locate\Utility;
 
 class TypeCaster
 {
@@ -17,7 +24,7 @@ public static function toInt(mixed $value): int
             return (int)$value;
         }
 
-        throw new Exception(sprintf('Value of type "%s" can not be casted to integer.', gettype($value)), 1727337294);
+        throw new \Exception(sprintf('Value of type "%s" can not be casted to integer.', gettype($value)), 1727337294);
     }
 
     public static function toString(mixed $value): string
@@ -32,10 +39,10 @@ public static function toString(mixed $value): string
             return (string)$value;
         }
         if (is_object($value) && !method_exists($value, '__toString')) {
-            throw new Exception(sprintf('Object of type "%s" is not stringable.', get_class($value)), 1727337280);
+            throw new \Exception(sprintf('Object of type "%s" is not stringable.', get_class($value)), 1727337280);
         }
 
-        throw new Exception(sprintf('Value of type "%s" can not be casted to string.', gettype($value)), 1727337295);
+        throw new \Exception(sprintf('Value of type "%s" can not be casted to string.', gettype($value)), 1727337295);
     }
 
     public static function toBool(mixed $value): bool
@@ -47,14 +54,14 @@ public static function toBool(mixed $value): bool
             return (bool)$value;
         }
 
-        throw new Exception(sprintf('Value of type "%s" can not be casted to boolean.', gettype($value)), 1727337296);
+        throw new \Exception(sprintf('Value of type "%s" can not be casted to boolean.', gettype($value)), 1727337296);
     }
 
     /**
      * @template T
      * @param class-string<T> $className
      * @return T
-     * @throws Exception
+     * @throws \Exception
      */
     public static function limitToClass(mixed $value, string $className)
     {
@@ -63,21 +70,21 @@ public static function limitToClass(mixed $value, string $className)
         }
 
         if (gettype($value) === 'object') {
-            throw new Exception(sprintf('Object of type "%s" is not instance of "%s"', get_class($value), $className), 1727337297);
+            throw new \Exception(sprintf('Object of type "%s" is not instance of "%s"', get_class($value), $className), 1727337297);
         }
-        throw new Exception(sprintf('Value of type "%s" is not instance of "%s"', gettype($value), $className), 1727337298);
+        throw new \Exception(sprintf('Value of type "%s" is not instance of "%s"', gettype($value), $className), 1727337298);
     }
 
     /**
      * @return array<int|string, mixed>
-     * @throws Exception
+     * @throws \Exception
      */
     public static function limitToArray(mixed $value): array
     {
         if (is_array($value)) {
             return $value;
         }
 
-        throw new Exception(sprintf('Value of type "%s" is not an array.', gettype($value)), 1727337299);
+        throw new \Exception(sprintf('Value of type "%s" is not an array.', gettype($value)), 1727337299);
     }
 }

Classes/Verdict/AbstractVerdict.php

@@ -28,8 +28,7 @@ abstract class AbstractVerdict
 
     public function __construct(
         protected readonly LoggerInterface $logger,
-    )
-    {
+    ) {
         $this->session = new SessionStore();
     }
 

ext_tables.php

@@ -1,9 +1,2 @@
 <?php
 defined('TYPO3') || die('Access denied.');
-
-call_user_func(
-    function ($extensionKey) {
-        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][\TYPO3\CMS\Core\Imaging\IconFactory::class]['overrideIconOverlay'][$extensionKey]
-            = \Leuchtfeuer\Locate\Hook\OverrideIconOverlayHook::class;
-    }, 'locate'
-);

fractor.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the "Locate" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * Team YD <[email protected]>, Leuchtfeuer Digital Marketing
+ */
+
 use a9f\Fractor\Configuration\FractorConfiguration;
 use a9f\FractorTypoScript\Configuration\TypoScriptProcessorOption;
 use a9f\Typo3Fractor\Set\Typo3LevelSetList;
@@ -13,7 +22,7 @@
         __DIR__ . '/.Build',
     ])
     ->withSets([
-        Typo3LevelSetList::UP_TO_TYPO3_13
+        Typo3LevelSetList::UP_TO_TYPO3_13,
     ])
     ->withOptions([
         TypoScriptProcessorOption::INDENT_SIZE => 4,

rector.php

@@ -2,6 +2,15 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the "Locate" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * Team YD <[email protected]>, Leuchtfeuer Digital Marketing
+ */
+
 use Rector\Config\RectorConfig;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
 use Ssch\TYPO3Rector\Set\Typo3LevelSetList;
@@ -16,7 +25,7 @@
     )
     ->withPhpSets(php83: true)
     ->withRules([
-        TypedPropertyFromStrictConstructorRector::class
+        TypedPropertyFromStrictConstructorRector::class,
     ])
     ->withSets([
         Typo3SetList::CODE_QUALITY,