[FEATURE] Support TYPO3 v12

* Adapt to the new class structure
* Adapt to the new image resource rendering

Author: SomeBdyElse

.github/workflows/php.yml

@@ -10,19 +10,19 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: OSKAR-PHP-CS-Fixer
-      uses: OskarStark/php-cs-fixer-ga@2.17.3
+      uses: OskarStark/php-cs-fixer-ga@3.22.0
       with:
         args: --diff --dry-run
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 7.4
+        php-version: 8.2
         tools: composer
         extensions: pdo, sqlite3
 
     - name: composer install
       run: composer install -n
 
     - name: phpunit
-      run: .Build/bin/phpunit -c .Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xml Tests/Unit
+      run: .Build/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml Tests/Unit

.gitignore

@@ -1,4 +1,4 @@
 /composer.lock
 /.Build
-/.php_cs.cache
 /.phpunit.result.cache
+/.php-cs-fixer.cache

.php_cs.dist .php-cs-fixer.dist.php

@@ -1,64 +1,54 @@
 <?php
-https://github.com/TYPO3/TYPO3.CMS/blob/5d3f7751abf1914d219554ce8e72105944208c77/Build/.php_cs
 
-if (PHP_SAPI !== 'cli') {
-    die('This script supports command line usage only. Please check your command.');
-}
-// Define in which folders to search and which folders to exclude
-// Exclude some directories that are excluded by Git anyways to speed up the sniffing
-$finder = PhpCsFixer\Finder::create()
-    ->exclude('vendor')
-    ->exclude('Configuration')
-    ->in(__DIR__);
+declare(strict_types=1);
 
-// https://github.com/TYPO3/TYPO3.CMS/blob/5d3f7751abf1914d219554ce8e72105944208c77/Build/.php_cs
 // Return a Code Sniffing configuration using
-// all sniffers needed for PSR-2
+// all sniffers needed for PER
 // and additionally:
 //  - Remove leading slashes in use clauses.
 //  - PHP single-line arrays should not have trailing comma.
 //  - Single-line whitespace before closing semicolon are prohibited.
 //  - Remove unused use statements in the PHP source code
 //  - Ensure Concatenation to have at least one whitespace around
 //  - Remove trailing whitespace at the end of blank lines.
-return PhpCsFixer\Config::create()
+return (new \PhpCsFixer\Config())
+    ->setFinder(
+        (new PhpCsFixer\Finder())
+            ->ignoreVCSIgnored(true)
+            ->in(__DIR__)
+    )
     ->setRiskyAllowed(true)
     ->setRules([
         '@DoctrineAnnotation' => true,
-        '@PSR2' => true,
+        '@PER' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'blank_line_after_opening_tag' => true,
-        'braces' => ['allow_single_line_closure' => true],
         'cast_spaces' => ['space' => 'none'],
-        'compact_nullable_typehint' => true,
         'concat_space' => ['spacing' => 'one'],
         'declare_equal_normalize' => ['space' => 'none'],
+        'declare_parentheses' => true,
         'dir_constant' => true,
+        'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']],
         'function_typehint_space' => true,
-        'hash_to_slash_comment' => true,
-        'lowercase_cast' => true,
-        'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
+        'modernize_strpos' => true,
         'modernize_types_casting' => true,
         'native_function_casing' => true,
-        'new_with_braces' => true,
         'no_alias_functions' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_empty_phpdoc' => true,
         'no_empty_statement' => true,
-        'no_extra_consecutive_blank_lines' => true,
-        'no_leading_import_slash' => true,
+        'no_extra_blank_lines' => true,
         'no_leading_namespace_whitespace' => true,
         'no_null_property_initialization' => true,
         'no_short_bool_cast' => true,
         'no_singleline_whitespace_before_semicolons' => true,
         'no_superfluous_elseif' => true,
-        'no_trailing_comma_in_singleline_array' => true,
+        'no_trailing_comma_in_singleline' => true,
         'no_unneeded_control_parentheses' => true,
         'no_unused_imports' => true,
         'no_useless_else' => true,
-        'no_whitespace_in_blank_line' => true,
-        'ordered_imports' => true,
-        'php_unit_construct' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame'],
+        'no_useless_nullsafe_operator' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
+        'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
         'php_unit_mock_short_will_return' => true,
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
         'phpdoc_no_access' => true,
@@ -70,7 +60,8 @@
         'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
         'return_type_declaration' => ['space_before' => 'none'],
         'single_quote' => true,
-        'single_trait_insert_per_statement' => true,
-        'whitespace_after_comma_in_array' => true,
-    ])
-    ->setFinder($finder);
+        'single_space_around_construct' => true,
+        'single_line_comment_style' => ['comment_types' => ['hash']],
+        'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
+        'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
+    ]);

