[TASK] Introduce a proxy for ResourceFactory

FluidTYPO3 · Jan 28, 2025 · 888eef0 · 888eef0
1 parent 5fa5412
commit 888eef0
Show file tree

Hide file tree

Showing 15 changed files with 87 additions and 32 deletions.
diff --git a/Classes/Proxy/ResourceFactoryProxy.php b/Classes/Proxy/ResourceFactoryProxy.php
@@ -0,0 +1,52 @@
+<?php
+namespace FluidTYPO3\Vhs\Proxy;
+
+/*
+ * This file is part of the FluidTYPO3/Flux project under GPLv2 or later.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.md file that was distributed with this source code.
+ */
+
+use TYPO3\CMS\Core\Resource\File;
+use TYPO3\CMS\Core\Resource\FileReference;
+use TYPO3\CMS\Core\Resource\ProcessedFile;
+use TYPO3\CMS\Core\Resource\ResourceFactory;
+use TYPO3\CMS\Core\SingletonInterface;
+
+/**
+ * Final/readonly class is unnecessary coercion - and using it in shared libraries is arrogant and very disrespectful.
+ *
+ * @codeCoverageIgnore
+ */
+class ResourceFactoryProxy implements SingletonInterface
+{
+    private ResourceFactory $resourceFactory;
+
+    public function __construct(ResourceFactory $resourceFactory)
+    {
+        $this->resourceFactory = $resourceFactory;
+    }
+
+    public function getFileReferenceObject(int $uid): FileReference
+    {
+        return $this->resourceFactory->getFileReferenceObject($uid);
+    }
+
+    /**
+     * @param int $uid
+     */
+    public function getFileObject($uid, array $fileData = []): File
+    {
+        return $this->resourceFactory->getFileObject($uid, $fileData);
+    }
+
+    /**
+     * @param string $identifier
+     * @return File|ProcessedFile|null
+     */
+    public function getFileObjectFromCombinedIdentifier($identifier)
+    {
+        return $this->resourceFactory->getFileObjectFromCombinedIdentifier($identifier);
+    }
+}
diff --git a/Classes/ViewHelpers/Media/Image/AbstractImageInfoViewHelper.php b/Classes/ViewHelpers/Media/Image/AbstractImageInfoViewHelper.php
@@ -8,9 +8,9 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Utility\ResourceUtility;
 use TYPO3\CMS\Core\Resource\FileReference as CoreFileReference;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Domain\Model\FileReference as ExtbaseFileReference;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
