TASK: Add TYPO3 13 compatibility

sabbelasichon · Oct 20, 2024 · 44d08e0 · 44d08e0
1 parent 3ea7a5a
commit 44d08e0
Show file tree

Hide file tree

Showing 52 changed files with 236 additions and 391 deletions.
diff --git a/.github/workflows/coding_standard.yaml b/.github/workflows/coding_standard.yaml
@@ -15,7 +15,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-versions: [ 7.4, 8.0, 8.1 ]
+                php-versions: [ 8.1 ]
         steps:
             -   uses: actions/checkout@v4
 

diff --git a/.github/workflows/php_linter.yaml b/.github/workflows/php_linter.yaml
@@ -15,7 +15,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-versions: [ 7.4, 8.0, 8.1 ]
+                php-versions: [ 8.1, 8.2, 8.3 ]
         steps:
             -   uses: actions/checkout@v4
 

diff --git a/.github/workflows/phpstan.yaml b/.github/workflows/phpstan.yaml
@@ -18,7 +18,7 @@ jobs:
 
             -   uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 7.4
+                    php-version: 8.1
                     coverage: none
                 env:
                     COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -16,9 +16,8 @@ jobs:
         strategy:
             matrix:
                 typo3-php-versions:
-                    - { typo3: 10, php: 7.4 }
-                    - { typo3: 11, php: 7.4 }
                     - { typo3: 12, php: 8.1 }
+                    - { typo3: 13, php: 8.1 }
 
         name: "Run tests with PHP ${{ matrix.typo3-php-versions.php }} using TYPO3 ${{ matrix.typo3-php-versions.typo3 }}"
         steps:

diff --git a/Build/FunctionalTests.xml b/Build/FunctionalTests.xml
@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="true" bootstrap="../.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTestsBootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory>../Classes/</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="true" bootstrap="../.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTestsBootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd">
   <testsuites>
     <testsuite name="typo3_encore tests">
       <directory>../Tests/Functional/</directory>
     </testsuite>
   </testsuites>
+  <source>
+    <include>
+      <directory>../Classes/</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/Build/UnitTests.xml b/Build/UnitTests.xml
@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="true" bootstrap="../.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTestsBootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory>../Classes/</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="true" bootstrap="../.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTestsBootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd">
   <testsuites>
     <testsuite name="typo3_encore tests">
       <directory>../Tests/Unit/</directory>
     </testsuite>
   </testsuites>
