Now recognises assign-by-heredoc in static variable declarations.

Author: illusori

README.mkdn

@@ -29,4 +29,3 @@ KNOWN ISSUES & BUGS
 -------------------
 
  * File scope isn't currently analysed.
- * Heredoc/nowdoc in static variable assign-while-declaring may confuse things.

Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -960,24 +960,27 @@ protected function checkForStaticDeclaration(
         // can contain assignments. The assignment is compile-time however so can
         // only be constant values, which makes life manageable.
         // Valid values are:
-        //   number T_MINUS T_LNUMBER T_DNUMBER
-        //   string T_CONSTANT_ENCAPSED_STRING
-        //   define T_STRING
-        //   class constant T_STRING, T_DOUBLE_COLON, T_STRING
-        // TODO: assignment can be via heredoc, just to confuse matters
+        //   number         T_MINUS T_LNUMBER T_DNUMBER
+        //   string         T_CONSTANT_ENCAPSED_STRING
+        //   heredoc        T_START_HEREDOC T_HEREDOC T_END_HEREDOC
+        //   define         T_STRING
+        //   class constant T_STRING T_DOUBLE_COLON T_STRING
         // Search backwards for first token that isn't whitespace, comma, variable,
         // equals, or on the list of assignable constant values above.
         $staticPtr = $phpcsFile->findPrevious(
-            array(T_WHITESPACE, T_VARIABLE, T_COMMA, T_EQUAL,
-                  T_MINUS, T_LNUMBER, T_DNUMBER,
-                  T_CONSTANT_ENCAPSED_STRING,
-                  T_STRING,
-                  T_DOUBLE_COLON),
+            array(
+                T_WHITESPACE, T_VARIABLE, T_COMMA, T_EQUAL,
+                T_MINUS, T_LNUMBER, T_DNUMBER,
+                T_CONSTANT_ENCAPSED_STRING,
+                T_STRING,
+                T_DOUBLE_COLON,
+                T_START_HEREDOC, T_HEREDOC, T_END_HEREDOC,
+                ),
             $stackPtr - 1, null, true, null, true);
-        //if ($varName == 'static2') {
-        //echo "Failing token:\n" . print_r($tokens[$staticPtr], true);
-        //}
         if (($staticPtr === false) || ($tokens[$staticPtr]['code'] !== T_STATIC)) {
+            //if ($varName == 'static4') {
+            //    echo "Failing token:\n" . print_r($tokens[$staticPtr], true);
+            //}
             return false;
         }
 

Tests/CodeAnalysis/VariableAnalysisUnitTest.inc

@@ -220,10 +220,22 @@ function &function_with_return_by_reference_and_param($param) {
 
 function function_with_static_var() {
     static $static1, $static_num = 12, $static_neg_num = -1.5, $static_string = 'abc', $static_string2 = "def", $static_define = MYDEFINE, $static_constant = MyClass::CONSTANT, $static2;
+    static $static_heredoc = <<<END_OF_HEREDOC
+this is an ugly but valid way to continue after a heredoc
+END_OF_HEREDOC
+        , $static3;
+    static $static_nowdoc = <<<'END_OF_NOWDOC'
+this is an ugly but valid way to continue after a nowdoc
+END_OF_NOWDOC
+        , $static4;
     echo $static1;
     echo $static_num;
     echo $static2;
     echo $var;
+    echo $static_heredoc;
+    echo $static3;
+    echo $static_nowdoc;
+    echo $static4;
 }
 
 function function_with_pass_by_reference_param(&$param) {

Tests/CodeAnalysis/VariableAnalysisUnitTest.php

@@ -154,10 +154,10 @@ private function _getWarningAndErrorList() {
                 ($base += 5)  => 0,
                 ($base + 1)   => 1, // 5,  //  $static_neg_num, $static_string, $static_string2,
                                      //  $static_define, $static_constant
-                ($base + 5)   => 1,  //  $var
-                //  function_with_pass_by_reference_param() line (+8)
+                ($base + 13)   => 1,  //  $var
+                //  function_with_pass_by_reference_param() line (+20)
                 //    no warnings.
-                ($base += 8)  => 0,
+                ($base += 20)  => 0,
                 //  function_with_pass_by_reference_calls() line (+4)
                 ($base += 4)  => 0,
                 ($base + 1)   => 1,  //  $matches