Add analysis of variable use within HEREDOC blocks.

Fix regexp for finding variables in string blocks.
Explicit ignore of scope for class member vars.
Trial code for fixing file-scope vars (warning: untested!)

Author: illusori

Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -346,10 +346,10 @@ class Generic_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_CodeSniff
 
     /**
      * Returns an array of tokens this test wants to listen for.
-     * 
+     *
      * @return array
      */
-    public function register() {    
+    public function register() {
         //  Magic to modfy $_passByRefFunctions with any site-specific settings.
         if (!empty($this->sitePassByRefFunctions)) {
             foreach (preg_split('/\s+/', trim($this->sitePassByRefFunctions)) as $line) {
@@ -364,6 +364,7 @@ public function register() {
         return array(
             T_VARIABLE,
             T_DOUBLE_QUOTED_STRING,
+            T_HEREDOC,
             T_CLOSE_CURLY_BRACKET,
             );
     }//end register()
@@ -374,7 +375,7 @@ public function register() {
      * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
-     * 
+     *
      * @return void
      */
     public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
@@ -392,7 +393,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         if ($token['code'] === T_VARIABLE) {
             return $this->processVariable($phpcsFile, $stackPtr);
         }
-        if ($token['code'] === T_DOUBLE_QUOTED_STRING) {
+        if (($token['code'] === T_DOUBLE_QUOTED_STRING) ||
+            ($token['code'] === T_HEREDOC)) {
             return $this->processVariableInString($phpcsFile, $stackPtr);
         }
         if (($token['code'] === T_CLOSE_CURLY_BRACKET) &&
@@ -541,15 +543,29 @@ function findVariableScope(
         $tokens = $phpcsFile->getTokens();
         $token  = $tokens[$stackPtr];
 
+        $in_class = false;
         if (!empty($token['conditions'])) {
             foreach (array_reverse($token['conditions'], true) as $scopePtr => $scopeCode) {
                 if (($scopeCode === T_FUNCTION) || ($scopeCode === T_CLOSURE)) {
                     return $scopePtr;
                 }
+                if (($scopeCode === T_CLASS) || ($scopeCode === T_INTERFACE)) {
+                    $in_class = true;
+                }
             }
         }
 
-        return $this->findFunctionPrototype($phpcsFile, $stackPtr);
+        if (($scopePtr = $this->findFunctionPrototype($phpcsFile, $stackPtr)) !== false) {
+            return $scopePtr;
+        }
+
+        if ($in_class) {
+            // Member var of a class, we don't care.
+            return false;
+        }
+
+        // File scope, hmm, lets use first token of file?
+        return 0;
     }
 
     function isNextThingAnAssign(
@@ -1229,7 +1245,7 @@ protected function processVariableInString(
         $tokens = $phpcsFile->getTokens();
         $token  = $tokens[$stackPtr];
 
-        $pattern = '|[^\\\]\${?([a-zA-Z0-9_]+)}?|';
+        $pattern = '|(?<!\\\\)(?:\\\\{2})*\${?([a-zA-Z0-9_]+)}?|';
         if (!preg_match_all($pattern, $token['content'], $matches)) {
             return;
         }
@@ -1242,7 +1258,7 @@ protected function processVariableInString(
                 continue;
             }
             if ($this->checkForSuperGlobal($phpcsFile, $stackPtr, $varName, $currScope)) {
-                return;
+                continue;
             }
             $this->markVariableRead($varName, $stackPtr, $currScope);
             if ($this->isVariableUndefined($varName, $stackPtr, $currScope) === true) {

Tests/CodeAnalysis/VariableAnalysisUnitTest.inc

@@ -4,6 +4,7 @@ function function_without_param() {
     echo $var;
     echo "xxx $var xxx";
     echo "xxx {$var} xxx";
+    echo "xxx ${var} xxx";
     echo "xxx $var $var2 xxx";
     echo "xxx {$var} {$var2} xxx";
     func($var);
@@ -375,4 +376,19 @@ function function_with_superglobals() {
     echo print_r($_REQUEST, true);
     echo print_r($_ENV, true);
     echo "$GLOBALS['whatever']";
+    echo "$GLOBALS['whatever'] $var";
+}
+
+function function_with_heredoc() {
+    $var = 10;
+    echo <<<END_OF_TEXT
+$var
+{$var}
+${var}
+$var2
+{$var2}
+${var2}
+\$var2
+\\$var2
+END_OF_TEXT;
 }

Tests/CodeAnalysis/VariableAnalysisUnitTest.php

@@ -59,18 +59,19 @@ private function _getWarningAndErrorList() {
                 ($base += 3)  => 0,
                 ($base + 1)   => 1,  //  $var
                 ($base + 2)   => 1,  //  $var
-                ($base + 3)   => 1,  //  $var
-                ($base + 4)   => 2,  //  $var $var2
+                ($base + 3)   => 1,  //  {$var}
+                ($base + 4)   => 1,  //  ${var}
                 ($base + 5)   => 2,  //  $var $var2
-                ($base + 6)   => 1,  //  $var
+                ($base + 6)   => 2,  //  $var $var2
                 ($base + 7)   => 1,  //  $var
                 ($base + 8)   => 1,  //  $var
                 ($base + 9)   => 1,  //  $var
-                ($base + 14)  => 1,  //  $var2
+                ($base + 10)   => 1,  //  $var
                 ($base + 15)  => 1,  //  $var2
-                //  function_with_param() line (+23)
+                ($base + 16)  => 1,  //  $var2
+                //  function_with_param() line (+24)
                 //    no warnings.
-                ($base += 23) => 0,
+                ($base += 24) => 0,
                 //  function_with_default_defined_param() line (+11)
                 ($base += 11) => 0,
                 ($base + 0)   => 1,  //  $unused
@@ -205,8 +206,14 @@ private function _getWarningAndErrorList() {
                 //    no warnings.
                 ($base += 19) => 0,
                 //  function_with_superglobals() line (+11)
-                //    no warnings.
                 ($base += 11) => 0,
+                ($base + 11)  => 1,  //  $var
+                //  function_with_heredoc() line (+14)
+                ($base += 14) => 0,
+                ($base + 6)   => 1,  //  $var2
+                ($base + 7)   => 1,  //  {$var2}
+                ($base + 8)   => 1,  //  ${var2}
+                ($base + 10)  => 1,  //  \\$var2
                );
     }//end _getWarningAndErrorList()