Minor refactoring and doc correction

Author: gsherwood

src/Standards/PSR2/Sniffs/ControlStructures/SwitchDeclarationSniff.php

@@ -229,118 +229,127 @@ private function findNextCase($phpcsFile, $stackPtr, $end)
 
 
     /**
-     * Returns true if a nested terminating statement is found.
+     * Returns the position of the nested terminating statement.
+     *
+     * Returns false if no terminating statement was found.
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int                         $stackPtr  The position to start looking at.
      * @param int                         $end       The position to stop looking at.
      *
-     * @return bool
+     * @return int|false
      */
     private function findNestedTerminator($phpcsFile, $stackPtr, $end)
     {
-        $tokens      = $phpcsFile->getTokens();
-        $terminators = [
-            T_RETURN,
-            T_BREAK,
-            T_CONTINUE,
-            T_THROW,
-            T_EXIT,
-        ];
+        $tokens = $phpcsFile->getTokens();
 
         $lastToken = $phpcsFile->findPrevious(T_WHITESPACE, ($end - 1), $stackPtr, true);
-        if ($lastToken !== false) {
-            if ($tokens[$lastToken]['code'] === T_CLOSE_CURLY_BRACKET) {
-                // We found a closing curly bracket and want to check if its block
-                // belongs to a SWITCH or an IF, ELSEIF or ELSE clause. If yes, we
-                // continue searching for a terminating statement within that
-                // block. Note that we have to make sure that every block of
-                // the entire if/else statement has a terminating statement.
-                $currentCloser = $lastToken;
-                $hasElseBlock  = false;
-                do {
-                    $scopeOpener = $tokens[$currentCloser]['scope_opener'];
-                    $scopeCloser = $tokens[$currentCloser]['scope_closer'];
-
-                    $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($scopeOpener - 1), $stackPtr, true);
-                    if ($prevToken === false) {
+        if ($lastToken === false) {
+            return false;
+        }
+
+        if ($tokens[$lastToken]['code'] === T_CLOSE_CURLY_BRACKET) {
+            // We found a closing curly bracket and want to check if its block
+            // belongs to a SWITCH, IF, ELSEIF or ELSE clause. If yes, we
+            // continue searching for a terminating statement within that
+            // block. Note that we have to make sure that every block of
+            // the entire if/else/switch statement has a terminating statement.
+            $currentCloser = $lastToken;
+            $hasElseBlock  = false;
+            do {
+                $scopeOpener = $tokens[$currentCloser]['scope_opener'];
+                $scopeCloser = $tokens[$currentCloser]['scope_closer'];
+
+                $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($scopeOpener - 1), $stackPtr, true);
+                if ($prevToken === false) {
+                    return false;
+                }
+
+                // SWITCH, IF and ELSEIF clauses possess a condition we have to account for.
+                if ($tokens[$prevToken]['code'] === T_CLOSE_PARENTHESIS) {
+                    $prevToken = $tokens[$prevToken]['parenthesis_owner'];
+                }
+
+                if ($tokens[$prevToken]['code'] === T_IF) {
+                    // If we have not encountered an ELSE clause by now, we cannot
+                    // be sure that the whole statement terminates in every case.
+                    if ($hasElseBlock === false) {
                         return false;
                     }
 
-                    // SWITCH, IF and ELSEIF clauses possess a condition we have to account for.
-                    if ($tokens[$prevToken]['code'] === T_CLOSE_PARENTHESIS) {
-                        $prevToken = $tokens[$prevToken]['parenthesis_owner'];
+                    return $this->findNestedTerminator($phpcsFile, ($scopeOpener + 1), $scopeCloser);
+                } else if ($tokens[$prevToken]['code'] === T_ELSEIF
+                    || $tokens[$prevToken]['code'] === T_ELSE
+                ) {
+                    // If we find a terminating statement within this block,
+                    // we continue with the previous ELSEIF or IF clause.
+                    $hasTerminator = $this->findNestedTerminator($phpcsFile, ($scopeOpener + 1), $scopeCloser);
+                    if ($hasTerminator === false) {
+                        return false;
                     }
 
-                    if ($tokens[$prevToken]['code'] === T_IF) {
-                        // If we have not encountered an ELSE clause by now, we cannot
-                        // be sure that the whole statement terminates in every case.
-                        if ($hasElseBlock === false) {
-                            return false;
+                    $currentCloser = $phpcsFile->findPrevious(T_WHITESPACE, ($prevToken - 1), $stackPtr, true);
+                    if ($tokens[$prevToken]['code'] === T_ELSE) {
+                        $hasElseBlock = true;
+                    }
+                } else if ($tokens[$prevToken]['code'] === T_SWITCH) {
+                    $hasDefaultBlock = false;
+                    $endOfSwitch     = $tokens[$prevToken]['scope_closer'];
+                    $nextCase        = $prevToken;
+
+                    // We look for a terminating statement within every blocks.
+                    while (($nextCase = $this->findNextCase($phpcsFile, ($nextCase + 1), $endOfSwitch)) !== false) {
+                        if ($tokens[$nextCase]['code'] === T_DEFAULT) {
+                            $hasDefaultBlock = true;
                         }
 
-                        return $this->findNestedTerminator($phpcsFile, ($scopeOpener + 1), $scopeCloser);
-                    } else if ($tokens[$prevToken]['code'] === T_ELSEIF
-                        || $tokens[$prevToken]['code'] === T_ELSE
-                    ) {
-                        // If we find a terminating statement within this block,
-                        // we continue with the previous ELSEIF or IF clause.
-                        $hasTerminator = $this->findNestedTerminator($phpcsFile, ($scopeOpener + 1), $scopeCloser);
-                        if ($hasTerminator === false) {
-                            return false;
-                        }
+                        $opener = $tokens[$nextCase]['scope_opener'];
 
-                        $currentCloser = $phpcsFile->findPrevious(T_WHITESPACE, ($prevToken - 1), $stackPtr, true);
-                        if ($tokens[$prevToken]['code'] === T_ELSE) {
-                            $hasElseBlock = true;
+                        $nextCode = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), $endOfSwitch, true);
+                        if ($tokens[$nextCode]['code'] === T_CASE || $tokens[$nextCode]['code'] === T_DEFAULT) {
+                            // This case statement has no content, so skip it.
+                            continue;
                         }
-                    } else if ($tokens[$prevToken]['code'] === T_SWITCH) {
-                        $hasDefaultBlock = false;
-                        $endOfSwitch     = $tokens[$prevToken]['scope_closer'];
-                        $nextCase        = $prevToken;
-
-                        // We look for a terminating statement within every blocks.
-                        while (($nextCase = $this->findNextCase($phpcsFile, ($nextCase + 1), $endOfSwitch)) !== false) {
-                            if ($tokens[$nextCase]['code'] === T_DEFAULT) {
-                                $hasDefaultBlock = true;
-                            }
 
-                            $opener = $tokens[$nextCase]['scope_opener'];
-
-                            $nextCode = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), $endOfSwitch, true);
-                            if ($tokens[$nextCode]['code'] === T_CASE || $tokens[$nextCode]['code'] === T_DEFAULT) {
-                                // This case statement has no content. We skip it.
-                                continue;
-                            }
-
-                            $nextCode = $this->findNextCase($phpcsFile, ($opener + 1), $endOfSwitch);
-                            if ($nextCode === false) {
-                                $nextCode = $endOfSwitch;
-                            }
+                        $endOfCase = $this->findNextCase($phpcsFile, ($opener + 1), $endOfSwitch);
+                        if ($endOfCase === false) {
+                            $endOfCase = $endOfSwitch;
+                        }
 
-                            $hasTerminator = $this->findNestedTerminator($phpcsFile, ($opener + 1), $nextCode);
-                            if ($hasTerminator === false) {
-                                return false;
-                            }
-                        }//end while
+                        $hasTerminator = $this->findNestedTerminator($phpcsFile, ($opener + 1), $endOfCase);
+                        if ($hasTerminator === false) {
+                            return false;
+                        }
+                    }//end while
 
-                        // If we have not encountered a DEFAULT block by now, we cannot
-                        // be sure that the whole statement terminates in every case.
-                        return $hasDefaultBlock;
-                    } else {
+                    // If we have not encountered a DEFAULT block by now, we cannot
+                    // be sure that the whole statement terminates in every case.
+                    if ($hasDefaultBlock === false) {
                         return false;
-                    }//end if
-                } while ($currentCloser !== false && $tokens[$currentCloser]['code'] === T_CLOSE_CURLY_BRACKET);
-
-                return true;
-            } else if ($tokens[$lastToken]['code'] === T_SEMICOLON) {
-                // We found the last statement of the CASE. Now we want to
-                // check whether it is a terminating one.
-                $terminator = $phpcsFile->findStartOfStatement(($lastToken - 1));
-                if (in_array($tokens[$terminator]['code'], $terminators, true) === true) {
-                    return $terminator;
-                }
-            }//end if
+                    }
+
+                    return $hasTerminator;
+                } else {
+                    return false;
+                }//end if
+            } while ($currentCloser !== false && $tokens[$currentCloser]['code'] === T_CLOSE_CURLY_BRACKET);
+
+            return true;
+        } else if ($tokens[$lastToken]['code'] === T_SEMICOLON) {
+            // We found the last statement of the CASE. Now we want to
+            // check whether it is a terminating one.
+            $terminators = [
+                T_RETURN,
+                T_BREAK,
+                T_CONTINUE,
+                T_THROW,
+                T_EXIT,
+            ];
+
+            $terminator = $phpcsFile->findStartOfStatement(($lastToken - 1));
+            if (in_array($tokens[$terminator]['code'], $terminators, true) === true) {
+                return $terminator;
+            }
         }//end if
 
         return false;