[TASK] fix / suppress phpmd violations

Relates: https://projekte.in2code.de/issues/74304

Author: sebastianstein

.phpmd.xml

@@ -5,27 +5,33 @@
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
          xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
 >
-  <description>
-    Adapted the phpmd default config.
-    * Import all rule sets
-    * Allow variables as long as 25 chars
-  </description>
+    <description>
+        Adapted the phpmd default config.
+        * Import all rule sets
+        * Allow variables as long as 25 chars
+    </description>
 
-  <rule ref="rulesets/codesize.xml" />
-  <rule ref="rulesets/controversial.xml" />
-  <rule ref="rulesets/design.xml" />
-  <rule ref="rulesets/naming.xml">
-    <exclude name="LongVariable" />
-  </rule>
-  <rule ref="rulesets/naming.xml/LongVariable">
-    <properties>
-      <property name="maximum" value="30" />
-    </properties>
-  </rule>
-  <rule ref="rulesets/unusedcode.xml" />
-  <rule ref="rulesets/cleancode.xml">
-    <exclude name="StaticAccess" />
-    <exclude name="ElseExpression" />
-    <exclude name="StaticAccess"/>
-  </rule>
+    <rule ref="rulesets/codesize.xml"/>
+    <rule ref="rulesets/controversial.xml"/>
+    <rule ref="rulesets/design.xml"/>
+    <rule ref="rulesets/naming.xml">
+        <exclude name="LongVariable"/>
+        <exclude name="LongClassName"/>
+    </rule>
+    <rule ref="rulesets/naming.xml/LongVariable">
+        <properties>
+            <property name="maximum" value="50"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/naming.xml/LongVariable">
+        <properties>
+            <property name="maximum" value="30"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/unusedcode.xml"/>
+    <rule ref="rulesets/cleancode.xml">
+        <exclude name="StaticAccess"/>
+        <exclude name="ElseExpression"/>
+        <exclude name="StaticAccess"/>
+    </rule>
 </ruleset>

Classes/Service/FilterService.php

@@ -6,6 +6,7 @@
 
 use In2code\In2studyfinder\Domain\Model\StudyCourse;
 use In2code\In2studyfinder\Settings\ExtensionSettingsInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerInterface;
 use TYPO3\CMS\Core\Context\LanguageAspect;
 use TYPO3\CMS\Core\Utility\ClassNamingUtility;
@@ -16,6 +17,12 @@
 use TYPO3\CMS\Extbase\Reflection\ObjectAccess;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
+/**
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ * @todo refactor:
+ *  - services should be stateless (see: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/PhpArchitecture/Services.html)
+ *  - reduce complexity
+ */
 class FilterService
 {
     protected array $settings = [];
@@ -85,10 +92,10 @@ public function resolveFilterPropertyPath(array $searchOptions): array
     public function loadOrSetPersistedFilter(array $searchOptions): array
     {
         if ($searchOptions !== []) {
-            $GLOBALS['TYPO3_REQUEST']->getAttribute('frontend.user')
+            $this->getRequest()->getAttribute('frontend.user')
                 ->setAndSaveSessionData('tx_in2studycourse_filter', array_filter($searchOptions));
         } else {
-            $sessionData = $GLOBALS['TYPO3_REQUEST']->getAttribute('frontend.user')
+            $sessionData = $this->getRequest()->getAttribute('frontend.user')
                 ->getSessionData('tx_in2studycourse_filter');
             if (!empty($sessionData)) {
                 return (array)$sessionData;
@@ -287,4 +294,12 @@ protected function getTypoScriptFilterConfiguration(): array
 
         return [];
     }
+
+    /**
+     * @SuppressWarnings(PHPMD.Superglobals)
+     */
+    private function getRequest(): ServerRequestInterface
+    {
+        return $GLOBALS['TYPO3_REQUEST'];
+    }
 }

Classes/Settings/ExtensionSettings.php

@@ -96,7 +96,7 @@ protected function getStoragePidsByConfiguration(array $configuration): array
     {
         $storagePids = [];
 
-        foreach ($configuration as $type => $typeConfiguration) {
+        foreach ($configuration as $typeConfiguration) {
             $pids = GeneralUtility::intExplode(',', $typeConfiguration['pids']);
 
             if (array_key_exists('recursive', $typeConfiguration) && $typeConfiguration['recursive'] > 0) {
@@ -115,6 +115,9 @@ protected function getStoragePidsByConfiguration(array $configuration): array
         return array_unique($storagePids);
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.Superglobals)
+     */
     protected function getRequest(): ServerRequestInterface
     {
         return $GLOBALS['TYPO3_REQUEST'];

Classes/Utility/CacheUtility.php

@@ -20,6 +20,8 @@ class CacheUtility
      *
      * Following cache tags will be added to tsfe:
      * "tx_in2studyfinder_uid_[course:uid]"
+     *
+     * @SuppressWarnings(PHPMD.Superglobals)
      */
     public static function addCacheTags(QueryResultInterface|array $records): void
     {

Classes/Utility/FrontendUtility.php

@@ -12,6 +12,9 @@
 
 class FrontendUtility
 {
+    /**
+     * @SuppressWarnings(PHPMD.Superglobals)
+     */
     public static function getCurrentPageIdentifier(): int
     {
         return $GLOBALS['TYPO3_REQUEST']->getAttribute('frontend.page.information')->getId();

Classes/ViewHelpers/Form/SelectViewHelper.php

@@ -13,6 +13,8 @@
  * @todo refactor
  *
  * this is currently the default select viewHelper with additional functionality
+ *
+ * @SuppressWarnings(PHPMD.NPathComplexity)
  */
 class SelectViewHelper extends AbstractSelectViewHelper
 {