Classes/ContentObject/PtiContentObject.php

@@ -5,32 +5,24 @@
 namespace PrototypeIntegration\PrototypeIntegration\ContentObject;
 
 use PrototypeIntegration\PrototypeIntegration\DataProcessing\ProcessorRunner;
-use PrototypeIntegration\PrototypeIntegration\View\TemplateBasedView;
+use PrototypeIntegration\PrototypeIntegration\View\TemplateBasedViewInterface;
 use PrototypeIntegration\PrototypeIntegration\View\ViewResolver;
 use TYPO3\CMS\Core\TypoScript\TypoScriptService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Frontend\ContentObject\AbstractContentObject;
-use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 
 class PtiContentObject extends AbstractContentObject
 {
-    protected TypoScriptService $typoScriptService;
-
-    protected ProcessorRunner $processorRunner;
-
     protected ViewResolver $viewResolver;
 
     protected array $conf;
 
     protected string $templateName;
 
-    public function __construct(ContentObjectRenderer $contentObjectRenderer)
-    {
-        parent::__construct($contentObjectRenderer);
-
-        $this->typoScriptService = GeneralUtility::makeInstance(TypoScriptService::class);
-        $this->processorRunner = GeneralUtility::makeInstance(ProcessorRunner::class);
-
+    public function __construct(
+        protected TypoScriptService $typoScriptService,
+        protected ProcessorRunner $processorRunner,
+    ) {
         $viewResolverClass = $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['pti']['view']['viewResolver'];
         $this->viewResolver = GeneralUtility::makeInstance($viewResolverClass);
     }
@@ -56,7 +48,7 @@ public function render($conf = [])
         $view = $this->viewResolver->getViewForContentObject($data, $templateName);
         $view->setVariables($data);
 
-        if ($view instanceof TemplateBasedView) {
+        if ($view instanceof TemplateBasedViewInterface) {
             $view->setTemplate($templateName);
         }
 

Classes/Processor/ImageProcessor.php

@@ -5,6 +5,7 @@
 namespace PrototypeIntegration\PrototypeIntegration\Processor;
 
 use TYPO3\CMS\Core\Resource\FileInterface;
+use TYPO3\CMS\Core\Utility\PathUtility;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 use UnexpectedValueException;
@@ -34,13 +35,13 @@ public function renderImage(FileInterface $file, array $conf = []): array
                 1_678_088_092
             );
         }
-
-        $retinaImageResource = self::renderRetinaImage($file, $conf);
+        $defaultImagePublicUrl = PathUtility::stripPathSitePrefix($defaultImageResource[3]);
+        $retinaImagePublicUrl = self::renderRetinaImage($file, $conf);
 
         $assetOptions = [
             'uri' => [
-                'default' => $this->addAbsRefPrefix($defaultImageResource[3]),
-                'retina2x' => $this->addAbsRefPrefix($retinaImageResource)
+                'default' => $defaultImagePublicUrl,
+                'retina2x' => $retinaImagePublicUrl,
             ],
             'width' => $defaultImageResource[0],
             'height' => $defaultImageResource[1],
@@ -69,18 +70,7 @@ protected function renderRetinaImage(FileInterface $file, array $configuration):
             );
         }
 
