Fixed bug #1218 : CASE conditions using class constants named NAMESPACE/INTERFACE/TRAIT etc are incorrectly tokenized

Author: gsherwood

CodeSniffer/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.inc

@@ -144,3 +144,13 @@ switch($foo)
         break;
     }
 }
+
+switch ($foo) {
+    case Foo::INTERFACE:
+        return self::INTERFACE;
+    case Foo::NAMESPACE:
+        return self::MODULE;
+    case Foo::TRAIT:
+    case Foo::ARRAY:
+        return self::VALUE;
+}

CodeSniffer/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.inc.fixed

@@ -147,3 +147,13 @@ switch($foo)
         break;
     }
 }
+
+switch ($foo) {
+    case Foo::INTERFACE:
+        return self::INTERFACE;
+    case Foo::NAMESPACE:
+        return self::MODULE;
+    case Foo::TRAIT:
+    case Foo::ARRAY:
+        return self::VALUE;
+}

CodeSniffer/Tokenizers/PHP.php

@@ -678,6 +678,30 @@ public function tokenizeString($string, $eolChar='\n')
                 continue;
             }
 
+            /*
+                Tokens after a double colon may be look like scope openers,
+                such as when writing code like Foo::NAMESAPCE, but they are
+                only ever variables or strings.
+            */
+
+            if ($stackPtr > 1
+                && $tokens[($stackPtr - 1)][0] === T_PAAMAYIM_NEKUDOTAYIM
+                && $tokenIsArray === true
+                && $token[0] !== T_STRING
+                && $token[0] !== T_VARIABLE
+                && $token[0] !== T_DOLLAR
+                && isset(PHP_CodeSniffer_Tokens::$emptyTokens[$token[0]]) === false
+            ) {
+                $newToken            = array();
+                $newToken['code']    = T_STRING;
+                $newToken['type']    = 'T_STRING';
+                $newToken['content'] = $token[1];
+                $finalTokens[$newStackPtr] = $newToken;
+
+                $newStackPtr++;
+                continue;
+            }
+
             /*
                 Before PHP 7, the <=> operator was tokenized as
                 T_IS_SMALLER_OR_EQUAL followed by T_GREATER_THAN.
@@ -1269,25 +1293,6 @@ public function processAdditional(&$tokens, $eolChar)
                         echo "\t* token $x on line $line changed from $type to T_STRING".PHP_EOL;
                     }
 
-                    $tokens[$x]['code'] = T_STRING;
-                    $tokens[$x]['type'] = 'T_STRING';
-                }
-            } else if ($tokens[$i]['code'] === T_PAAMAYIM_NEKUDOTAYIM) {
-                // Context sensitive keywords support.
-                for ($x = ($i + 1); $i < $numTokens; $x++) {
-                    if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) {
-                        // Non-whitespace content.
-                        break;
-                    }
-                }
-
-                if (in_array($tokens[$x]['code'], array(T_STRING, T_VARIABLE, T_DOLLAR), true) === false) {
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        $line = $tokens[$x]['line'];
-                        $type = $tokens[$x]['type'];
-                        echo "\t* token $x on line $line changed from $type to T_STRING".PHP_EOL;
-                    }
-
                     $tokens[$x]['code'] = T_STRING;
                     $tokens[$x]['type'] = 'T_STRING';
                 }

package.xml

@@ -53,6 +53,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #1190 : phpcbf on if/else with trailing comment generates erroneous code
   - Fixed bug #1191 : Javascript sniffer fails with function called "Function"
   - Fixed bug #1203 : Inconsistent behavior of PHP_CodeSniffer_File::findEndOfStatement
+  - Fixed bug #1218 : CASE conditions using class constants named NAMESPACE/INTERFACE/TRAIT etc are incorrectly tokenized
  </notes>
  <contents>
   <dir name="/">