Merge pull request #58 from xima-media/phpstan

build: increase phpstan checks

Author: Konrad Michalik

Classes/EventListener/ModifyButtonBarEventListener.php

@@ -6,13 +6,13 @@
 use TYPO3\CMS\Backend\Template\Components\Buttons\InputButton;
 use TYPO3\CMS\Backend\Template\Components\ModifyButtonBarEvent;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
-use TYPO3\CMS\Core\Imaging\Icon;
 use TYPO3\CMS\Core\Imaging\IconFactory;
 use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Page\PageRenderer;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use Xima\XimaTypo3FrontendEdit\Configuration;
+use Xima\XimaTypo3FrontendEdit\Utility\IconUtility;
 
 final class ModifyButtonBarEventListener
 {
@@ -44,7 +44,7 @@ public function __invoke(ModifyButtonBarEvent $event): void
                 ->setValue('1')
                 ->setForm($saveButton->getForm())
                 ->setTitle($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:rm.saveCloseDoc'))
-                ->setIcon($iconFactory->getIcon('actions-document-save-close', Icon::SIZE_SMALL))
+                ->setIcon($iconFactory->getIcon('actions-document-save-close', IconUtility::getDefaultIconSize()))
                 ->setShowLabelText(true);
 
             $typo3Version = GeneralUtility::makeInstance(Typo3Version::class)->getMajorVersion();

Classes/Middleware/EditInformationMiddleware.php

@@ -39,16 +39,16 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
             $data = json_decode($request->getBody()->getContents(), true) ?? [];
 
-            if (!$this->checkBackendUserPageAccess((int)$pid)) {
+            if (!$this->checkBackendUserPageAccess($pid)) {
                 return new JsonResponse([]);
             }
 
             return new JsonResponse(
                 mb_convert_encoding(
                     $this->menuGenerator->getDropdown(
-                        (int)$pid,
+                        $pid,
                         $returnUrl,
-                        (int)$languageUid,
+                        $languageUid,
                         $data
                     ),
                     'UTF-8'

Classes/Middleware/ToolRendererMiddleware.php

@@ -13,10 +13,6 @@
 
 class ToolRendererMiddleware implements MiddlewareInterface
 {
-    public function __construct(protected ResourceRenderer $resourceRenderer)
-    {
-    }
-
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         $response = $handler->handle($request);
@@ -25,15 +21,15 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         if (
             array_key_exists('tx_ximatypo3frontendedit_enable', $typoScriptConfig)
             && $typoScriptConfig['tx_ximatypo3frontendedit_enable']
-            && $GLOBALS['BE_USER']
+            && $GLOBALS['BE_USER'] !== null
             && (!array_key_exists('tx_ximatypo3frontendedit_disable', $GLOBALS['BE_USER']->user) || !$GLOBALS['BE_USER']->user['tx_ximatypo3frontendedit_disable'])
         ) {
             $body = $response->getBody();
             $body->rewind();
             $contents = $response->getBody()->getContents();
             $content = str_ireplace(
                 '</body>',
-                $this->resourceRenderer->render() . '</body>',
+                ResourceRenderer::render() . '</body>',
                 $contents
             );
             $body = new Stream('php://temp', 'rw');

Classes/Service/MenuGenerator.php

@@ -10,14 +10,14 @@
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
 use TYPO3\CMS\Core\Core\Bootstrap;
 use TYPO3\CMS\Core\EventDispatcher\EventDispatcher;
-use TYPO3\CMS\Core\Imaging\Icon;
 use TYPO3\CMS\Core\Imaging\IconFactory;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use Xima\XimaTypo3FrontendEdit\Configuration;
 use Xima\XimaTypo3FrontendEdit\Enumerations\ButtonType;
 use Xima\XimaTypo3FrontendEdit\Event\FrontendEditDropdownModifyEvent;
 use Xima\XimaTypo3FrontendEdit\Template\Component\Button;
 use Xima\XimaTypo3FrontendEdit\Utility\ContentUtility;
+use Xima\XimaTypo3FrontendEdit\Utility\IconUtility;
 use Xima\XimaTypo3FrontendEdit\Utility\UrlUtility;
 
 final class MenuGenerator
@@ -42,7 +42,7 @@ public function getDropdown(int $pid, string $returnUrl, int $languageUid, array
             }
         }
 
-        /* @var $backendUser \TYPO3\CMS\Core\Authentication\BackendUserAuthentication */
+        /* @var $backendUser BackendUserAuthentication */
         $backendUser = $GLOBALS['BE_USER'];
         if ($backendUser->user === null) {
             Bootstrap::initializeBackendAuthentication();
@@ -80,7 +80,7 @@ public function getDropdown(int $pid, string $returnUrl, int $languageUid, array
             $contentElementConfig = ContentUtility::getContentElementConfig($contentElement['CType'], $contentElement['list_type']);
             $returnUrlAnchor = $returnUrl . '#c' . $contentElement['uid'];
 
-            $simpleMode = (array_key_exists('simpleMode', $this->configuration) && $this->configuration['simpleMode']) || $this->settingsService->checkSimpleModeMenuStructure();
+            $simpleMode = (array_key_exists('simpleMode', $this->configuration) && (bool)$this->configuration['simpleMode']) || $this->settingsService->checkSimpleModeMenuStructure();
 
             if ($simpleMode) {
                 $menuButton = new Button(
@@ -98,14 +98,14 @@ public function getDropdown(int $pid, string $returnUrl, int $languageUid, array
                             'returnUrl' => $returnUrlAnchor,
                         ]
                     )->__toString(),
-                    icon: $this->iconFactory->getIcon('actions-open', Icon::SIZE_SMALL),
-                    targetBlank: array_key_exists('linkTargetBlank', $this->configuration) && $this->configuration['linkTargetBlank']
+                    icon: $this->iconFactory->getIcon('actions-open', IconUtility::getDefaultIconSize()),
+                    targetBlank: array_key_exists('linkTargetBlank', $this->configuration) && (bool)$this->configuration['linkTargetBlank']
                 );
             } else {
                 $menuButton = new Button(
                     'LLL:EXT:xima_typo3_frontend_edit/Resources/Private/Language/locallang.xlf:edit_menu',
                     ButtonType::Menu,
-                    icon: $this->iconFactory->getIcon('actions-open', Icon::SIZE_SMALL)
+                    icon: $this->iconFactory->getIcon('actions-open', IconUtility::getDefaultIconSize())
                 );
 
                 /*
@@ -118,7 +118,7 @@ public function getDropdown(int $pid, string $returnUrl, int $languageUid, array
                     $menuButton,
                     'header',
                     ButtonType::Info,
-                    label: $GLOBALS['LANG']->sL($contentElementConfig['label']) . '<p><small>' . ($contentElement['header'] ? ContentUtility::shortenString($contentElement['header']) : '') . $additionalUid . '</small></p>',
+                    label: $GLOBALS['LANG']->sL($contentElementConfig['label']) . '<p><small>' . ($contentElement['header'] !== null ? ContentUtility::shortenString($contentElement['header']) : '') . $additionalUid . '</small></p>',
                     icon: $contentElementConfig['icon']
                 );
 
@@ -254,31 +254,39 @@ private function processNewButton(Button &$button, string $identifier, ButtonTyp
         }
 
         $button->appendChild(new Button(
-            $label ?: "LLL:EXT:xima_typo3_frontend_edit/Resources/Private/Language/locallang.xlf:$identifier",
+            $label !== null ? $label : "LLL:EXT:xima_typo3_frontend_edit/Resources/Private/Language/locallang.xlf:$identifier",
             $type,
             $url,
-            $icon ? $this->iconFactory->getIcon($icon, Icon::SIZE_SMALL) : null,
+            $icon !== null ? $this->iconFactory->getIcon($icon, IconUtility::getDefaultIconSize()) : null,
             array_key_exists('linkTargetBlank', $this->configuration) && $this->configuration['linkTargetBlank']
         ), $identifier);
     }
 
     private function handleAdditionalData(Button $button, array $contentElement, array $contentElementConfig, array $data, BackendUserAuthentication $backendUser, int $languageUid, string $returnUrlAnchor): void
     {
-        if ((array_key_exists($contentElement['uid'], $data) && ($uid = $contentElement['uid']) && !empty($data[$uid])) ||
-            (array_key_exists('l10n_source', $contentElement) && array_key_exists($contentElement['l10n_source'], $data) && ($uid = $contentElement['l10n_source']) && !empty($data[$uid]))
+        $uid = null;
+        if (
+            (array_key_exists($contentElement['uid'], $data) && $data[$contentElement['uid']] !== []) ||
+            (
+                array_key_exists('l10n_source', $contentElement)
+                && array_key_exists($contentElement['l10n_source'], $data)
+                && $data[$contentElement['l10n_source']] !== []
+                && ($uid = $contentElement['l10n_source']) !== 0
+            )
         ) {
+            $uid = $uid ?? $contentElement['uid'];
             $button->appendChild(new Button(
                 'LLL:EXT:xima_typo3_frontend_edit/Resources/Private/Language/locallang.xlf:div_data',
                 ButtonType::Divider
             ), 'div_data');
 
             foreach ($data[$uid] as $key => $dataEntry) {
-                if (!$dataEntry['label'] || !(($dataEntry['table'] && $dataEntry['uid']) || ($dataEntry['url']))) {
+                if (!$dataEntry['label'] || !(($dataEntry['table'] !== null && $dataEntry['uid'] !== null) || ($dataEntry['url'] !== null))) {
                     continue;
                 }
 
                 $recordUid = null;
-                if ($dataEntry['table'] && $dataEntry['uid']) {
+                if ($dataEntry['table'] !== null && $dataEntry['uid'] !== null) {
                     if (!$backendUser->recordEditAccessInternals($dataEntry['table'], $dataEntry)) {
                         continue;
                     }
@@ -288,7 +296,7 @@ private function handleAdditionalData(Button $button, array $contentElement, arr
                     * Check if the record is translated and if so, get the translation
                     */
                     $record = BackendUtility::getRecord($dataEntry['table'], $recordUid);
-                    if ($record && array_key_exists('sys_language_uid', $record) && $record['sys_language_uid'] !== $languageUid) {
+                    if ($record !== null && array_key_exists('sys_language_uid', $record) && $record['sys_language_uid'] !== $languageUid) {
                         $record = ContentUtility::getTranslatedRecord($dataEntry['table'], $recordUid, $languageUid);
                         if ($record) {
                             $recordUid = $record['uid'];
@@ -298,7 +306,7 @@ private function handleAdditionalData(Button $button, array $contentElement, arr
                     }
                 }
 
-                $url = $dataEntry['url'] ?: GeneralUtility::makeInstance(UriBuilder::class)->buildUriFromRoute(
+                $url = $dataEntry['url'] !== null ? $dataEntry['url'] : GeneralUtility::makeInstance(UriBuilder::class)->buildUriFromRoute(
                     'record_edit',
                     [
                         'edit' => [
@@ -310,7 +318,7 @@ private function handleAdditionalData(Button $button, array $contentElement, arr
                         'returnUrl' => $returnUrlAnchor,
                     ],
                 )->__toString();
-                $icon = $dataEntry['icon'] ? $this->iconFactory->getIcon($dataEntry['icon'], Icon::SIZE_SMALL) : $this->iconFactory->getIcon($contentElementConfig['icon'], Icon::SIZE_SMALL);
+                $icon = $dataEntry['icon'] !== null ? $this->iconFactory->getIcon($dataEntry['icon'], IconUtility::getDefaultIconSize()) : $this->iconFactory->getIcon($contentElementConfig['icon'], IconUtility::getDefaultIconSize());
 
                 $button->appendChild(new Button(
                     ContentUtility::shortenString($dataEntry['label']),

Classes/Service/SettingsService.php

@@ -61,7 +61,7 @@ public function checkSimpleModeMenuStructure(): bool
 
         $menuStructure = $configuration['defaultMenuStructure'];
 
-        if (!is_array($menuStructure) || empty($menuStructure)) {
+        if (!is_array($menuStructure) || $menuStructure === []) {
             return false;
         }
 
@@ -79,14 +79,16 @@ public function checkSimpleModeMenuStructure(): bool
 
     private function getConfiguration(): array
     {
-        if (!empty($this->configuration)) {
+        if ($this->configuration !== []) {
             return $this->configuration;
         }
 
         if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '12.0.0', '<')) {
             $fullTypoScript = $this->getTypoScriptSetupArrayV11();
-        } else {
+        } elseif (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '13.0.0', '<')) {
             $fullTypoScript = $this->getTypoScriptSetupArrayV12($GLOBALS['TYPO3_REQUEST']);
+        } else {
+            $fullTypoScript = $this->getTypoScriptSetupArrayV13($GLOBALS['TYPO3_REQUEST']);
         }
 
         $settings = $fullTypoScript['plugin.']['tx_ximatypo3frontendedit.']['settings.'] ?? [];
@@ -104,9 +106,9 @@ private function getConfiguration(): array
     private function getTypoScriptSetupArrayV11(): array
     {
         // Ensure, TSFE setup is loaded for cached pages
-        if ($GLOBALS['TSFE']->tmpl === null || ($GLOBALS['TSFE']->tmpl && empty($GLOBALS['TSFE']->tmpl->setup))) {
-            $this->context
-                ->setAspect('typoscript', GeneralUtility::makeInstance(TypoScriptAspect::class, true)); // @phpstan-ignore-line
+        if ($GLOBALS['TSFE']->tmpl === null || ($GLOBALS['TSFE']->tmpl && $GLOBALS['TSFE']->tmpl->setup === [])) {
+            /* @phpstan-ignore-next-line */
+            $this->context->setAspect('typoscript', GeneralUtility::makeInstance(\TYPO3\CMS\Core\Context\TypoScriptAspect::class, true));
             $GLOBALS['TSFE']->getConfigArray();
         }
         return $GLOBALS['TSFE']->tmpl->setup;
@@ -116,26 +118,39 @@ private function getTypoScriptSetupArrayV12(ServerRequestInterface $request): ar
     {
         try {
             $fullTypoScript = $request->getAttribute('frontend.typoscript')->getSetupArray();
-        } catch (\Exception $e) {
+        } catch (\Exception) {
             // An exception is thrown, when TypoScript setup array is not available. This is usually the case,
             // when the current page request is cached. Therefore, the TSFE TypoScript parsing is forced here.
 
             // ToDo: This workaround is not working for TYPO3 v13
             // @see https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/13.0/Breaking-102583-RemovedContextAspectTyposcript.html#breaking-102583-1701510037
-            if (class_exists(\TYPO3\CMS\Core\Context\TypoScriptAspect::class)) {
+            if (!class_exists(\TYPO3\CMS\Core\Context\TypoScriptAspect::class)) {
                 return [];
             }
 
             // Set a TypoScriptAspect which forces template parsing
-            $this->context
-                ->setAspect('typoscript', GeneralUtility::makeInstance(TypoScriptAspect::class, true)); // @phpstan-ignore-line
+            /* @phpstan-ignore-next-line */
+            $this->context->setAspect('typoscript', GeneralUtility::makeInstance(\TYPO3\CMS\Core\Context\TypoScriptAspect::class, true));
             $tsfe = $request->getAttribute('frontend.controller');
-            $requestWithFullTypoScript = $tsfe->getFromCache($request);
+            $requestWithFullTypoScript = $tsfe->getFromCache($request); // @phpstan-ignore-line
 
             // Call TSFE getFromCache, which re-processes TypoScript respecting $forcedTemplateParsing property
             // from TypoScriptAspect
             $fullTypoScript = $requestWithFullTypoScript->getAttribute('frontend.typoscript')->getSetupArray();
         }
         return $fullTypoScript;
     }
+
+    /**
+    * @param ServerRequestInterface $request
+    * @return array
+    */
+    private function getTypoScriptSetupArrayV13(ServerRequestInterface $request): array
+    {
+        try {
+            return $request->getAttribute('frontend.typoscript')->getSetupArray();
+        } catch (\Exception) {
+            return [];
+        }
+    }
 }

Classes/Template/Component/Button.php

@@ -37,15 +37,15 @@ public function setLabel(string $label): void
     }
 
     /**
-    * @return \Xima\XimaTypo3FrontendEdit\Enumerations\ButtonType
+    * @return ButtonType
     */
     public function getType(): ButtonType
     {
         return $this->type;
     }
 
     /**
-    * @param \Xima\XimaTypo3FrontendEdit\Enumerations\ButtonType $type
+    * @param ButtonType $type
     */
     public function setType(ButtonType $type): void
     {
@@ -99,7 +99,7 @@ public function appendChild(Button $button, string|int $key): void
 
     public function appendAfterChild(Button $button, string|int $appendAfterKey, string|int $key): void
     {
-        $offset = array_search($appendAfterKey, array_keys($this->children)) + 1;
+        $offset = array_search($appendAfterKey, array_keys($this->children), true) + 1;
         $this->children = array_slice($this->children, 0, $offset, true) +
             [$key => $button] +
             array_slice($this->children, $offset, null, true);
@@ -117,17 +117,17 @@ public function render(): array
             'type' => $this->type->value,
         ];
 
-        if ($this->url) {
+        if ($this->url !== null && $this->url !== '') {
             $result['url'] = $this->url;
             $result['targetBlank'] = $this->targetBlank;
         }
 
-        if ($this->icon) {
+        if ($this->icon instanceof Icon) {
             $result['icon'] = $this->icon->getAlternativeMarkup('inline');
         }
 
-        if (!empty($this->children)) {
-            $result['children'] = array_map(fn (Button $button) => $button->render(), $this->children);
+        if ($this->children !== []) {
+            $result['children'] = array_map(static fn (Button $button) => $button->render(), $this->children);
         }
 
         return $result;

Classes/Utility/ContentUtility.php

@@ -76,7 +76,7 @@ public static function isSubpageOf(int $subPageId, int $parentPageId): bool
     {
         $rootLine = GeneralUtility::makeInstance(RootlineUtility::class, $subPageId)->get();
         foreach ($rootLine as $page) {
-            if ((int)$page['uid'] === (int)$parentPageId) {
+            if ($page['uid'] === $parentPageId) {
                 return true;
             }
         }

Classes/Utility/IconUtility.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Xima\XimaTypo3FrontendEdit\Utility;
+
+use TYPO3\CMS\Core\Imaging\IconSize;
+use TYPO3\CMS\Core\Information\Typo3Version;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+class IconUtility
+{
+    /**
+    * ToDo: Version switch be removed in TYPO3 13
+    *
+    * @return string|IconSize
+    */
+    public static function getDefaultIconSize(): string|\TYPO3\CMS\Core\Imaging\IconSize
+    {
+        $typo3Version = GeneralUtility::makeInstance(Typo3Version::class)->getMajorVersion();
+
+        if ($typo3Version >= 13) {
+            return \TYPO3\CMS\Core\Imaging\IconSize::SMALL;
+        }
+        return \TYPO3\CMS\Core\Imaging\Icon::SIZE_SMALL; // @phpstan-ignore classConstant.deprecated
+    }
+}