Skip to content

PHP close tag should be regarded as scope opener for switch case/default statements #1316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrfnl merged 5 commits into from
Nov 10, 2025
Merged

PHP close tag should be regarded as scope opener for switch case/default statements #1316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6327f77
Tokenizer/PHP: PHP close tag should be regarded as scope opener for s…
jrfnl Nov 10, 2025
21c0e80
PSR2/SwitchDeclaration: make implied semicolon via close tag auto-fix…
jrfnl Nov 10, 2025
6d61496
Squiz/SwitchDeclaration: make implied semicolon via close tag auto-fi…
jrfnl Nov 10, 2025
6bd0af6
Squiz/NonExecutableCode: bug fix - false positive with PHP close tag …
jrfnl Nov 10, 2025
b80dc24
Various sniffs: update tests to safeguard handling of `case`/`default…
jrfnl Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion src/Standards/Generic/Tests/CodeAnalysis/AssignmentInConditionUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ switch ( true ) {
case $sample = 'something':
break;

case $sample = 'something' && $a = $b:
case $sample = 'something' && $a = $b;
break;
}

Expand All @@ -93,3 +93,14 @@ if ($a = 123) :
endif;

match ($a[0] = 123) {};

switch ( true ) {
case $sample = 'something': {
break;
}
case $sample ?>
<?php $a = $b ?><!-- This is okay, this is in the case body, not the condition. -->
<?php break;
case $sample = 'something' && $a = $b ?>
<?php break;
}
70 changes: 36 additions & 34 deletions src/Standards/Generic/Tests/CodeAnalysis/AssignmentInConditionUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,40 +50,42 @@ public function getWarningList($testFile = '')
switch ($testFile) {
case 'AssignmentInConditionUnitTest.1.inc':
return [
46 => 1,
47 => 1,
48 => 1,
49 => 1,
50 => 1,
51 => 1,
52 => 1,
53 => 1,
54 => 1,
55 => 1,
56 => 1,
57 => 1,
58 => 1,
59 => 1,
60 => 1,
61 => 2,
63 => 1,
64 => 1,
67 => 1,
68 => 1,
69 => 1,
70 => 1,
71 => 1,
72 => 1,
73 => 1,
75 => 1,
77 => 1,
80 => 2,
84 => 1,
85 => 2,
88 => 1,
90 => 1,
92 => 1,
95 => 1,
46 => 1,
47 => 1,
48 => 1,
49 => 1,
50 => 1,
51 => 1,
52 => 1,
53 => 1,
54 => 1,
55 => 1,
56 => 1,
57 => 1,
58 => 1,
59 => 1,
60 => 1,
61 => 2,
63 => 1,
64 => 1,
67 => 1,
68 => 1,
69 => 1,
70 => 1,
71 => 1,
72 => 1,
73 => 1,
75 => 1,
77 => 1,
80 => 2,
84 => 1,
85 => 2,
88 => 1,
90 => 1,
92 => 1,
95 => 1,
98 => 1,
104 => 2,
];

default:
Expand Down
29 changes: 29 additions & 0 deletions src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,3 +458,32 @@ abstract class AbstractClass {
interface MyInterface {
public function sniffShouldIgnoreInterfaceMethods();
}

function complexityElevenWithSwitchCaseCreativeScopeOpeners()
{
switch ($condition) {
case 'colon':
break;
case 'semicolon';
return;
case 'colon with curlies': {
return;
}
case 'semicolon with curlies'; {
return;
}
case 'PHP close tag' ?>
<?php return ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php return ?>
<?php case 'PHP close tag 2' ?>
<?php goto LABEL ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php exit ?>
<?php case 'PHP close tag 3' ?>
<?php return ?>
<?php default ?>
<?php break ?>
<?php
}
}
1 change: 1 addition & 0 deletions src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ public function getWarningList($testFile = '')
381 => 1,
417 => 1,
445 => 1,
462 => 1,
];
default:
return [];
Expand Down
30 changes: 30 additions & 0 deletions src/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,33 @@ enum Cards
<?php if ($someConditional) : ?>
<div class="container">
</div> <?php endif;

function switchCaseCreativeScopeOpeners()
{
switch ($correct) {
case 'colon':
break;
case 'semicolon';
return;
case 'PHP close tag' ?>
<?php return ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php exit ?>
<?php case 'PHP close tag 3' ?>
<?php return ?>
<?php default ?>
<?php break ?>
<?php
}

switch ($incorrect) {
case 'semicolon'; return;
case 'PHP close tag' ?>
<?php return ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php exit ?>
<?php default ?>
<?php break ?>
<?php
}
}
31 changes: 31 additions & 0 deletions src/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,34 @@ enum Cards
<div class="container">
</div> <?php
endif;

function switchCaseCreativeScopeOpeners()
{
switch ($correct) {
case 'colon':
break;
case 'semicolon';
return;
case 'PHP close tag' ?>
<?php return ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php exit ?>
<?php case 'PHP close tag 3' ?>
<?php return ?>
<?php default ?>
<?php break ?>
<?php
}

switch ($incorrect) {
case 'semicolon';
return;
case 'PHP close tag' ?>
<?php return ?>
<?php case 'PHP close tag with semicolon'; ?>
<?php exit ?>
<?php default ?>
<?php break ?>
<?php
}
}
5 changes: 5 additions & 0 deletions src/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ public function getErrorList()
160 => 1,
164 => 1,
170 => 1,
191 => 1,
193 => 1,
195 => 1,
197 => 1,
199 => 1,
];
}

Expand Down
9 changes: 7 additions & 2 deletions src/Standards/PSR2/Sniffs/ControlStructures/SwitchDeclarationSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,10 +186,15 @@ public function process(File $phpcsFile, int $stackPtr)
}
} else {
$error = strtoupper($type) . ' statements must be defined using a colon';
if ($tokens[$opener]['code'] === T_SEMICOLON) {
if ($tokens[$opener]['code'] === T_SEMICOLON || $tokens[$opener]['code'] === T_CLOSE_TAG) {
$fix = $phpcsFile->addFixableError($error, $nextCase, 'WrongOpener' . $type);
if ($fix === true) {
$phpcsFile->fixer->replaceToken($opener, ':');
if ($tokens[$opener]['code'] === T_SEMICOLON) {
$phpcsFile->fixer->replaceToken($opener, ':');
} else {
$prevNonEmpty = $phpcsFile->findPrevious(T_WHITESPACE, ($opener - 1), null, true);
$phpcsFile->fixer->addContent($prevNonEmpty, ':');
}
}
} else {
// Probably a case/default statement with colon + curly braces.
Expand Down
16 changes: 16 additions & 0 deletions src/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,3 +622,19 @@ switch ($value) {
default ;
echo 'Other';
}

// Verify that case/default statements with a PHP close tag as scope opener are handled correctly by the sniff.
switch ($foo):
case "foo"?>
<div>Some html</div>
<?php break;
case "bar" ; ?>
<div>Some html</div>
<?php break;
default ?>
<div>Some html</div>
<?php break;
default ; ?>
<div>Some html</div>
<?php break;
endswitch;
24 changes: 24 additions & 0 deletions src/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,3 +617,27 @@ switch ($value) {
default:
echo 'Other';
}

// Verify that case/default statements with a PHP close tag as scope opener are handled correctly by the sniff.
switch ($foo):
case "foo":
?>
<div>Some html</div>
<?php
break;
case "bar":
?>
<div>Some html</div>
<?php
break;
default:
?>
<div>Some html</div>
<?php
break;
default:
?>
<div>Some html</div>
<?php
break;
endswitch;
4 changes: 4 additions & 0 deletions src/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ public function getErrorList()
617 => 1,
620 => 1,
622 => 1,
628 => 1,
631 => 1,
634 => 1,
637 => 1,
];
}

Expand Down
13 changes: 13 additions & 0 deletions src/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,19 @@ public function process(File $phpcsFile, int $stackPtr)
}

$opener = $tokens[$nextCase]['scope_opener'];

if ($tokens[$opener]['code'] === T_CLOSE_TAG) {
$error = 'There should be a colon before the PHP close tag to end the %s statement';
$code = 'WrongOpener' . $type;
$data = [strtoupper($type)];

$fix = $phpcsFile->addFixableError($error, $nextCase, $code, $data);
if ($fix === true) {
$prevNonEmpty = $phpcsFile->findPrevious(T_WHITESPACE, ($opener - 1), null, true);
$phpcsFile->fixer->addContent($prevNonEmpty, ':');
}
}

if ($tokens[($opener - 1)]['type'] === 'T_WHITESPACE') {
$error = 'There must be no space before the colon in a ' . strtoupper($type) . ' statement';
$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon' . $type);
Expand Down
6 changes: 5 additions & 1 deletion src/Standards/Squiz/Sniffs/PHP/NonExecutableCodeSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,11 @@ public function process(File $phpcsFile, int $stackPtr)
if ($next !== false) {
$lastLine = $tokens[$end]['line'];
for ($i = ($stackPtr + 1); $i < $next; $i++) {
if (isset(Tokens::EMPTY_TOKENS[$tokens[$i]['code']]) === true) {
if (isset(Tokens::EMPTY_TOKENS[$tokens[$i]['code']]) === true
|| $tokens[$i]['code'] === T_OPEN_TAG
|| $tokens[$i]['code'] === T_CLOSE_TAG
|| ($tokens[$i]['code'] === T_INLINE_HTML && trim($tokens[$i]['content']) === '')
) {
continue;
}

Expand Down
Loading