Fix handling property PHPDocs with unsupported type

PHP-CS-Fixer · Apr 12, 2020 · 38cb8bc · 38cb8bc
1 parent 13492d1
commit 38cb8bc
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 16 deletions.
diff --git a/src/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixer.php b/src/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixer.php
@@ -230,32 +230,25 @@ private function fixFunctionDocComment($content, Tokens $tokens, $functionIndex,
 
     /**
      * @param string $content
-     * @param int    $docCommentIndex
+     * @param int    $index   Index of the DocComment token
      *
      * @return string
      */
-    private function fixPropertyDocComment($content, Tokens $tokens, $docCommentIndex, array $shortNames)
+    private function fixPropertyDocComment($content, Tokens $tokens, $index, array $shortNames)
     {
         $docBlock = new DocBlock($content);
 
-        $index = $tokens->getNextMeaningfulToken($docCommentIndex);
-
-        $kindsBeforeProperty = [T_STATIC, T_PRIVATE, T_PROTECTED, T_PUBLIC];
-
-        if (!$tokens[$index]->isGivenKind($kindsBeforeProperty)) {
-            return $content;
-        }
-
         do {
             $index = $tokens->getNextMeaningfulToken($index);
+        } while ($tokens[$index]->isGivenKind([T_STATIC, T_PRIVATE, T_PROTECTED, T_PUBLIC]));
 
-            $propertyTypeInfo = $this->parseTypeHint($tokens, $index);
-            foreach ($docBlock->getAnnotationsOfType('var') as $annotation) {
-                if ($this->annotationIsSuperfluous($annotation, $propertyTypeInfo, $shortNames)) {
-                    $annotation->remove();
-                }
+        $propertyTypeInfo = $this->getPropertyTypeInfo($tokens, $index);
+
+        foreach ($docBlock->getAnnotationsOfType('var') as $annotation) {
+            if ($this->annotationIsSuperfluous($annotation, $propertyTypeInfo, $shortNames)) {
+                $annotation->remove();
             }
-        } while ($tokens[$index]->isGivenKind($kindsBeforeProperty));
+        }
 
         return $docBlock->getContent();
     }
@@ -318,6 +311,23 @@ private function getReturnTypeInfo(Tokens $tokens, $closingParenthesisIndex)
         ];
     }
 
+    /**
+     * @param int $index The index of the first token of the type hint
+     *
+     * @return array
+     */
+    private function getPropertyTypeInfo(Tokens $tokens, $index)
+    {
+        if ($tokens[$index]->isGivenKind(T_VARIABLE)) {
+            return [
+                'type' => null,
+                'allows_null' => true,
+            ];
+        }
+
+        return $this->parseTypeHint($tokens, $index);
+    }
+
     /**
      * @param int $index The index of the first token of the type hint
      *

diff --git a/tests/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixerTest.php b/tests/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixerTest.php
@@ -406,6 +406,25 @@ class Foo {
      * {@inheritdocs}
      */
     private $foo;
+}',
+            ],
+            'property with unsupported type' => [
+                '<?php
+class Foo {
+    /**
+     * @var foo:bar
+     */
+    private $foo;
+}',
+            ],
+            'method with unsupported types' => [
+                '<?php
+class Foo {
+    /**
+     * @param foo:bar $foo
+     * @return foo:bar
+     */
+    public function foo($foo) {}
 }',
             ],
         ];