[TASK] Fix code quality tools issues

wazum · Dec 16, 2024 · b9dc6fe · b9dc6fe
1 parent 439aaf6
commit b9dc6fe
Show file tree

Hide file tree

Showing 13 changed files with 88 additions and 15 deletions.
diff --git a/Build/php-cs-fixer.config.php b/Build/php-cs-fixer.config.php
@@ -29,7 +29,7 @@
         'declare_parentheses' => true,
         'dir_constant' => true,
         'ereg_to_preg' => true,
-        'escape_implicit_backslashes' => true,
+        'string_implicit_backslashes' => true,
         'explicit_indirect_variable' => true,
         'explicit_string_variable' => true,
         'fopen_flags' => ['b_mode' => false],

diff --git a/Build/psalm.xml b/Build/psalm.xml
@@ -3,19 +3,24 @@
        cacheDirectory="../.Build/"
        errorLevel="5"
        hideExternalErrors="true"
-	   phpVersion="8.1">
+       phpVersion="8.2">
     <projectFiles>
-		<directory name="../" />
+		<directory name="../Classes" />
 		<ignoreFiles>
 			<directory name="../Build" />
 			<directory name="../.Build" />
 		</ignoreFiles>
     </projectFiles>
 	<issueHandlers>
-		<UndefinedClass>
+		<UnusedClass>
 			<errorLevel type="suppress">
-				<referencedClass name="Wazum\Sluggi\Upgrade\SlugLockUpgradeWizard" />
+				<directory name="../Classes"/>
 			</errorLevel>
-		</UndefinedClass>
+		</UnusedClass>
+		<UnusedParam>
+			<errorLevel type="suppress">
+				<directory name="../Classes/DataHandler"/>
+			</errorLevel>
+		</UnusedParam>
 	</issueHandlers>
 </psalm>