+  <source>
+    <include>
+      <directory>../Classes/</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/Classes/Asset/EntrypointLookup.php b/Classes/Asset/EntrypointLookup.php
@@ -20,26 +20,20 @@ final class EntrypointLookup implements EntrypointLookupInterface, IntegrityData
 {
     private ?array $entriesData = null;
 
-    private string $entrypointJsonPath;
+    private readonly string $entrypointJsonPath;
 
     private array $returnedFiles = [];
 
-    private JsonDecoderInterface $jsonDecoder;
-
-    private FilesystemInterface $filesystem;
-
-    private bool $strictMode;
+    private readonly FilesystemInterface $filesystem;
 
     public function __construct(
         string $entrypointJsonPath,
-        bool $strictMode,
-        JsonDecoderInterface $jsonDecoder,
+        private readonly bool $strictMode,
+        private readonly JsonDecoderInterface $jsonDecoder,
         FilesystemInterface $filesystem
     ) {
         $this->entrypointJsonPath = $filesystem->getFileAbsFileName($entrypointJsonPath);
-        $this->jsonDecoder = $jsonDecoder;
         $this->filesystem = $filesystem;
-        $this->strictMode = $strictMode;
     }
 
     public function getJavaScriptFiles(string $entryName): array
@@ -127,7 +121,7 @@ private function getEntriesData(): array
 
         try {
             $this->entriesData = $this->jsonDecoder->decode($this->filesystem->get($this->entrypointJsonPath));
-        } catch (JsonDecodeException $e) {
+        } catch (JsonDecodeException) {
             throw new InvalidArgumentException(sprintf(
                 'There was a problem JSON decoding the "%s" file',
                 $this->entrypointJsonPath

diff --git a/Classes/Asset/EntrypointLookupCollection.php b/Classes/Asset/EntrypointLookupCollection.php
@@ -15,19 +15,15 @@
 
 class EntrypointLookupCollection implements EntrypointLookupCollectionInterface
 {
-    private EntryLookupFactoryInterface $entryLookupFactory;
-
     /**
      * @var array|EntrypointLookupInterface[]
      */
     private ?array $buildEntrypoints = null;
 
-    private ?string $defaultBuildName;
-
-    public function __construct(EntryLookupFactoryInterface $entryLookupFactory, string $defaultBuildName = null)
-    {
-        $this->entryLookupFactory = $entryLookupFactory;
-        $this->defaultBuildName = $defaultBuildName;
+    public function __construct(
+        private readonly EntryLookupFactoryInterface $entryLookupFactory,
+        private readonly ?string $defaultBuildName = null
+    ) {
     }
 
     public function getEntrypointLookup(string $buildName = null): EntrypointLookupInterface

diff --git a/Classes/Asset/TagRenderer.php b/Classes/Asset/TagRenderer.php
@@ -25,15 +25,11 @@
 
 final class TagRenderer implements TagRendererInterface
 {
-    private EntrypointLookupCollectionInterface $entrypointLookupCollection;
-
-    private AssetRegistryInterface $assetRegistry;
-
     private ?ApplicationType $applicationType = null;
 
     public function __construct(
-        EntrypointLookupCollectionInterface $entrypointLookupCollection,
-        AssetRegistryInterface $assetRegistry
+        private readonly EntrypointLookupCollectionInterface $entrypointLookupCollection,
+        private readonly AssetRegistryInterface $assetRegistry
     ) {
         try {
             $this->applicationType = array_key_exists(
@@ -42,12 +38,9 @@ public function __construct(
             ) && $GLOBALS['TYPO3_REQUEST'] instanceof ServerRequestInterface ? ApplicationType::fromRequest(
                 $GLOBALS['TYPO3_REQUEST']
             ) : null;
-        } catch (RuntimeException $e) {
+        } catch (RuntimeException) {
             $this->applicationType = null;
         }
-
-        $this->entrypointLookupCollection = $entrypointLookupCollection;
-        $this->assetRegistry = $assetRegistry;
     }
 
     public function renderWebpackScriptTags(ScriptTag $scriptTag): void
@@ -71,7 +64,7 @@ public function renderWebpackScriptTags(ScriptTag $scriptTag): void
             // To do this, it's split up into two parts. The first part wraps the first file
             // and the second part wraps the last file.
             $splitChar = ! empty($parameters['splitChar']) ? $parameters['splitChar'] : '|';
-            $wrapArr = explode($splitChar, $parameters['allWrap'], 2);
+            $wrapArr = explode($splitChar, (string) $parameters['allWrap'], 2);
             $wrapFirst = $wrapArr[0] . $splitChar;
             $wrapLast = $splitChar . $wrapArr[1];
             unset($parameters['allWrap']);
@@ -93,7 +86,7 @@ public function renderWebpackScriptTags(ScriptTag $scriptTag): void
             }
 
             $attributes = array_replace([
-                'file' => $this->removeLeadingSlash($file, $parameters) ? ltrim($file, '/') : $file,
+                'file' => $this->removeLeadingSlash($file, $parameters) ? ltrim((string) $file, '/') : $file,
                 'type' => $this->removeType($parameters) ? '' : 'text/javascript',
                 'compress' => false,
                 'forceOnTop' => false,
@@ -112,7 +105,7 @@ public function renderWebpackScriptTags(ScriptTag $scriptTag): void
 
             if ($scriptTag->isLibrary()) {
                 $pageRendererMethodName .= 'Library';
-                $filename = basename($file);
+                $filename = basename((string) $file);
                 $pageRenderer->{$pageRendererMethodName}($filename, ...$attributes);
             } else {
                 $pageRendererMethodName .= 'File';
@@ -146,7 +139,7 @@ public function renderWebpackLinkTags(LinkTag $linkTag): void
             // To do this, it's split up into two parts. The first part wraps the first file
             // and the second part wraps the last file.
             $splitChar = ! empty($parameters['splitChar']) ? $parameters['splitChar'] : '|';
-            $wrapArr = explode($splitChar, $parameters['allWrap'], 2);
+            $wrapArr = explode($splitChar, (string) $parameters['allWrap'], 2);
             $wrapFirst = $wrapArr[0] . $splitChar;
             $wrapLast = $splitChar . $wrapArr[1];
             unset($parameters['allWrap']);
@@ -165,7 +158,7 @@ public function renderWebpackLinkTags(LinkTag $linkTag): void
             }
 
             $attributes = array_replace([
-                'file' => $this->removeLeadingSlash($file, $parameters) ? ltrim($file, '/') : $file,
+                'file' => $this->removeLeadingSlash($file, $parameters) ? ltrim((string) $file, '/') : $file,
                 'rel' => 'stylesheet',
                 'media' => $linkTag->getMedia(),
                 'title' => '',

diff --git a/Classes/Form/FormDataProvider/RichtextEncoreConfiguration.php b/Classes/Form/FormDataProvider/RichtextEncoreConfiguration.php
@@ -19,7 +19,7 @@
 
 final class RichtextEncoreConfiguration implements FormDataProviderInterface
 {
-    private EntrypointLookupCollectionInterface $entrypointLookupCollection;
+    private readonly EntrypointLookupCollectionInterface $entrypointLookupCollection;
 
     public function __construct(EntrypointLookupCollectionInterface $entrypointLookupCollection = null)
     {

diff --git a/Classes/Integration/AssetRegistry.php b/Classes/Integration/AssetRegistry.php
@@ -20,11 +20,9 @@ final class AssetRegistry implements AssetRegistryInterface
 
     private array $defaultAttributes = [];
 
-    private SettingsServiceInterface $settingsService;
-
-    public function __construct(SettingsServiceInterface $settingsService)
-    {
-        $this->settingsService = $settingsService;
+    public function __construct(
+        private readonly SettingsServiceInterface $settingsService
+    ) {
         $this->reset();
     }
 

diff --git a/Classes/Integration/EntryLookupFactory.php b/Classes/Integration/EntryLookupFactory.php
@@ -16,25 +16,16 @@
 
 final class EntryLookupFactory implements EntryLookupFactoryInterface
 {
-    private SettingsServiceInterface $settingsService;
-
-    private FilesystemInterface $filesystem;
-
     /**
      * @var array|EntrypointLookupInterface[]
      */
     private static ?array $collection = null;
 
-    private JsonDecoderInterface $jsonDecoder;
-
     public function __construct(
-        SettingsServiceInterface $settingsService,
-        FilesystemInterface $filesystem,
-        JsonDecoderInterface $jsonDecoder
+        private readonly SettingsServiceInterface $settingsService,
+        private readonly FilesystemInterface $filesystem,
+        private readonly JsonDecoderInterface $jsonDecoder
     ) {
-        $this->settingsService = $settingsService;
-        $this->filesystem = $filesystem;
-        $this->jsonDecoder = $jsonDecoder;
     }
 
     /**

diff --git a/Classes/Integration/FixedIdGenerator.php b/Classes/Integration/FixedIdGenerator.php
@@ -13,11 +13,9 @@
 
 final class FixedIdGenerator implements IdGeneratorInterface
 {
-    private string $id;
-
-    public function __construct(string $id)
-    {
-        $this->id = $id;
+    public function __construct(
+        private readonly string $id
+    ) {
     }
 
     public function generate(): string

diff --git a/Classes/Integration/PackageFactory.php b/Classes/Integration/PackageFactory.php
@@ -18,14 +18,10 @@
 
 final class PackageFactory implements PackageFactoryInterface
 {
-    private SettingsServiceInterface $settingsService;
-
-    private FilesystemInterface $filesystem;
-
-    public function __construct(SettingsServiceInterface $settingsService, FilesystemInterface $filesystem)
-    {
-        $this->settingsService = $settingsService;
-        $this->filesystem = $filesystem;
+    public function __construct(
+        private readonly SettingsServiceInterface $settingsService,
+        private readonly FilesystemInterface $filesystem
+    ) {
     }
 
     public function getPackage(string $package): JsonPackage

diff --git a/Classes/Integration/PageRendererHooks.php b/Classes/Integration/PageRendererHooks.php
@@ -30,11 +30,9 @@ final class PageRendererHooks
      */
     private const PART_FOOTER = 2;
 
-    private TagRendererInterface $tagRenderer;
-
-    public function __construct(TagRendererInterface $tagRenderer)
-    {
-        $this->tagRenderer = $tagRenderer;
+    public function __construct(
+        private readonly TagRendererInterface $tagRenderer
+    ) {
     }
 
     public function renderPreProcess(array $params, PageRenderer $pageRenderer): void

diff --git a/Classes/Integration/SettingsService.php b/Classes/Integration/SettingsService.php
@@ -18,11 +18,9 @@ final class SettingsService implements SettingsServiceInterface
 {
     private ?array $settings = null;
 
-    private ConfigurationManagerInterface $configurationManager;
-
-    public function __construct(ConfigurationManagerInterface $configurationManager)
-    {
-        $this->configurationManager = $configurationManager;
+    public function __construct(
+        private readonly ConfigurationManagerInterface $configurationManager
+    ) {
     }
 
     public function getSettings(): array

diff --git a/Classes/Integration/TypoScriptFrontendControllerEventListener.php b/Classes/Integration/TypoScriptFrontendControllerEventListener.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "typo3_encore" 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 Ssch\Typo3Encore\Integration;
+
+use TYPO3\CMS\Frontend\Event\AfterCacheableContentIsGeneratedEvent;
+
+final class TypoScriptFrontendControllerEventListener
+{
+    public function __construct(
+        private readonly AssetRegistryInterface $assetRegistry,
+        private readonly SettingsServiceInterface $settingsService
+    ) {
+    }
+
+    public function __invoke(AfterCacheableContentIsGeneratedEvent $event): void
+    {
+        $registeredFiles = $this->assetRegistry->getRegisteredFiles();
+        if ($registeredFiles === []) {
+            return;
+        }
+
+        $event->getController()
+            ->config['encore_asset_registry'] = [
+                'registered_files' => $this->assetRegistry->getRegisteredFiles(),
+                'default_attributes' => $this->assetRegistry->getDefaultAttributes(),
+                'settings' => $this->settingsService->getSettings(),
+            ];
+    }
+}