🐛 Handle multiple class in doc comment string

Author: Vincent Langlet

Symfony3Custom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -132,19 +132,38 @@ public function process(File $phpcsFile, $stackPtr)
             );
         }
 
-        // Check for doc comment tags
+        // More checks
         foreach ($tokens as $token) {
+            // Check for doc params @...
             if ('T_DOC_COMMENT_TAG' === $token['type']) {
                 // Handle comment tag as @Route(..) or @ORM\Id
                 if (preg_match('/^@'.$lowerClassName.'(?![a-zA-Z])/i', $token['content']) === 1) {
                     return;
                 };
             }
-        }
 
-        $warning = 'Unused use statement';
-        $fix     = $phpcsFile->addFixableError($warning, $stackPtr, 'UnusedUse');
+            // Check for @param Truc or @return Machin
+            if ('T_DOC_COMMENT_STRING' === $token['type']) {
+                // Handle @return Machin|Machine
+                if (preg_match('/^'.$lowerClassName.'\|/i', $token['content']) === 1
+                || preg_match('/\|'.$lowerClassName.'\|/i', $token['content']) === 1
+                || preg_match('/\|'.$lowerClassName.'$/i', $token['content']) === 1) {
+                    $beforeUsage = $phpcsFile->findPrevious(
+                        Tokens::$emptyTokens,
+                        ($classUsed - 1),
+                        null,
+                        true
+                    );
+
+                    // If a backslash is used before the class name then this is some other use statement.
+                    if (T_USE !== $tokens[$beforeUsage]['code'] && T_NS_SEPARATOR !== $tokens[$beforeUsage]['code']) {
+                        return;
+                    }
+                }
+            }
+        }
 
+        $fix = $phpcsFile->addFixableError('Unused use statement', $stackPtr, 'UnusedUse');
         if (true === $fix) {
             // Remove the whole use statement line.
             $phpcsFile->fixer->beginChangeset();

Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc

@@ -8,6 +8,7 @@ use Route;
 use ORM;
 use Truc;
 use Machin;
+use Machine;
 use Unused;
 
 class Container
@@ -19,7 +20,7 @@ class Container
      *
      * @param Toto
      * @var Truc
-     * @return Machin
+     * @return Machin|Machine
      */
     function test (Bar $bar)
     {

Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc.fixed

@@ -8,6 +8,7 @@ use Route;
 use ORM;
 use Truc;
 use Machin;
+use Machine;
 
 class Container
 {
@@ -18,7 +19,7 @@ class Container
      *
      * @param Toto
      * @var Truc
-     * @return Machin
+     * @return Machin|Machine
      */
     function test (Bar $bar)
     {

Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.php

@@ -22,7 +22,7 @@ class UnusedUseUnitTest extends AbstractSniffUnitTest
     public function getErrorList()
     {
         return array(
-            11 => 1,
+            12 => 1,
         );
     }