fixing/supressing some PHPMD issues

Author: joseph

composer.json

@@ -23,7 +23,7 @@
     "jakub-onderka/php-console-highlighter": "^0.3.2",
     "edmondscommerce/php-parallel-lint": "~1.0.1",
     "phploc/phploc": "^4.0",
-    "phpmd/phpmd": "^2.6",
+    "phpmd/phpmd": "^2.8",
     "phpstan/phpstan": "^0.12",
     "squizlabs/php_codesniffer": "~3",
     "sllh/composer-versions-check": "^2.0",

composer.lock

@@ -12,7 +12,6 @@
 use RegexIterator;
 use RuntimeException;
 use Throwable;
-
 use function current;
 use function dirname;
 use function explode;
@@ -119,6 +118,7 @@ private static function getLinks(string $file): array
     {
         $links    = [];
         $contents = (string)file_get_contents($file);
+        $matches  = null;
         if (
             preg_match_all(
                 '/\[(.+?)\].*?\((.+?)\)/',
@@ -178,31 +178,32 @@ private static function checkLink(
     /**
      * @param string[] $link
      * @param string[] $errors
+     * @SuppressWarnings(PHPMD.UndefinedVariable) - seems to not understand the static variable
      */
     private static function validateHttpLink(array $link, array &$errors, int &$return): void
     {
+        static $checked = [];
         list(, $anchor, $href) = $link;
-        static $checked        = [];
-        $hashPos               = (int)strpos($href, '#');
+        $hashPos = (int)strpos($href, '#');
         if ($hashPos > 0) {
             $href = substr($href, 0, $hashPos);
         }
         if (isset($checked[$href])) {
             return;
         }
         $checked[$href] = true;
-        //$start          = microtime(true);
-        //fwrite(STDERR, "\n".'Validating link: '.$href);
-        $context = stream_context_create([
-            'http' => [
-                'method'           => 'HEAD',
-                'protocol_version' => 1.1,
-                'header'           => [
-                    'Connection: close',
+        $context        = stream_context_create(
+            [
+                'http' => [
+                    'method'           => 'HEAD',
+                    'protocol_version' => 1.1,
+                    'header'           => [
+                        'Connection: close',
+                    ],
                 ],
-            ],
-        ]);
-        $result  = null;
+            ]
+        );
+        $result         = null;
         try {
             $headers = get_headers($href, 0, $context);
             if ($headers === false) {

src/Markdown/LinksChecker.php

@@ -57,9 +57,9 @@ public function __construct(array $ignoreRegexPatterns, string $pathToProjectRoo
     }
 
     /**
+     * @return array[]
      * @throws Exception
      *
-     * @return array[]
      */
     public function main(): array
     {
@@ -91,17 +91,17 @@ public function main(): array
      */
     private function loop(): void
     {
-        foreach ($this->yieldPhpFilesToCheck() as list($absPathRoot, $namespaceRoot, $fileInfo)) {
+        foreach ($this->yieldPhpFilesToCheck() as [$absPathRoot, $namespaceRoot, $fileInfo]) {
             $this->check($absPathRoot, $namespaceRoot, $fileInfo);
         }
     }
 
     /**
-     * @throws Exception
-     *
      * @return Generator|mixed[]
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @throws Exception
+     *
      */
     private function yieldPhpFilesToCheck(): Generator
     {
@@ -157,6 +157,7 @@ private function addMissingPathError(string $path, string $namespaceRoot, string
 
     /**
      * @return SplHeap|SplFileInfo[]
+     * @SuppressWarnings(PHPMD.UndefinedVariable) - phpmd cant handle the anon class
      */
     private function getDirectoryIterator(string $realPath): SplHeap
     {
@@ -178,8 +179,11 @@ public function __construct(RecursiveIteratorIterator $iterator)
             }
 
             /**
-             * @param mixed $item1
-             * @param mixed $item2
+             * @param SplFileInfo $item1
+             * @param SplFileInfo $item2
+             *
+             * @return int
+             *
              */
             protected function compare($item1, $item2): int
             {
@@ -211,6 +215,7 @@ private function getActualNamespace(SplFileInfo $fileInfo): string
         if ($contents === false) {
             throw new RuntimeException('Failed getting file contents for ' . $fileInfo->getPathname());
         }
+        $matches = null;
         \preg_match('%namespace\s+?([^;]+)%', $contents, $matches);
         if ([] === $matches) {
             $this->parseErrors[] = (string)$fileInfo->getRealPath();