diff --git a/Classes/Backend/Form/InputSlugElement.php b/Classes/Backend/Form/InputSlugElement.php
@@ -12,7 +12,7 @@
 final class InputSlugElement extends \TYPO3\CMS\Backend\Form\Element\InputSlugElement
 {
     /**
-     * @return array<array-key, mixed>
+     * @return array<string, mixed>
      */
     public function render(): array
     {
@@ -37,6 +37,11 @@ public function render(): array
         return $result;
     }
 
+    /**
+     * @param array<string, mixed> $result
+     *
+     * @return array<string, mixed>
+     */
     private function setStatusDataAttributes(array $result): array
     {
         $attributes = [
@@ -57,6 +62,11 @@ private function setStatusDataAttributes(array $result): array
         return $result;
     }
 
+    /**
+     * @param array<string, mixed> $result
+     *
+     * @return array<string, mixed>
+     */
     private function updateUiForRestrictedAccess(array $result): array
     {
         $languageId = $this->getLanguageId($this->data['tableName'], $this->data['databaseRow']);
@@ -84,6 +94,9 @@ private function updateUiForRestrictedAccess(array $result): array
         return $result;
     }
 
+    /**
+     * @param array<string, mixed> $row
+     */
     private function getLanguageId(string $table, array $row): int
     {
         if (isset($GLOBALS['TCA'][$table]['ctrl']['languageField'])

diff --git a/Classes/Backend/Form/InputTextWithSlugImpactElement.php b/Classes/Backend/Form/InputTextWithSlugImpactElement.php
@@ -10,7 +10,7 @@
 class InputTextWithSlugImpactElement extends InputTextElement
 {
     /**
-     * @return array<array-key, mixed>
+     * @return array<string, mixed>
      */
     public function render(): array
     {
@@ -22,7 +22,7 @@ public function render(): array
     }
 
     /**
-     * @return array<array-key, mixed>
+     * @return array<string, mixed>
      */
     protected function renderWithImpactMark(): array
     {

diff --git a/Classes/Backend/PageRendererRenderPreProcess.php b/Classes/Backend/PageRendererRenderPreProcess.php
@@ -11,6 +11,8 @@ final class PageRendererRenderPreProcess
 {
     /**
      * @param array<array-key, mixed> $params
+     *
+     * @psalm-suppress UnusedParam
      */
     public function run(array $params, PageRenderer $pageRenderer): void
     {

diff --git a/Classes/Backend/SlugModifier.php b/Classes/Backend/SlugModifier.php
@@ -6,6 +6,10 @@
 
 final class SlugModifier extends \B13\Masi\SlugModifier
 {
+    /**
+     * @param array<array-key, mixed> $configuration
+     * @param array<array-key, mixed> $record
+     */
     protected function resolveHookParameters(array $configuration, string $tableName, string $fieldName, int $pid, int $workspaceId, array $record): void
     {
         parent::resolveHookParameters($configuration, $tableName, $fieldName, $pid, $workspaceId, $record);

diff --git a/Classes/DataHandler/HandleExcludeSlugForSubpages.php b/Classes/DataHandler/HandleExcludeSlugForSubpages.php
@@ -1,5 +1,7 @@
 <?php
 
+// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
 declare(strict_types=1);
 
 namespace Wazum\Sluggi\DataHandler;
@@ -35,6 +37,8 @@ public function __construct(
     }
 
     /**
+     * @param array<string, mixed> $fields
+     *
      * @throws \Exception
      * @throws Exception
      */
@@ -76,6 +80,8 @@ public function processDatamap_afterDatabaseOperations(
     /**
      * Method copied from \TYPO3\CMS\Redirects\Service\SlugService.
      *
+     * @return array<array-key, mixed>
+     *
      * @throws \Exception
      * @throws Exception
      */
@@ -163,6 +169,9 @@ private function disableHook(): void
         unset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass']['sluggi-exclude']);
     }
 
+    /**
+     * @param array<string, mixed> $fields
+     */
     private function shouldRun(string $status, string $table, array $fields): bool
     {
         return 'update' === $status && 'pages' === $table && isset($fields['exclude_slug_for_subpages']);

diff --git a/Classes/DataHandler/HandlePageCopy.php b/Classes/DataHandler/HandlePageCopy.php
@@ -1,5 +1,7 @@
 <?php
 
+// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
 declare(strict_types=1);
 
 namespace Wazum\Sluggi\DataHandler;
@@ -27,13 +29,16 @@ public function __construct()
         );
     }
 
+    /**
+     * @param array<array-key, mixed> $pasteDataMap
+     */
     public function processCmdmap_postProcess(
         string $command,
         string $table,
         string|int $id,
-        $value,
+        string|int $value,
         DataHandler $dataHandler,
-        $pasteUpdate,
+        bool $pasteUpdate,
         array &$pasteDataMap,
     ): void {
         if ('copy' !== $command || 'pages' !== $table) {
@@ -70,6 +75,9 @@ public function processCmdmap_postProcess(
         }
     }
 
+    /**
+     * @param array<array-key, mixed> $pasteDataMap
+     */
     private function handleAllChildPages(int $id, string $parentSlug, int $languageId, DataHandler $dataHandler, array &$pasteDataMap): void
     {
         foreach ($this->getChildPagesFor($id, $languageId) as $childPage) {
@@ -90,6 +98,11 @@ private function handleAllChildPages(int $id, string $parentSlug, int $languageI
         }
     }
 
+    /**
+     * @return array<array-key, array<string, mixed>>
+     *
+     * @throws \Doctrine\DBAL\Exception
+     */
     private function getChildPagesFor(int $parentPageId, int $languageId): array
     {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)

diff --git a/Classes/DataHandler/HandlePageMove.php b/Classes/DataHandler/HandlePageMove.php
@@ -1,5 +1,7 @@
 <?php
 
+// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
 declare(strict_types=1);
 
 namespace Wazum\Sluggi\DataHandler;
@@ -13,6 +15,10 @@
 
 final class HandlePageMove
 {
+    /**
+     * @param array<string, mixed> $moveRecord
+     * @param array<string, mixed> $updateFields
+     */
     public function moveRecord_afterAnotherElementPostProcess(
         /* @noinspection PhpUnusedParameterInspection */
         string $table,
@@ -30,6 +36,10 @@ public function moveRecord_afterAnotherElementPostProcess(
         $this->updateSlugForMovedPage($id, $targetId, $dataHandler);
     }
 
+    /**
+     * @param array<string, mixed> $moveRecord
+     * @param array<string, mixed> $updateFields
+     */
     public function moveRecord_firstElementPostProcess(
         /* @noinspection PhpUnusedParameterInspection */
         string $table,
@@ -67,7 +77,6 @@ private function updateSlugForMovedPage(int $id, int $targetId, DataHandler $dat
 
         $data = [];
         $data['pages'][$id]['slug'] = $newSlug;
-        /** @var DataHandler $localDataHandler */
         $localDataHandler = GeneralUtility::makeInstance(DataHandler::class);
         $localDataHandler->start($data, []);
         $localDataHandler->setCorrelationId($dataHandler->getCorrelationId());

diff --git a/Classes/DataHandler/HandlePageUpdate.php b/Classes/DataHandler/HandlePageUpdate.php
@@ -86,6 +86,9 @@ public function processDatamap_preProcessFieldArray(
         $fields = $this->prependInaccessibleSlugSegments($pageRecord, $fields);
     }
 
+    /**
+     * @param array<string, mixed> $fields
+     */
     public function processDatamap_postProcessFieldArray(
         string $status,
         string $table,
@@ -173,7 +176,6 @@ private function mergePageRecordWithIncomingFields(array $pageRecord, array $fie
      */
     private function regenerateSlug(array $pageRecord): string
     {
-        /** @var SlugHelper $helper */
         $helper = GeneralUtility::makeInstance(
             SlugHelper::class,
             'pages',
@@ -295,6 +297,9 @@ private function sanitizeSlug(string $slug): string
         return '/' . ltrim($slug, '/');
     }
 
+    /**
+     * @param array<string, mixed> $fields
+     */
     private function isManualUpdateWithOnlyLastSegmentAllowed(array $fields): bool
     {
         return isset($fields['slug']) && Configuration::get('last_segment_only') && !PermissionHelper::hasFullPermission();
@@ -308,7 +313,6 @@ private function isManualUpdateWithOnlyLastSegmentAllowed(array $fields): bool
      */
     private function updateLastSegment(array $pageRecord, array $fields): array
     {
-        /** @var SlugHelper $helper */
         $helper = GeneralUtility::makeInstance(
             SlugHelper::class,
             'pages',

diff --git a/Classes/Helper/PermissionHelper.php b/Classes/Helper/PermissionHelper.php
@@ -30,6 +30,9 @@ public static function hasFullPermission(): bool
         return false;
     }
 
+    /**
+     * @param array<string, mixed> $page
+     */
     public static function isLocked(array $page): bool
     {
         return (bool) $page['slug_locked'];
@@ -40,6 +43,9 @@ public static function hasSlugLockAccess(): bool
         return self::getBackendUser()->check('non_exclude_fields', 'pages:slug_locked');
     }
 
+    /**
+     * @return array<string, mixed>|null
+     */
     public static function getTopmostAccessiblePage(int $pageId): ?array
     {
         $rootLine = BackendUtility::BEgetRootLine(

diff --git a/Classes/Service/SlugService.php b/Classes/Service/SlugService.php
@@ -15,6 +15,9 @@
 
 final class SlugService extends \TYPO3\CMS\Redirects\Service\SlugService
 {
+    /**
+     * @psalm-suppress PossiblyUnusedMethod
+     */
     public function __construct(
         Context $context,
         PageRepository $pageRepository,
@@ -36,7 +39,9 @@ public function __construct(
     }
 
     /**
-     * @return string[] all unique source hosts for created redirects
+     * @param array<array-key, mixed> $currentPageRecord
+     *
+     * @return string[]
      */
     protected function checkSubPages(array $currentPageRecord, SlugRedirectChangeItem $parentChangeItem): array
     {

diff --git a/Classes/Upgrade/SlugLockUpgradeWizard.php b/Classes/Upgrade/SlugLockUpgradeWizard.php
@@ -50,6 +50,9 @@ public function updateNecessary(): bool
         return false;
     }
 
+    /**
+     * @return string[]
+     */
     public function getPrerequisites(): array
     {
         return [
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,8 @@ final class PageRendererRenderPreProcess @@
     {
         /**
          * @param array<array-key, mixed> $params
+         *
+         * @psalm-suppress UnusedParam
          */
         public function run(array $params, PageRenderer $pageRenderer): void
         {
@@ Expand Down @@