VariableAnalysisSniff::checkForGlobalDeclaration(): fix comment tolerance (#153)

PHP ignores comments in unexpected/unconventional places and so should the sniff.

Includes adjusting an existing unit test.

Without the fix, the adjusted unit test would cause test failures.

Author: jrfnl

VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -883,8 +883,12 @@ protected function checkForGlobalDeclaration(File $phpcsFile, $stackPtr, $varNam
     $tokens = $phpcsFile->getTokens();
 
     // Are we a global declaration?
-    // Search backwards for first token that isn't whitespace, comma or variable.
-    $globalPtr = $phpcsFile->findPrevious([T_WHITESPACE, T_VARIABLE, T_COMMA], $stackPtr - 1, null, true, null, true);
+    // Search backwards for first token that isn't whitespace/comment, comma or variable.
+    $ignore             = Tokens::$emptyTokens;
+    $ignore[T_VARIABLE] = T_VARIABLE;
+    $ignore[T_COMMA]    = T_COMMA;
+
+    $globalPtr = $phpcsFile->findPrevious($ignore, $stackPtr - 1, null, true, null, true);
     if (($globalPtr === false) || ($tokens[$globalPtr]['code'] !== T_GLOBAL)) {
       return false;
     }

VariableAnalysis/Tests/CodeAnalysis/fixtures/FunctionWithGlobalVarFixture.php

@@ -1,7 +1,7 @@
 <?php
 
 function function_with_global_var() {
-    global $var, $var2, $unused; // should warn that `unused` is unused
+    global $var, /*comment*/ $var2, $unused; // should warn that `unused` is unused
 
     echo $var;
     echo $var3; // should warn that var is undefined