Squiz/ForLoopDeclaration: bug fix - prevent sniff erroring out

... on an _"Undefined array key "parenthesis_closer" "_ notice during live coding. Includes unit test.
PHPCSStandards · Mar 31, 2024 · 1fbd83d · 1fbd83d
1 parent 1a48781
commit 1fbd83d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/src/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.php b/src/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.php
@@ -76,7 +76,7 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
 
         $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
-        if ($openingBracket === false) {
+        if ($openingBracket === false || isset($tokens[$openingBracket]['parenthesis_closer']) === false) {
             $error = 'Possible parse error: no opening parenthesis for FOR keyword';
             $phpcsFile->addWarning($error, $stackPtr, 'NoOpenBracket');
             return;

diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.3.inc b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.3.inc
@@ -0,0 +1,6 @@
+<?php
+
+// Parse error/live coding test (no close parenthesis).
+// This test has to be the only test in the file!
+// Testing the "NoOpenBracket" warning.
+for ($i = 10;
diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php
@@ -122,6 +122,7 @@ public function getWarningList($testFile='')
     {
         switch ($testFile) {
         case 'ForLoopDeclarationUnitTest.2.inc':
+        case 'ForLoopDeclarationUnitTest.3.inc':
             return [6 => 1];
 
         case 'ForLoopDeclarationUnitTest.js':