487 lines
18 KiB
PHP
487 lines
18 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* WordPress Coding Standard.
|
||
|
|
*
|
||
|
|
* @package WPCS\WordPressCodingStandards
|
||
|
|
* @link https://github.com/WordPress/WordPress-Coding-Standards
|
||
|
|
* @license https://opensource.org/licenses/MIT MIT
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace WordPressCS\WordPress\Sniffs\WhiteSpace;
|
||
|
|
|
||
|
|
use PHP_CodeSniffer\Util\Tokens;
|
||
|
|
use PHPCSUtils\Tokens\Collections;
|
||
|
|
use WordPressCS\WordPress\Sniff;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks that control structures have the correct spacing around brackets, based upon Squiz code.
|
||
|
|
*
|
||
|
|
* @since 0.1.0
|
||
|
|
* @since 2013-06-11 This sniff no longer supports JS.
|
||
|
|
* @since 0.3.0 This sniff now has the ability to fix most errors it flags.
|
||
|
|
* @since 0.7.0 This class now extends the WordPressCS native `Sniff` class.
|
||
|
|
* @since 0.13.0 Class name changed: this class is now namespaced.
|
||
|
|
* @since 3.0.0 Checks related to function declarations have been removed from this sniff.
|
||
|
|
*
|
||
|
|
* Last synced with base class 2021-11-20 at commit 7f11ffc8222b123c06345afd3261221561c3bb29.
|
||
|
|
* Note: This class has diverged quite far from the original. All the same, checking occasionally
|
||
|
|
* to see if there are upstream fixes made from which this sniff can benefit, is warranted.
|
||
|
|
* @link https://github.com/squizlabs/PHP_CodeSniffer/blob/master/src/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php
|
||
|
|
*/
|
||
|
|
final class ControlStructureSpacingSniff extends Sniff {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check for blank lines on start/end of control structures.
|
||
|
|
*
|
||
|
|
* @var boolean
|
||
|
|
*/
|
||
|
|
public $blank_line_check = false;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check for blank lines after control structures.
|
||
|
|
*
|
||
|
|
* @var boolean
|
||
|
|
*/
|
||
|
|
public $blank_line_after_check = true;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Require for space before T_COLON when using the alternative syntax for control structures.
|
||
|
|
*
|
||
|
|
* @var string one of 'required', 'forbidden', 'optional'
|
||
|
|
*/
|
||
|
|
public $space_before_colon = 'required';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Tokens for which to ignore extra space on the inside of parenthesis.
|
||
|
|
*
|
||
|
|
* For do / else / try / finally, there are no parenthesis, so skip it.
|
||
|
|
*
|
||
|
|
* @since 0.11.0
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $ignore_extra_space_after_open_paren = array(
|
||
|
|
\T_DO => true,
|
||
|
|
\T_ELSE => true,
|
||
|
|
\T_TRY => true,
|
||
|
|
\T_FINALLY => true,
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns an array of tokens this test wants to listen for.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function register() {
|
||
|
|
return array(
|
||
|
|
\T_IF,
|
||
|
|
\T_WHILE,
|
||
|
|
\T_FOREACH,
|
||
|
|
\T_FOR,
|
||
|
|
\T_SWITCH,
|
||
|
|
\T_DO,
|
||
|
|
\T_ELSE,
|
||
|
|
\T_ELSEIF,
|
||
|
|
\T_TRY,
|
||
|
|
\T_CATCH,
|
||
|
|
\T_FINALLY,
|
||
|
|
\T_MATCH,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Processes this test, when one of its tokens is encountered.
|
||
|
|
*
|
||
|
|
* @param int $stackPtr The position of the current token in the stack.
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function process_token( $stackPtr ) {
|
||
|
|
if ( isset( $this->tokens[ ( $stackPtr + 1 ) ] ) && \T_WHITESPACE !== $this->tokens[ ( $stackPtr + 1 ) ]['code']
|
||
|
|
&& ! ( \T_ELSE === $this->tokens[ $stackPtr ]['code'] && \T_COLON === $this->tokens[ ( $stackPtr + 1 ) ]['code'] )
|
||
|
|
) {
|
||
|
|
$error = 'Space after opening control structure is required';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $stackPtr, 'NoSpaceAfterStructureOpen' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContent( $stackPtr, ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset( $this->tokens[ $stackPtr ]['scope_opener'], $this->tokens[ $stackPtr ]['scope_closer'] ) ) {
|
||
|
|
if ( \T_WHILE !== $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$scopeOpener = $this->tokens[ $stackPtr ]['scope_opener'];
|
||
|
|
$scopeCloser = $this->tokens[ $stackPtr ]['scope_closer'];
|
||
|
|
}
|
||
|
|
|
||
|
|
// Alternative syntax.
|
||
|
|
if ( isset( $scopeOpener ) && \T_COLON === $this->tokens[ $scopeOpener ]['code'] ) {
|
||
|
|
|
||
|
|
if ( 'required' === $this->space_before_colon ) {
|
||
|
|
|
||
|
|
if ( \T_WHITESPACE !== $this->tokens[ ( $scopeOpener - 1 ) ]['code'] ) {
|
||
|
|
$error = 'Space between opening control structure and T_COLON is required';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $scopeOpener, 'NoSpaceBetweenStructureColon' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContentBefore( $scopeOpener, ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} elseif ( 'forbidden' === $this->space_before_colon ) {
|
||
|
|
|
||
|
|
if ( \T_WHITESPACE === $this->tokens[ ( $scopeOpener - 1 ) ]['code'] ) {
|
||
|
|
$error = 'Extra space between opening control structure and T_COLON found';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, ( $scopeOpener - 1 ), 'SpaceBetweenStructureColon' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( ( $scopeOpener - 1 ), '' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$parenthesisOpener = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true );
|
||
|
|
|
||
|
|
if ( \T_COLON !== $this->tokens[ $parenthesisOpener ]['code']
|
||
|
|
&& ( $stackPtr + 1 ) === $parenthesisOpener
|
||
|
|
) {
|
||
|
|
// Checking space between keyword and open parenthesis, i.e. `if[*](...) {}`.
|
||
|
|
$error = 'No space before opening parenthesis is prohibited';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $stackPtr, 'NoSpaceBeforeOpenParenthesis' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContent( $stackPtr, ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_WHITESPACE === $this->tokens[ ( $stackPtr + 1 ) ]['code']
|
||
|
|
&& ' ' !== $this->tokens[ ( $stackPtr + 1 ) ]['content']
|
||
|
|
) {
|
||
|
|
// Checking (too much) space between keyword and open parenthesis, i.e. `if [*](...) {}`.
|
||
|
|
$error = 'Expected exactly one space before opening parenthesis; "%s" found.';
|
||
|
|
$fix = $this->phpcsFile->addFixableError(
|
||
|
|
$error,
|
||
|
|
$stackPtr,
|
||
|
|
'ExtraSpaceBeforeOpenParenthesis',
|
||
|
|
array( $this->tokens[ ( $stackPtr + 1 ) ]['content'] )
|
||
|
|
);
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( ( $stackPtr + 1 ), ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_CLOSE_PARENTHESIS !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['code'] ) {
|
||
|
|
if ( \T_WHITESPACE !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['code'] ) {
|
||
|
|
// Checking space directly after the open parenthesis, i.e. `if ([*]...) {}`.
|
||
|
|
$error = 'No space after opening parenthesis is prohibited';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $stackPtr, 'NoSpaceAfterOpenParenthesis' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContent( $parenthesisOpener, ' ' );
|
||
|
|
}
|
||
|
|
} elseif ( ( ' ' !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['content']
|
||
|
|
&& "\n" !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['content']
|
||
|
|
&& "\r\n" !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['content'] )
|
||
|
|
&& ! isset( $this->ignore_extra_space_after_open_paren[ $this->tokens[ $stackPtr ]['code'] ] )
|
||
|
|
) {
|
||
|
|
// Checking (too much) space directly after the open parenthesis, i.e. `if ([*]...) {}`.
|
||
|
|
$error = 'Expected exactly one space after opening parenthesis; "%s" found.';
|
||
|
|
$fix = $this->phpcsFile->addFixableError(
|
||
|
|
$error,
|
||
|
|
$stackPtr,
|
||
|
|
'ExtraSpaceAfterOpenParenthesis',
|
||
|
|
array( $this->tokens[ ( $parenthesisOpener + 1 ) ]['content'] )
|
||
|
|
);
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( ( $parenthesisOpener + 1 ), ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $this->tokens[ $parenthesisOpener ]['parenthesis_closer'] ) ) {
|
||
|
|
|
||
|
|
$parenthesisCloser = $this->tokens[ $parenthesisOpener ]['parenthesis_closer'];
|
||
|
|
|
||
|
|
if ( \T_CLOSE_PARENTHESIS !== $this->tokens[ ( $parenthesisOpener + 1 ) ]['code'] ) {
|
||
|
|
|
||
|
|
// Checking space directly before the close parenthesis, i.e. `if (...[*]) {}`.
|
||
|
|
if ( \T_WHITESPACE !== $this->tokens[ ( $parenthesisCloser - 1 ) ]['code'] ) {
|
||
|
|
$error = 'No space before closing parenthesis is prohibited';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $parenthesisCloser, 'NoSpaceBeforeCloseParenthesis' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContentBefore( $parenthesisCloser, ' ' );
|
||
|
|
}
|
||
|
|
} elseif ( ' ' !== $this->tokens[ ( $parenthesisCloser - 1 ) ]['content'] ) {
|
||
|
|
$prevNonEmpty = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, ( $parenthesisCloser - 1 ), null, true );
|
||
|
|
if ( $this->tokens[ ( $parenthesisCloser ) ]['line'] === $this->tokens[ ( $prevNonEmpty + 1 ) ]['line'] ) {
|
||
|
|
$error = 'Expected exactly one space before closing parenthesis; "%s" found.';
|
||
|
|
$fix = $this->phpcsFile->addFixableError(
|
||
|
|
$error,
|
||
|
|
$stackPtr,
|
||
|
|
'ExtraSpaceBeforeCloseParenthesis',
|
||
|
|
array( $this->tokens[ ( $parenthesisCloser - 1 ) ]['content'] )
|
||
|
|
);
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( ( $parenthesisCloser - 1 ), ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_WHITESPACE !== $this->tokens[ ( $parenthesisCloser + 1 ) ]['code']
|
||
|
|
&& ( isset( $scopeOpener ) && \T_COLON !== $this->tokens[ $scopeOpener ]['code'] )
|
||
|
|
) {
|
||
|
|
$error = 'Space between opening control structure and closing parenthesis is required';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $scopeOpener, 'NoSpaceAfterCloseParenthesis' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->addContentBefore( $scopeOpener, ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $this->tokens[ $parenthesisOpener ]['parenthesis_owner'] )
|
||
|
|
&& ( isset( $scopeOpener )
|
||
|
|
&& $this->tokens[ $parenthesisCloser ]['line'] !== $this->tokens[ $scopeOpener ]['line'] )
|
||
|
|
) {
|
||
|
|
$error = 'Opening brace should be on the same line as the declaration';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $parenthesisOpener, 'OpenBraceNotSameLine' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->beginChangeset();
|
||
|
|
|
||
|
|
for ( $i = ( $parenthesisCloser + 1 ); $i < $scopeOpener; $i++ ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( $i, '' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->phpcsFile->fixer->addContent( $parenthesisCloser, ' ' );
|
||
|
|
$this->phpcsFile->fixer->endChangeset();
|
||
|
|
}
|
||
|
|
return;
|
||
|
|
|
||
|
|
} elseif ( \T_WHITESPACE === $this->tokens[ ( $parenthesisCloser + 1 ) ]['code']
|
||
|
|
&& ' ' !== $this->tokens[ ( $parenthesisCloser + 1 ) ]['content']
|
||
|
|
) {
|
||
|
|
// Checking space between the close parenthesis and the open brace, i.e. `if (...) [*]{}`.
|
||
|
|
$error = 'Expected exactly one space between closing parenthesis and opening control structure; "%s" found.';
|
||
|
|
$fix = $this->phpcsFile->addFixableError(
|
||
|
|
$error,
|
||
|
|
$stackPtr,
|
||
|
|
'ExtraSpaceAfterCloseParenthesis',
|
||
|
|
array( $this->tokens[ ( $parenthesisCloser + 1 ) ]['content'] )
|
||
|
|
);
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( ( $parenthesisCloser + 1 ), ' ' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( false !== $this->blank_line_check && isset( $scopeOpener ) ) {
|
||
|
|
$firstContent = $this->phpcsFile->findNext( \T_WHITESPACE, ( $scopeOpener + 1 ), null, true );
|
||
|
|
|
||
|
|
// We ignore spacing for some structures that tend to have their own rules.
|
||
|
|
$ignore = array(
|
||
|
|
\T_DOC_COMMENT_OPEN_TAG => true,
|
||
|
|
\T_CLOSE_TAG => true,
|
||
|
|
\T_COMMENT => true,
|
||
|
|
);
|
||
|
|
$ignore += Collections::closedScopes();
|
||
|
|
|
||
|
|
if ( ! isset( $ignore[ $this->tokens[ $firstContent ]['code'] ] )
|
||
|
|
&& $this->tokens[ $firstContent ]['line'] > ( $this->tokens[ $scopeOpener ]['line'] + 1 )
|
||
|
|
) {
|
||
|
|
$gap = ( $this->tokens[ $firstContent ]['line'] - $this->tokens[ $scopeOpener ]['line'] - 1 );
|
||
|
|
$this->phpcsFile->recordMetric( $stackPtr, 'Blank lines at start of control structure', $gap );
|
||
|
|
|
||
|
|
$error = 'Blank line found at start of control structure';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $scopeOpener, 'BlankLineAfterStart' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->beginChangeset();
|
||
|
|
|
||
|
|
for ( $i = ( $scopeOpener + 1 ); $i < $firstContent; $i++ ) {
|
||
|
|
if ( $this->tokens[ $i ]['line'] === $this->tokens[ $firstContent ]['line'] ) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$this->phpcsFile->fixer->replaceToken( $i, '' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->phpcsFile->fixer->addNewline( $scopeOpener );
|
||
|
|
$this->phpcsFile->fixer->endChangeset();
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$this->phpcsFile->recordMetric( $stackPtr, 'Blank lines at start of control structure', 0 );
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $scopeCloser ) && $firstContent !== $scopeCloser ) {
|
||
|
|
$lastContent = $this->phpcsFile->findPrevious( \T_WHITESPACE, ( $scopeCloser - 1 ), null, true );
|
||
|
|
|
||
|
|
$lastNonEmptyContent = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, ( $scopeCloser - 1 ), null, true );
|
||
|
|
|
||
|
|
$checkToken = $lastContent;
|
||
|
|
if ( isset( $this->tokens[ $lastNonEmptyContent ]['scope_condition'] ) ) {
|
||
|
|
$checkToken = $this->tokens[ $lastNonEmptyContent ]['scope_condition'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset( $ignore[ $this->tokens[ $checkToken ]['code'] ] )
|
||
|
|
&& $this->tokens[ $lastContent ]['line'] <= ( $this->tokens[ $scopeCloser ]['line'] - 2 )
|
||
|
|
) {
|
||
|
|
$gap = ( $this->tokens[ $scopeCloser ]['line'] - $this->tokens[ $lastContent ]['line'] - 1 );
|
||
|
|
$this->phpcsFile->recordMetric( $stackPtr, 'Blank lines at end of control structure', $gap );
|
||
|
|
|
||
|
|
for ( $i = ( $scopeCloser - 1 ); $i > $lastContent; $i-- ) {
|
||
|
|
if ( $this->tokens[ $i ]['line'] < $this->tokens[ $scopeCloser ]['line']
|
||
|
|
&& \T_OPEN_TAG !== $this->tokens[ $firstContent ]['code']
|
||
|
|
) {
|
||
|
|
// TODO: Reporting error at empty line won't highlight it in IDE.
|
||
|
|
$error = 'Blank line found at end of control structure';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $i, 'BlankLineBeforeEnd' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->beginChangeset();
|
||
|
|
|
||
|
|
for ( $j = ( $lastContent + 1 ); $j < $scopeCloser; $j++ ) {
|
||
|
|
if ( $this->tokens[ $j ]['line'] === $this->tokens[ $scopeCloser ]['line'] ) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$this->phpcsFile->fixer->replaceToken( $j, '' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* PHPCS annotations, like normal inline comments, are tokenized including
|
||
|
|
* the new line at the end, so don't add any extra as it would cause a fixer
|
||
|
|
* conflict.
|
||
|
|
*/
|
||
|
|
if ( \T_COMMENT !== $this->tokens[ $lastContent ]['code']
|
||
|
|
&& ! isset( Tokens::$phpcsCommentTokens[ $this->tokens[ $lastContent ]['code'] ] ) ) {
|
||
|
|
$this->phpcsFile->fixer->addNewlineBefore( $j );
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->phpcsFile->fixer->endChangeset();
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$this->phpcsFile->recordMetric( $stackPtr, 'Blank lines at end of control structure', 0 );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
unset( $ignore );
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset( $scopeCloser ) || true !== $this->blank_line_after_check ) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_MATCH === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// Move the scope closer to the semicolon/comma.
|
||
|
|
$next = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $scopeCloser + 1 ), null, true );
|
||
|
|
if ( false !== $next
|
||
|
|
&& ( \T_SEMICOLON === $this->tokens[ $next ]['code'] || \T_COMMA === $this->tokens[ $next ]['code'] )
|
||
|
|
) {
|
||
|
|
$scopeCloser = $next;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// {@internal This is just for the blank line check. Only whitespace should be considered,
|
||
|
|
// not "other" empty tokens.}}
|
||
|
|
$trailingContent = $this->phpcsFile->findNext( \T_WHITESPACE, ( $scopeCloser + 1 ), null, true );
|
||
|
|
if ( false === $trailingContent ) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_COMMENT === $this->tokens[ $trailingContent ]['code']
|
||
|
|
|| isset( Tokens::$phpcsCommentTokens[ $this->tokens[ $trailingContent ]['code'] ] )
|
||
|
|
) {
|
||
|
|
// Special exception for code where the comment about
|
||
|
|
// an ELSE or ELSEIF is written between the control structures.
|
||
|
|
$nextCode = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $scopeCloser + 1 ), null, true );
|
||
|
|
|
||
|
|
if ( \T_ELSE === $this->tokens[ $nextCode ]['code'] || \T_ELSEIF === $this->tokens[ $nextCode ]['code'] ) {
|
||
|
|
$trailingContent = $nextCode;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Move past end comments.
|
||
|
|
if ( $this->tokens[ $trailingContent ]['line'] === $this->tokens[ $scopeCloser ]['line'] ) {
|
||
|
|
if ( preg_match( '`^//[ ]?end`i', $this->tokens[ $trailingContent ]['content'], $matches ) > 0 ) {
|
||
|
|
$scopeCloser = $trailingContent;
|
||
|
|
$trailingContent = $this->phpcsFile->findNext( \T_WHITESPACE, ( $trailingContent + 1 ), null, true );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_ELSE === $this->tokens[ $trailingContent ]['code'] && \T_IF === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// IF with ELSE.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_WHILE === $this->tokens[ $trailingContent ]['code'] && \T_DO === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// DO with WHILE.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_CATCH === $this->tokens[ $trailingContent ]['code'] && \T_TRY === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// TRY with CATCH.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_FINALLY === $this->tokens[ $trailingContent ]['code'] && \T_CATCH === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// CATCH with FINALLY.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_FINALLY === $this->tokens[ $trailingContent ]['code'] && \T_TRY === $this->tokens[ $stackPtr ]['code'] ) {
|
||
|
|
// TRY with FINALLY.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( \T_CLOSE_TAG === $this->tokens[ $trailingContent ]['code'] ) {
|
||
|
|
// At the end of the script or embedded code.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $this->tokens[ $trailingContent ]['scope_condition'] )
|
||
|
|
&& \T_CLOSE_CURLY_BRACKET === $this->tokens[ $trailingContent ]['code']
|
||
|
|
) {
|
||
|
|
// Another control structure's closing brace.
|
||
|
|
$owner = $this->tokens[ $trailingContent ]['scope_condition'];
|
||
|
|
if ( isset( Collections::closedScopes()[ $this->tokens[ $owner ]['code'] ] ) === true ) {
|
||
|
|
// The next content is the closing brace of a function, class, interface or trait
|
||
|
|
// so normal function/class rules apply and we can ignore it.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ( $this->tokens[ $scopeCloser ]['line'] + 1 ) !== $this->tokens[ $trailingContent ]['line'] ) {
|
||
|
|
// TODO: Won't cover following case: "} echo 'OK';".
|
||
|
|
$error = 'Blank line found after control structure';
|
||
|
|
$fix = $this->phpcsFile->addFixableError( $error, $scopeCloser, 'BlankLineAfterEnd' );
|
||
|
|
|
||
|
|
if ( true === $fix ) {
|
||
|
|
$this->phpcsFile->fixer->beginChangeset();
|
||
|
|
|
||
|
|
$i = ( $scopeCloser + 1 );
|
||
|
|
while ( $this->tokens[ $i ]['line'] !== $this->tokens[ $trailingContent ]['line'] ) {
|
||
|
|
$this->phpcsFile->fixer->replaceToken( $i, '' );
|
||
|
|
++$i;
|
||
|
|
}
|
||
|
|
|
||
|
|
// TODO: Instead a separate error should be triggered when content comes right after closing brace.
|
||
|
|
if ( \T_COMMENT !== $this->tokens[ $scopeCloser ]['code']
|
||
|
|
&& isset( Tokens::$phpcsCommentTokens[ $this->tokens[ $scopeCloser ]['code'] ] ) === false
|
||
|
|
) {
|
||
|
|
$this->phpcsFile->fixer->addNewlineBefore( $trailingContent );
|
||
|
|
}
|
||
|
|
$this->phpcsFile->fixer->endChangeset();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|