SyntaxError::translateTokens(): prevent double translation

Generally speaking, the `$translate` parameter for the `SyntaxError::getNormalizedMessage()` method should only be passed as `true` when on a PHP version which doesn't do the PHP native token translation yet. However, in edge cases, it could be possible that tokens could be double "translated", both by PHP itself as well as by the `SyntaxError::translateTokens()` method. This minor fix prevents this by not matching token names when surrounded by parentheses. Includes additional unit tests.
php-parallel-lint · Apr 8, 2022 · 2c1f747 · 2c1f747
1 parent a6e5237
commit 2c1f747
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/Errors/SyntaxError.php b/src/Errors/SyntaxError.php
@@ -92,7 +92,7 @@ protected function translateTokens($message)
             'T_ECHO' => 'echo'
         );
 
-        return preg_replace_callback('~T_([A-Z_]*)~', function ($matches) use ($translateTokens) {
+        return preg_replace_callback('~(?<!\()T_([A-Z_]*)(?!\))~', function ($matches) use ($translateTokens) {
             list($tokenName) = $matches;
             if (isset($translateTokens[$tokenName])) {
                 $operator = $translateTokens[$tokenName];

diff --git a/tests/Unit/Errors/SyntaxErrorTranslateTokensTest.php b/tests/Unit/Errors/SyntaxErrorTranslateTokensTest.php
@@ -60,6 +60,18 @@ public function dataTranslateTokens()
                 'message'  => 'Unexpected T_INC, T_IS_IDENTICAL, T_OBJECT_OPERATOR, T_START_HEREDOC',
                 'expected' => 'Unexpected ++ (T_INC), === (T_IS_IDENTICAL), -> (T_OBJECT_OPERATOR), <<< (T_START_HEREDOC)',
             ),
+            'PHP 5.4-style message with token name with PHP native translation [1] - prevent double translation' => array(
+                'message'  => 'Unexpected \'__FILE__\' (T_FILE), expecting T_STRING',
+                'expected' => 'Unexpected \'__FILE__\' (T_FILE), expecting T_STRING',
+            ),
+            'PHP 5.4-style message with token name with PHP native translation [2] - prevent double translation' => array(
+                'message'  => 'Unexpected \'++\' (T_INC) in',
+                'expected' => 'Unexpected \'++\' (T_INC) in',
+            ),
+            'Message with multiple tokens with PHP native translation' => array(
+                'message'  => 'Unexpected ++ (T_INC), === (T_IS_IDENTICAL), -> (T_OBJECT_OPERATOR), <<< (T_START_HEREDOC)',
+                'expected' => 'Unexpected ++ (T_INC), === (T_IS_IDENTICAL), -> (T_OBJECT_OPERATOR), <<< (T_START_HEREDOC)',
+            ),
         );
     }
 }