Add documentation and many code cleanups

lochmueller · Nov 13, 2024 · 1d387af · 1d387af
1 parent 94b0ee8
commit 1d387af
Show file tree

Hide file tree

Showing 36 changed files with 42 additions and 69 deletions.
diff --git a/Classes/Cache/IdentifierBuilder.php b/Classes/Cache/IdentifierBuilder.php
@@ -37,6 +37,8 @@ public function getFilepath(string $requestUri): string
             $parts['path'] = rawurldecode($parts['path']);
         }
 
+        // @todo add Event
+
         $absoluteBasePath = GeneralUtility::makeInstance(CacheService::class)->getAbsoluteBaseDirectory();
         $resultPath = GeneralUtility::resolveBackPath($absoluteBasePath . implode('/', $parts));
 

diff --git a/Classes/Cache/Listener/EnableListener.php b/Classes/Cache/Listener/EnableListener.php
@@ -4,11 +4,9 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use SFC\Staticfilecache\Service\ConfigurationService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
 class EnableListener
 {

diff --git a/Classes/Cache/Listener/NoBackendUserListener.php b/Classes/Cache/Listener/NoBackendUserListener.php
@@ -6,7 +6,6 @@
 
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Core\Context\Context;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * No active BE user.

diff --git a/Classes/Cache/Listener/NoUserOrGroupSetListener.php b/Classes/Cache/Listener/NoUserOrGroupSetListener.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Core\Context\Context;
 use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;

diff --git a/Classes/Cache/Listener/NoWorkspacePreviewListener.php b/Classes/Cache/Listener/NoWorkspacePreviewListener.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Core\Context\Context;
 

diff --git a/Classes/Cache/Listener/SiteCacheableListener.php b/Classes/Cache/Listener/SiteCacheableListener.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Core\Site\Entity\Site;
 

diff --git a/Classes/Cache/Listener/ValidDoktypeListener.php b/Classes/Cache/Listener/ValidDoktypeListener.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 

diff --git a/Classes/Cache/Listener/ValidPageInformationListener.php b/Classes/Cache/Listener/ValidPageInformationListener.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Cache\Listener;
 
-use Psr\Http\Message\ServerRequestInterface;
 use SFC\Staticfilecache\Event\CacheRuleEvent;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 

diff --git a/Classes/Cache/RemoteFileBackend.php b/Classes/Cache/RemoteFileBackend.php
@@ -42,17 +42,13 @@ class RemoteFileBackend extends AbstractBackend implements TaggableBackendInterf
 
     /**
      * Is freezed?
-     *
-     * @var bool
      */
-    protected $freeze = false;
+    protected bool $freeze = false;
 
     /**
      * Hash length.
-     *
-     * @var int
      */
-    protected $hashLength = 3;
+    protected int $hashLength = 3;
 
     /**
      * Set hash length.

diff --git a/Classes/Cache/StaticDatabaseBackend.php b/Classes/Cache/StaticDatabaseBackend.php
@@ -19,9 +19,6 @@ abstract class StaticDatabaseBackend extends Typo3DatabaseBackend implements Log
 {
     use LoggerAwareTrait;
 
-    /**
-     * Configuration.
-     */
     protected ConfigurationService $configuration;
 
     /**

diff --git a/Classes/Cache/StaticFileBackend.php b/Classes/Cache/StaticFileBackend.php
@@ -97,7 +97,6 @@ public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
 
             $this->removeStaticFiles($entryIdentifier);
 
-
             $this->eventDispatcher->dispatch(new GeneratorCreate($entryIdentifier, $fileName, $data, $realLifetime));
         } catch (\Exception $exception) {
             $this->logger->error('Error in cache create process', ['exception' => $exception]);

diff --git a/Classes/Command/BoostQueueCommand.php b/Classes/Command/BoostQueueCommand.php
@@ -4,7 +4,6 @@
 
 namespace SFC\Staticfilecache\Command;
 
-use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException;
 use SFC\Staticfilecache\Domain\Repository\QueueRepository;
 use SFC\Staticfilecache\Service\QueueService;
 use Symfony\Component\Console\Input\InputInterface;

diff --git a/Classes/Command/FlushCacheCommand.php b/Classes/Command/FlushCacheCommand.php
@@ -4,8 +4,6 @@
 
 namespace SFC\Staticfilecache\Command;
 
-use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException;
-use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheGroupException;
 use SFC\Staticfilecache\Service\CacheService;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;

diff --git a/Classes/Controller/BackendController.php b/Classes/Controller/BackendController.php
@@ -8,9 +8,7 @@
 use Psr\Log\LoggerAwareTrait;
 use SFC\Staticfilecache\Cache\UriFrontend;
 use TYPO3\CMS\Backend\Template\Components\Menu\Menu;
-use TYPO3\CMS\Backend\Template\Components\Menu\MenuItem;
 use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
-use TYPO3\CMS\Core\Messaging\AbstractMessage;
 use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Domain\Repository\PageRepository;
 use SFC\Staticfilecache\Domain\Repository\QueueRepository;
@@ -23,7 +21,6 @@
 use TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
-use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
 

diff --git a/Classes/Domain/Repository/CacheRepository.php b/Classes/Domain/Repository/CacheRepository.php
@@ -9,9 +9,6 @@
 use TYPO3\CMS\Core\Database\Connection;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-/**
- * CacheRepository.
- */
 class CacheRepository extends AbstractRepository
 {
     /**

diff --git a/Classes/Event/GeneratorConfigManipulationEvent.php b/Classes/Event/GeneratorConfigManipulationEvent.php
@@ -4,8 +4,6 @@
 
 namespace SFC\Staticfilecache\Event;
 
-use Psr\Http\Message\ResponseInterface;
-
 final class GeneratorConfigManipulationEvent
 {
     public function __construct(

diff --git a/Classes/Event/GeneratorContentManipulationEvent.php b/Classes/Event/GeneratorContentManipulationEvent.php
@@ -4,8 +4,6 @@
 
 namespace SFC\Staticfilecache\Event;
 
-use Psr\Http\Message\ResponseInterface;
-
 final class GeneratorContentManipulationEvent
 {
     public function __construct(

diff --git a/Classes/Generator/AbstractGenerator.php b/Classes/Generator/AbstractGenerator.php
@@ -5,7 +5,6 @@
 namespace SFC\Staticfilecache\Generator;
 
 use Psr\EventDispatcher\EventDispatcherInterface;
-use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
@@ -43,7 +42,7 @@ protected function renderTemplateToFile(string $templateName, array $variables,
         $renderer = GeneralUtility::makeInstance(StandaloneView::class);
         $renderer->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName($templateName));
         $renderer->assignMultiple($variables);
-        $content = trim((string) $renderer->render());
+        $content = trim($renderer->render());
         // Note: Create even empty htaccess files (do not check!!!), so the delete is in sync
         $this->writeFile($htaccessFile, $content);
     }

diff --git a/Classes/Generator/BrotliGenerator.php b/Classes/Generator/BrotliGenerator.php
@@ -4,14 +4,11 @@
 
 namespace SFC\Staticfilecache\Generator;
 
-use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
-use SFC\Staticfilecache\Service\RemoveService;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 class BrotliGenerator extends AbstractGenerator implements LoggerAwareInterface
 {

diff --git a/Classes/Generator/ConfigGenerator.php b/Classes/Generator/ConfigGenerator.php
@@ -4,12 +4,10 @@
 
 namespace SFC\Staticfilecache\Generator;
 
-use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorConfigManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
-use SFC\Staticfilecache\Service\RemoveService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 class ConfigGenerator extends AbstractGenerator

diff --git a/Classes/Generator/GzipGenerator.php b/Classes/Generator/GzipGenerator.php
@@ -4,12 +4,9 @@
 
 namespace SFC\Staticfilecache\Generator;
 
-use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
-use SFC\Staticfilecache\Service\RemoveService;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\MathUtility;
 
 class GzipGenerator extends AbstractGenerator

diff --git a/Classes/Generator/HtaccessGenerator.php b/Classes/Generator/HtaccessGenerator.php
@@ -4,15 +4,12 @@
 
 namespace SFC\Staticfilecache\Generator;
 
-use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
 use SFC\Staticfilecache\Service\DateTimeService;
-use SFC\Staticfilecache\Service\RemoveService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\PathUtility;
-use TYPO3\CMS\Fluid\View\StandaloneView;
 
 class HtaccessGenerator extends AbstractGenerator
 {

diff --git a/Classes/Generator/PhpGenerator.php b/Classes/Generator/PhpGenerator.php
@@ -4,19 +4,13 @@
 
 namespace SFC\Staticfilecache\Generator;
 
-use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
 use SFC\Staticfilecache\Service\DateTimeService;
-use SFC\Staticfilecache\Service\RemoveService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Core\Utility\PathUtility;
 
-/**
- * PlainGenerator.
- */
 class PhpGenerator extends HtaccessGenerator
 {
     public function generate(GeneratorCreate $generatorCreateEvent): void

diff --git a/Classes/Middleware/FallbackMiddleware.php b/Classes/Middleware/FallbackMiddleware.php
@@ -58,6 +58,7 @@ protected function handleViaFallback(ServerRequestInterface $request): ResponseI
             throw new Exception('StaticFileCache Cookie is set', 12738912);
         }
 
+        // @todo ID Buulder with DI
         $possibleStaticFile = GeneralUtility::makeInstance(IdentifierBuilder::class)->getFilepath((string) $uri);
 
         $headers = $this->getHeaders($event->getRequest(), $possibleStaticFile);

diff --git a/Classes/Middleware/GenerateMiddleware.php b/Classes/Middleware/GenerateMiddleware.php
@@ -5,10 +5,8 @@
 namespace SFC\Staticfilecache\Middleware;
 
 use Psr\Http\Message\RequestInterface;
-use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Cache\CacheDataCollector;
 use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
-use TYPO3\CMS\Core\Context\Context;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;

diff --git a/Classes/Service/CacheService.php b/Classes/Service/CacheService.php
@@ -4,13 +4,11 @@
 
 namespace SFC\Staticfilecache\Service;
 
-use SFC\Staticfilecache\Cache\UriFrontend;
 use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheGroupException;
 use SFC\Staticfilecache\Domain\Repository\QueueRepository;
 use TYPO3\CMS\Core\Cache\CacheManager;
 use TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException;
 use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
-use TYPO3\CMS\Core\Cache\Frontend\VariableFrontend;
 use TYPO3\CMS\Core\Core\Environment;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

diff --git a/Classes/Service/CookieService.php b/Classes/Service/CookieService.php
@@ -6,7 +6,6 @@
 
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
-use SFC\Staticfilecache\Service\DateTimeService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

diff --git a/Classes/Service/InlineAssets/AbstractInlineAssets.php b/Classes/Service/InlineAssets/AbstractInlineAssets.php
@@ -9,8 +9,6 @@
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * Class AbstractInlineFiles.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 abstract class AbstractInlineAssets

diff --git a/Classes/Service/InlineAssets/InlineFavIcon.php b/Classes/Service/InlineAssets/InlineFavIcon.php
@@ -5,8 +5,6 @@
 namespace SFC\Staticfilecache\Service\InlineAssets;
 
 /**
- * Class InlineFavIcon.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 class InlineFavIcon extends AbstractInlineAssets

diff --git a/Classes/Service/InlineAssets/InlineImages.php b/Classes/Service/InlineAssets/InlineImages.php
@@ -5,8 +5,6 @@
 namespace SFC\Staticfilecache\Service\InlineAssets;
 
 /**
- * Class InlineImages.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 class InlineImages extends AbstractInlineAssets

diff --git a/Classes/Service/InlineAssets/InlineScripts.php b/Classes/Service/InlineAssets/InlineScripts.php
@@ -5,8 +5,6 @@
 namespace SFC\Staticfilecache\Service\InlineAssets;
 
 /**
- * Class InlineScripts.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 class InlineScripts extends AbstractInlineAssets

diff --git a/Classes/Service/InlineAssets/InlineStyles.php b/Classes/Service/InlineAssets/InlineStyles.php
@@ -5,8 +5,6 @@
 namespace SFC\Staticfilecache\Service\InlineAssets;
 
 /**
- * Class InlineStyles.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 class InlineStyles extends AbstractInlineAssets

diff --git a/Classes/Service/InlineAssetsService.php b/Classes/Service/InlineAssetsService.php
@@ -7,8 +7,6 @@
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * Class InlineAssetsService.
- *
  * @author Marcus Förster ; https://github.com/xerc
  */
 class InlineAssetsService

diff --git a/Classes/Service/QueueService.php b/Classes/Service/QueueService.php
@@ -11,8 +11,6 @@
 use SFC\Staticfilecache\Domain\Repository\QueueRepository;
 
 /**
- * Queue service.
- *
  * @see BoostQueueCommand
  */
 class QueueService implements LoggerAwareInterface
-Original file line number
+Diff line change
@@ Expand Up @@
     {
         use LoggerAwareTrait;
-        /**
-         * Configuration.
-         */
         protected ConfigurationService $configuration;
         /**
@@ Expand Down @@