-        return $image[3];
-    }
-
-    /**
-     * Prepend the absRefPrefix from typoscript configuration to the image file path
-     *
-     * @param string $uri
-     * @return string
-     */
-    protected function addAbsRefPrefix(string $uri): string
-    {
-        return $this->tsfe->absRefPrefix . $uri;
+        return PathUtility::stripPathSitePrefix($image[3]);
     }
 
     /**

Classes/Processor/PreviewImageProcessor.php

@@ -19,7 +19,7 @@
  */
 class PreviewImageProcessor
 {
-    const FILE_PREVIEW_IMAGE_PROPERTY = 'preview_image';
+    public const FILE_PREVIEW_IMAGE_PROPERTY = 'preview_image';
 
     protected MetaDataRepository $metaDataRepository;
 

Classes/Processor/TypoLinkStringProcessor.php

@@ -4,8 +4,8 @@
 
 namespace PrototypeIntegration\PrototypeIntegration\Processor;
 
+use TYPO3\CMS\Core\LinkHandling\TypoLinkCodecService;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
-use TYPO3\CMS\Frontend\Service\TypoLinkCodecService;
 
 class TypoLinkStringProcessor
 {

Classes/View/DefaultViewResolver.php

@@ -6,8 +6,6 @@
 
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
-use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
 
 class DefaultViewResolver implements ViewResolver
 {
@@ -18,20 +16,23 @@ public function __construct(ExtensionConfiguration $extensionConfiguration)
         $this->extensionConfiguration = $extensionConfiguration;
     }
 
-    public function getViewForContentObject(?array $dbRow = [], ?string $template = ''): ViewInterface
+    public function getViewForContentObject(?array $dbRow = [], ?string $template = ''): PtiViewInterface
     {
         return $this->getDefaultView();
     }
 
-    public function getViewForExtbaseAction(ControllerContext $controllerContext, ?string $template): ViewInterface
-    {
+    public function getViewForExtbaseAction(
+        string $controllerObjectName,
+        string $actionName,
+        string $format,
+        ?string $template
+    ): PtiViewInterface {
         return $this->getDefaultView();
     }
 
-    protected function getDefaultView(): ViewInterface
+    protected function getDefaultView(): PtiViewInterface
     {
         $class = $this->extensionConfiguration->get('pti', 'defaultView');
-        /** @var ViewInterface $view */
         $view = GeneralUtility::makeInstance($class);
         return $view;
     }

Classes/View/ExtbaseViewAdapter.php

@@ -6,23 +6,30 @@
 
 use PrototypeIntegration\PrototypeIntegration\View\Event\ExtbaseViewAdapterVariablesConvertedEvent;
 use TYPO3\CMS\Core\EventDispatcher\EventDispatcher;
+use TYPO3\CMS\Core\Utility\Exception\NotImplementedMethodException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
-use TYPO3\CMS\Extbase\Mvc\View\AbstractView;
+use TYPO3Fluid\Fluid\View\AbstractView;
 
-abstract class ExtbaseViewAdapter extends AbstractView
+abstract class ExtbaseViewAdapter extends AbstractView implements ViewAdapterContextAware
 {
     protected ?array $settings;
 
     protected ?string $template = null;
 
     protected EventDispatcher $eventDispatcher;
 
+    protected ExtbaseViewAdapterContext $viewAdapterContext;
+
     public function injectDispatcher(EventDispatcher $eventDispatcher)
     {
         $this->eventDispatcher = $eventDispatcher;
     }
 
+    public function setViewAdapterContext(ExtbaseViewAdapterContext $viewAdapterContext): void
+    {
+        $this->viewAdapterContext = $viewAdapterContext;
+    }
+
     /**
      * Renders the view
      *
@@ -36,17 +43,19 @@ public function render()
         $viewResolver = GeneralUtility::makeInstance($viewResolverClass);
 
         $view = $viewResolver->getViewForExtbaseAction(
-            $this->controllerContext,
+            $this->viewAdapterContext->getControllerObjectName(),
+            $this->viewAdapterContext->getActionName(),
+            $this->viewAdapterContext->getFormat(),
             $this->getTemplate()
         );
 
-        if ($view instanceof TemplateBasedView) {
+        if ($view instanceof TemplateBasedViewInterface) {
             $view->setTemplate($this->getTemplate());
         }
 
         $variables = $this->convertVariables($this->variables);
         $variables = $this->eventDispatcher->dispatch(new ExtbaseViewAdapterVariablesConvertedEvent($variables))->getVariables();
-        $view->assignMultiple($variables);
+        $view->setVariables($variables);
 
         return $view->render();
     }
@@ -56,24 +65,23 @@ protected function convertVariables(array $variables): array
         return $variables;
     }
 
-    public function setControllerContext(ControllerContext $controllerContext)
-    {
-        parent::setControllerContext($controllerContext);
-    }
-
-    /**
-     * @return string
-     */
     public function getTemplate(): string
     {
         return $this->template;
     }
 
-    /**
-     * @param array $settings
-     */
     public function injectSettings(?array $settings): void
     {
         $this->settings = $settings;
     }
+
+    public function renderSection($sectionName, array $variables = [], $ignoreUnknown = false)
+    {
+        throw new NotImplementedMethodException('', 1691402012205);
+    }
+
+    public function renderPartial($partialName, $sectionName, array $variables, $ignoreUnknown = false)
+    {
+        throw new NotImplementedMethodException('', 1691402017852);
+    }
 }

Classes/View/ExtbaseViewAdapterContext.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PrototypeIntegration\PrototypeIntegration\View;
+
+class ExtbaseViewAdapterContext
+{
+    public function __construct(
+        protected string $controllerObjectName,
+        protected string $actionName,
+        protected string $format
+    ) {
+    }
+
+    public function getControllerObjectName(): string
+    {
+        return $this->controllerObjectName;
+    }
+
+    public function getActionName(): string
+    {
+        return $this->actionName;
+    }
+
+    public function getFormat(): string
+    {
+        return $this->format;
+    }
+}