@@ -22,7 +22,7 @@
 abstract class AbstractImageInfoViewHelper extends AbstractViewHelper
 {
     /**
-     * @var ResourceFactory
+     * @var ResourceFactoryProxy
      */
     protected $resourceFactory;
 
@@ -36,8 +36,8 @@ abstract class AbstractImageInfoViewHelper extends AbstractViewHelper
      */
     public function __construct()
     {
-        /** @var ResourceFactory $resourceFactory */
-        $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
+        /** @var ResourceFactoryProxy $resourceFactory */
+        $resourceFactory = GeneralUtility::makeInstance(ResourceFactoryProxy::class);
         $this->resourceFactory = $resourceFactory;
     }
 

diff --git a/Classes/ViewHelpers/Resource/AbstractResourceViewHelper.php b/Classes/ViewHelpers/Resource/AbstractResourceViewHelper.php
@@ -9,13 +9,13 @@
  */
 
 use FluidTYPO3\Vhs\Proxy\DoctrineQueryProxy;
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Traits\TagViewHelperCompatibility;
 use FluidTYPO3\Vhs\Utility\ResourceUtility;
 use TYPO3\CMS\Core\Database\Connection;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Resource\File;
 use TYPO3\CMS\Core\Resource\ProcessedFile;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
@@ -93,8 +93,8 @@ public function getFiles(bool $onlyProperties = false, ?string $identifier = nul
         }
 
         $files = [];
-        /** @var ResourceFactory $resourceFactory */
-        $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
+        /** @var ResourceFactoryProxy $resourceFactory */
+        $resourceFactory = GeneralUtility::makeInstance(ResourceFactoryProxy::class);
 
         if (!empty($categories)) {
             /** @var ConnectionPool $connectionPool */

diff --git a/Classes/ViewHelpers/Resource/Record/FalViewHelper.php b/Classes/ViewHelpers/Resource/Record/FalViewHelper.php
@@ -9,14 +9,14 @@
  */
 
 use FluidTYPO3\Vhs\Proxy\DoctrineQueryProxy;
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Utility\ResourceUtility;
 use TYPO3\CMS\Core\Database\Connection;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Database\Query\QueryBuilder;
 use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
 use TYPO3\CMS\Core\Resource\FileReference;
 use TYPO3\CMS\Core\Resource\FileRepository;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Core\Utility\ArrayUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Versioning\VersionState;
@@ -50,7 +50,7 @@
 class FalViewHelper extends AbstractRecordResourceViewHelper
 {
     /**
-     * @var ResourceFactory
+     * @var ResourceFactoryProxy
      */
     protected $resourceFactory;
 
@@ -69,8 +69,8 @@ class FalViewHelper extends AbstractRecordResourceViewHelper
      */
     public function __construct()
     {
-        /** @var ResourceFactory $resourceFactory */
-        $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
+        /** @var ResourceFactoryProxy $resourceFactory */
+        $resourceFactory = GeneralUtility::makeInstance(ResourceFactoryProxy::class);
         $this->resourceFactory = $resourceFactory;
         /** @var FileRepository $fileRepository */
         $fileRepository = GeneralUtility::makeInstance(FileRepository::class);

diff --git a/Configuration/Services.yaml b/Configuration/Services.yaml
@@ -17,6 +17,9 @@ services:
   FluidTYPO3\Vhs\Proxy\SiteFinderProxy:
     public: true
 
+  FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy:
+    public: true
+
   FluidTYPO3\Vhs\Service\AssetService:
     public: true
 

diff --git a/Tests/Unit/ViewHelpers/Condition/Form/HasValidatorViewHelperTest.php b/Tests/Unit/ViewHelpers/Condition/Form/HasValidatorViewHelperTest.php
@@ -8,20 +8,20 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Domain\Model\Bar;
 use FluidTYPO3\Vhs\Tests\Fixtures\Domain\Model\Foo;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Resource\FileRepository;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Extbase\Reflection\ReflectionService;
 
 class HasValidatorViewHelperTest extends AbstractViewHelperTestCase
 {
 
     protected function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         $this->singletonInstances[FileRepository::class] = $this->getMockBuilder(FileRepository::class)->disableOriginalConstructor()->getMock();
         $this->singletonInstances[ReflectionService::class] = $this->getMockBuilder(ReflectionService::class)
             ->setMethods(['__destruct'])

diff --git a/Tests/Unit/ViewHelpers/Content/Resources/FalViewHelperTest.php b/Tests/Unit/ViewHelpers/Content/Resources/FalViewHelperTest.php
@@ -8,10 +8,10 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Resource\FileRepository;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class FalViewHelperTest
@@ -20,7 +20,7 @@ class FalViewHelperTest extends AbstractViewHelperTestCase
 {
     protected function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         $this->singletonInstances[FileRepository::class] = $this->getMockBuilder(FileRepository::class)->disableOriginalConstructor()->getMock();
 
         parent::setUp();

diff --git a/Tests/Unit/ViewHelpers/Media/ExtensionViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/ExtensionViewHelperTest.php
@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\AccessibleExtensionManagementUtility;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Package\PackageManager;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class ExtensionViewHelperTest
@@ -29,7 +29,7 @@ class ExtensionViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = 'Tests/Fixtures/Files';
         $packageManager = $this->getMockBuilder(PackageManager::class)->setMethods(['resolvePackagePath'])->disableOriginalConstructor()->getMock();

diff --git a/Tests/Unit/ViewHelpers/Media/FilesViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/FilesViewHelperTest.php
@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\AccessibleExtensionManagementUtility;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Package\PackageManager;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class FilesViewHelperTest
@@ -29,7 +29,7 @@ class FilesViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = 'EXT:vhs/Tests/Fixtures/Files';
         $packageManager = $this->getMockBuilder(PackageManager::class)->setMethods(['resolvePackagePath'])->disableOriginalConstructor()->getMock();

diff --git a/Tests/Unit/ViewHelpers/Media/Image/HeightViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/Image/HeightViewHelperTest.php
@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\AccessibleExtensionManagementUtility;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Package\PackageManager;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class HeightViewHelperTest
@@ -29,7 +29,7 @@ class HeightViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = realpath(__DIR__ . '/../../../../../Tests/Fixtures/Files');
         $packageManager = $this->getMockBuilder(PackageManager::class)->setMethods(['resolvePackagePath'])->disableOriginalConstructor()->getMock();

diff --git a/Tests/Unit/ViewHelpers/Media/Image/MimetypeViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/Image/MimetypeViewHelperTest.php
@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\AccessibleExtensionManagementUtility;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Package\PackageManager;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class MimetypeViewHelperTest
@@ -29,7 +29,7 @@ class MimetypeViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = realpath(__DIR__ . '/../../../../../Tests/Fixtures/Files');
         $packageManager = $this->getMockBuilder(PackageManager::class)->setMethods(['resolvePackagePath'])->disableOriginalConstructor()->getMock();

diff --git a/Tests/Unit/ViewHelpers/Media/Image/WidthViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/Image/WidthViewHelperTest.php
@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\AccessibleExtensionManagementUtility;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Package\PackageManager;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class WidthViewHelperTest
@@ -29,7 +29,7 @@ class WidthViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = realpath(__DIR__ . '/../../../../../Tests/Fixtures/Files');
         $packageManager = $this->getMockBuilder(PackageManager::class)->setMethods(['resolvePackagePath'])->disableOriginalConstructor()->getMock();

diff --git a/Tests/Unit/ViewHelpers/Media/SizeViewHelperTest.php b/Tests/Unit/ViewHelpers/Media/SizeViewHelperTest.php
@@ -8,9 +8,9 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class SizeViewHelperTest
@@ -27,7 +27,7 @@ class SizeViewHelperTest extends AbstractViewHelperTestCase
      */
     public function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         parent::setUp();
         $this->fixturesPath = realpath(__DIR__ . '/../../../../Tests/Fixtures/Files');
     }

diff --git a/Tests/Unit/ViewHelpers/Page/Resources/FalViewHelperTest.php b/Tests/Unit/ViewHelpers/Page/Resources/FalViewHelperTest.php
@@ -8,10 +8,10 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use TYPO3\CMS\Core\Resource\FileRepository;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 
 /**
  * Class FalViewHelperTest
@@ -20,7 +20,7 @@ class FalViewHelperTest extends AbstractViewHelperTestCase
 {
     protected function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)->disableOriginalConstructor()->getMock();
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)->disableOriginalConstructor()->getMock();
         $this->singletonInstances[FileRepository::class] = $this->getMockBuilder(FileRepository::class)->disableOriginalConstructor()->getMock();
 
         parent::setUp();

diff --git a/Tests/Unit/ViewHelpers/Resource/Record/FalViewHelperTest.php b/Tests/Unit/ViewHelpers/Resource/Record/FalViewHelperTest.php
@@ -8,21 +8,21 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\ResourceFactoryProxy;
 use FluidTYPO3\Vhs\Tests\Fixtures\Classes\DummyQueryBuilder;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTest;
 use FluidTYPO3\Vhs\Tests\Unit\ViewHelpers\AbstractViewHelperTestCase;
 use FluidTYPO3\Vhs\ViewHelpers\Resource\Record\FalViewHelper;
 use TYPO3\CMS\Core\Resource\File;
 use TYPO3\CMS\Core\Resource\FileReference;
 use TYPO3\CMS\Core\Resource\FileRepository;
-use TYPO3\CMS\Core\Resource\ResourceFactory;
 use TYPO3\CMS\Core\Resource\ResourceStorage;
 
 class FalViewHelperTest extends AbstractViewHelperTestCase
 {
     protected function setUp(): void
     {
-        $this->singletonInstances[ResourceFactory::class] = $this->getMockBuilder(ResourceFactory::class)
+        $this->singletonInstances[ResourceFactoryProxy::class] = $this->getMockBuilder(ResourceFactoryProxy::class)
             ->setMethods(['getFileReferenceObject'])
             ->disableOriginalConstructor()
             ->getMock();
@@ -90,7 +90,7 @@ public function testGetResourcesInNonPageContext(int $workspaceUid): void
     {
         $file = $this->getMockBuilder(FileReference::class)->disableOriginalConstructor()->getMock();
 
-        $this->singletonInstances[ResourceFactory::class]->method('getFileReferenceObject')->willReturn($file);
+        $this->singletonInstances[ResourceFactoryProxy::class]->method('getFileReferenceObject')->willReturn($file);
 
         $mockQueryBuilder = new DummyQueryBuilder($this);
         $mockQueryBuilder->result->method('fetchAllAssociative')->willReturn([['uid' => 1]]);