Fixed empty @return tag. Issue #7.

php-censor · Oct 7, 2023 · 263a580 · 263a580
1 parent 6b68df9
commit 263a580
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 12 deletions.
diff --git a/src/CheckerFileProcessor.php b/src/CheckerFileProcessor.php
@@ -148,6 +148,10 @@ public function processFile(string $file): array
                             continue;
                         }
 
+                        if ($method['return'] === 'void') {
+                            continue;
+                        }
+
                         $warnings[] = [
                             'type'   => 'return-missing',
                             'file'   => $file,

diff --git a/src/FileProcessor.php b/src/FileProcessor.php
@@ -242,11 +242,13 @@ protected function processDocblock(string $text, array $uses = []): array
             }
 
             $types = [];
-            foreach (\explode('|', $type) as $tmpType) {
-                if (isset($uses[$tmpType])) {
-                    $tmpType = $uses[$tmpType];
+            if ($type) {
+                foreach (\explode('|', $type) as $tmpType) {
+                    if (isset($uses[$tmpType])) {
+                        $tmpType = $uses[$tmpType];
+                    }
+                    $types[] = \substr($tmpType, 0, 1) === '\\' ? \substr($tmpType, 1) : $tmpType;
                 }
-                $types[] = \substr($tmpType, 0, 1) === '\\' ? \substr($tmpType, 1) : $tmpType;
             }
             $result['return'] = \implode('|', $types);
         }

diff --git a/tests/data/TestClass.php b/tests/data/TestClass.php
@@ -59,6 +59,33 @@ public function test121(int $param1): bool
         return false;
     }
 
+    /**
+     * @param int $param1
+     *
+     * @return
+     */
+    public function test122(int $param1)
+    {
+    }
+
+    /**
+     * @param int $param1
+     *
+     * @return
+     */
+    public function test123(int $param1): void
+    {
+    }
+
+    /**
+     * @param int $param1
+     *
+     * @return
+     */
+    public function test124(int $param1): bool
+    {
+    }
+
     /**
      * @param int|null $param1
      *

diff --git a/tests/src/CheckerFileProcessorTest.php b/tests/src/CheckerFileProcessorTest.php
@@ -114,12 +114,18 @@ public function testProcessFile()
                         'param'      => '$param1',
                         'param-type' => 'int',
                         'doc-type'   => 'int|null',
+                    ],                 [
+                        'type'   => 'return-missing',
+                        'file'   => 'TestClass.php',
+                        'class'  => 'Test\Example\TestClass',
+                        'method' => 'test124',
+                        'line'   => 85,
                     ], [
                         'type'       => 'param-mismatch',
                         'file'       => 'TestClass.php',
                         'class'      => 'Test\Example\TestClass',
                         'method'     => 'test132',
-                        'line'       => 87,
+                        'line'       => 114,
                         'param'      => '$param1',
                         'param-type' => 'int|null',
                         'doc-type'   => 'int',
@@ -128,15 +134,15 @@ public function testProcessFile()
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test132',
-                        'line'        => 87,
+                        'line'        => 114,
                         'return-type' => 'bool|null',
                         'doc-type'    => 'bool',
                     ], [
                         'type'        => 'param-mismatch',
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test141',
-                        'line'        => 117,
+                        'line'        => 144,
                         'param'      => '$param1',
                         'param-type' => 'int|float',
                         'doc-type'   => 'int',
@@ -145,7 +151,7 @@ public function testProcessFile()
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test141',
-                        'line'        => 117,
+                        'line'        => 144,
                         'return-type' => 'bool|int',
                         'doc-type'    => 'bool',
                     ]
@@ -256,12 +262,18 @@ public function testProcessFile()
                         'line'        => 57,
                         'doc-type'    => 'bool|int',
                         'return-type' => 'bool'
+                    ],                 [
+                        'type'   => 'return-missing',
+                        'file'   => 'TestClass.php',
+                        'class'  => 'Test\Example\TestClass',
+                        'method' => 'test124',
+                        'line'   => 85,
                     ], [
                         'type'       => 'param-mismatch',
                         'file'       => 'TestClass.php',
                         'class'      => 'Test\Example\TestClass',
                         'method'     => 'test132',
-                        'line'       => 87,
+                        'line'       => 114,
                         'param'      => '$param1',
                         'param-type' => 'int|null',
                         'doc-type'   => 'int',
@@ -270,15 +282,15 @@ public function testProcessFile()
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test132',
-                        'line'        => 87,
+                        'line'        => 114,
                         'return-type' => 'bool|null',
                         'doc-type'    => 'bool',
                     ], [
                         'type'        => 'param-mismatch',
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test141',
-                        'line'        => 117,
+                        'line'        => 144,
                         'param'      => '$param1',
                         'param-type' => 'int|float',
                         'doc-type'   => 'int',
@@ -287,7 +299,7 @@ public function testProcessFile()
                         'file'        => 'TestClass.php',
                         'class'       => 'Test\Example\TestClass',
                         'method'      => 'test141',
-                        'line'        => 117,
+                        'line'        => 144,
                         'return-type' => 'bool|int',
                         'doc-type'    => 'bool',
                     ]